Skip to content

fix: escaping regex in linting script #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joshjohanning merged 1 commit into from
Aug 23, 2025
+5 −1
Merged

fix: escaping regex in linting script #116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .github/scripts/lint-readme.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ const directoryPath = process.argv[2] || './gh-cli';
const headingLevel = process.argv[3] || '###';
const parentHeading = process.argv[4] || '## Scripts';

// Escape RegExp special characters
function escapeRegExp(string) {
return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
}
const readmePath = path.join(directoryPath, 'README.md');

// Read README.md content
Expand Down Expand Up @@ -96,7 +100,7 @@ allScripts.forEach(file => {
const scriptsSection = readme.split(`${parentHeading}\n`)[1];

// Extract all ### headings from the scripts section
const regex = new RegExp(`${headingLevel} .*`, 'g');
const regex = new RegExp(`${escapeRegExp(headingLevel)} .*`, 'g');
const headings = scriptsSection.match(regex);

// Check that all scripts mentioned in the README.md actually exist in the repository
Expand Down