golem15/msd-core
3
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

refactor(scripts): replace process.exit() with ExitError + runMain handler (#739) (#740)

Browse Source 
Part 1 of 2 of the n/no-process-exit cleanup (umbrella #738): convert every
process.exit() call in standalone scripts/** CLIs to the rule-compliant pattern.

- New shared helper scripts/lib/cli-exit.cjs: ExitError(code,message) + runMain()
  which translates a thrown ExitError / returned number into process.exitCode
  (never process.exit()), flushing output and still firing process.on('exit').
- main()-based entrypoints: throw new ExitError(code) for errors, return <code>
  for verdicts; invoked via runMain(main). Child exit codes preserved via return.
- top-level-only scripts: imperative body extracted into main() so mid-flow
  aborts (throw ExitError) actually halt; pure consts/helpers stay at module scope.
- diff-touches-shipped-paths.cjs: stdin event handling restructured to an async
  read so the whole flow runs under runMain; uncaughtException/unhandledRejection
  nets replaced by an in-band catch that preserves EXIT_ERROR=2.

Exit codes verified unchanged for every converted script (success/error/help and
the 0/1/2 semantic codes in diff-touches). Rule stays warn here; flipped to error
in part 2 (#738) once gsd-core/bin/** is also clean.

Refs #739

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Tom Boucher
2026-06-06 16:13:13 -04:00
committed by GitHub
parent dfbb684843
commit f729101eec
31 changed files with 1074 additions and 774 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
scripts/lint-descriptions.cjs
View File

@@ -15,6 +15,7 @@
const fs = require('fs');
const path = require('path');
const { ExitError, runMain } = require('./lib/cli-exit.cjs');
const MAX_LENGTH = 100;
const COMMANDS_DIR = path.join(__dirname, '..', 'commands', 'gsd');
@@ -46,38 +47,41 @@ function getFiles() {
.map(f => path.join(COMMANDS_DIR, f));
}
const files = getFiles();
const violations = [];
function main() {
const files = getFiles();
const violations = [];
for (const filePath of files) {
let content;
try {
content = fs.readFileSync(filePath, 'utf-8');
} catch (err) {
process.stderr.write(`ERROR: Cannot read file: ${filePath}\n ${err.message}\n`);
process.exit(1);
for (const filePath of files) {
let content;
try {
content = fs.readFileSync(filePath, 'utf-8');
} catch (err) {
throw new ExitError(1, `ERROR: Cannot read file: ${filePath}\n ${err.message}`);
}
const description = parseDescription(content);
if (description === null) continue;
if (description.length > MAX_LENGTH) {
violations.push({ filePath, length: description.length, description });
}
}
const description = parseDescription(content);
if (description === null) continue;
if (description.length > MAX_LENGTH) {
violations.push({ filePath, length: description.length, description });
if (violations.length === 0) {
const checked = files.length;
process.stdout.write(`ok lint-descriptions: ${checked} file(s) checked, 0 violations\n`);
return 0;
}
process.stderr.write(`\nERROR lint-descriptions: ${violations.length} violation(s) found\n\n`);
for (const v of violations) {
const preview = v.description.length > 120 ? v.description.slice(0, 117) + '...' : v.description;
process.stderr.write(` ${v.filePath}\n`);
process.stderr.write(` Length : ${v.length} (max ${MAX_LENGTH})\n`);
process.stderr.write(` Desc : ${preview}\n\n`);
}
process.stderr.write(`Trim descriptions to <= ${MAX_LENGTH} chars. Flag docs belong in argument-hint:.\n\n`);
return 1;
}
if (violations.length === 0) {
const checked = files.length;
process.stdout.write(`ok lint-descriptions: ${checked} file(s) checked, 0 violations\n`);
process.exit(0);
}
process.stderr.write(`\nERROR lint-descriptions: ${violations.length} violation(s) found\n\n`);
for (const v of violations) {
const preview = v.description.length > 120 ? v.description.slice(0, 117) + '...' : v.description;
process.stderr.write(` ${v.filePath}\n`);
process.stderr.write(` Length : ${v.length} (max ${MAX_LENGTH})\n`);
process.stderr.write(` Desc : ${preview}\n\n`);
}
process.stderr.write(`Trim descriptions to <= ${MAX_LENGTH} chars. Flag docs belong in argument-hint:.\n\n`);
process.exit(1);
runMain(main);