Skip to content

feat: add bash syntax checking for .sh files in lint-readme script #115

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
Merged

feat: add bash syntax checking for .sh files in lint-readme script #115

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
15 changes: 15 additions & 0 deletions .github/scripts/lint-readme.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,21 @@ allScripts.forEach(file => {
}
});

// Check bash syntax for all .sh files
allScripts.forEach(file => {
if (!file.endsWith('.sh')) {
return;
}

const filePath = path.join(directoryPath, file);
try {
execSync(`bash -n "${filePath}"`, { stdio: 'pipe' });
} catch (error) {
console.log(`Bash syntax error in ${file}: ${error.stderr.toString().trim()}`);
issueCount++;
}
});

// Extract the part of the README under the ## Scripts heading
const scriptsSection = readme.split(`${parentHeading}\n`)[1];

Expand Down