Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8eca755
commit 0290189
Showing
4 changed files
with
122 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| import { readFile } from 'node:fs/promises'; | ||
|
|
||
| const [optionsText, helpText, commandReferenceText] = await Promise.all([ | ||
| readFile(new URL('../docs/999-big-list-of-options.md', import.meta.url), 'utf8'), | ||
| readFile(new URL('../cli/help.md', import.meta.url), 'utf8'), | ||
| readFile(new URL('../docs/01-command-line-reference.md', import.meta.url), 'utf8') | ||
| ]); | ||
|
|
||
| const optionSections = optionsText.split('\n### '); | ||
| let searchedOptions = ''; | ||
| for (const section of optionSections.slice(1)) { | ||
| if (!(section.startsWith('Experimental') || section.startsWith('Deprecated'))) { | ||
| searchedOptions += section; | ||
| } | ||
| } | ||
|
|
||
| const findCliOptionRegExp = /CLI: (`(-(\w)[^`]*)`\/)?`(--([\w.]+)[^`]*)`/g; | ||
|
|
||
| const allCliOptions = []; | ||
| let match; | ||
|
|
||
| while ((match = findCliOptionRegExp.exec(searchedOptions)) !== null) { | ||
| allCliOptions.push({ long: match[5], short: match[3] }); | ||
| } | ||
|
|
||
| const findOptionInHelpRegExp = /^(-(\w), )?--(no-)?([\w.]+)/gm; | ||
|
|
||
| const cliOptionsInHelp = new Map(); | ||
|
|
||
| while ((match = findOptionInHelpRegExp.exec(helpText)) !== null) { | ||
| cliOptionsInHelp.set(match[4], match[2]); | ||
| } | ||
|
|
||
| let failed = false; | ||
|
|
||
| for (const { long, short } of allCliOptions) { | ||
| if (!cliOptionsInHelp.has(long)) { | ||
| failed = true; | ||
| console.error(`Could find neither --${long} nor --no-${long} in help.md.`); | ||
| } | ||
| const optionInHelp = cliOptionsInHelp.get(long); | ||
| if (short !== optionInHelp) { | ||
| failed = true; | ||
| console.error( | ||
| `Inconsistent option with shortcut. Expected -${short}/--${long}, got -${optionInHelp.short}/--${optionInHelp.long}.` | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| if (failed) { | ||
| process.exit(1); | ||
| } | ||
|
|
||
| let current = null; | ||
| for (const [long, short] of cliOptionsInHelp) { | ||
| if (!short) { | ||
| if (current && long < current) { | ||
| console.error( | ||
| `Options in help.md are not sorted properly. "${long}" should occur before "${current}".` | ||
| ); | ||
| process.exit(1); | ||
| } | ||
| current = long; | ||
| } | ||
| } | ||
|
|
||
| const splitHelpText = helpText.split('\n'); | ||
| for (const line of splitHelpText) { | ||
| if (line.length > 80) { | ||
| console.error(`The following line in help.md exceeds the limit of 80 characters:\n${line}`); | ||
| process.exit(1); | ||
| } | ||
| } | ||
|
|
||
| const helpOptionLines = splitHelpText.filter(line => line.startsWith('-')); | ||
|
|
||
| const cliFlagsText = commandReferenceText | ||
| .split('\n### ') | ||
| .find(text => text.startsWith('Command line flags')); | ||
| const optionListLines = cliFlagsText | ||
| .match(/```text\n([\S\s]*?)\n```/)[1] | ||
| .split('\n') | ||
| .filter(line => line.startsWith('-')); | ||
|
|
||
| for (const [index, line] of helpOptionLines.entries()) { | ||
| const optionListLine = optionListLines[index]; | ||
| if (line !== optionListLine) { | ||
| console.error( | ||
| `The command lines in 01-command-line-reference.md does not match help.md. Expected line:\n${line}\n\nReceived line:\n${optionListLine}` | ||
| ); | ||
| process.exit(1); | ||
| } | ||
| } |