Enforce consistent punctuation in algorithms #1069
There are no files selected for viewing
This file contains hidden or 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,114 @@ | ||
| import { readFile, readdir } from "node:fs/promises"; | ||
|
|
||
| const SPEC_DIR = new URL("../spec", import.meta.url).pathname; | ||
|
|
||
| process.exitCode = 0; | ||
| const filenames = await readdir(SPEC_DIR); | ||
| for (const filename of filenames) { | ||
| if (!filename.endsWith(".md")) { | ||
| continue; | ||
| } | ||
| const markdown = await readFile(`${SPEC_DIR}/${filename}`, "utf8"); | ||
|
|
||
| /** | ||
| * Not strictly 'lines' since we try and group indented things together as if | ||
| * they were one line. Close enough though. | ||
| */ | ||
| const lines = markdown.split(/\n(?=[\S\n]|\s*(?:-|[0-9]+\.) )/); | ||
|
|
||
| for (let i = 0, l = lines.length; i < l; i++) { | ||
| const line = lines[i]; | ||
|
|
||
| // Check algorithm is consistently formatted | ||
| { | ||
| // Is it an algorithm definition? | ||
| const matches = line.match(/^([a-z0-9A-Z]+)(\s*)\(([^)]*)\)(\s*):(\s*)$/); | ||
| if (matches) { | ||
| const [, algorithmName, ns1, _args, ns2, ns3] = matches; | ||
| if (ns1 || ns2 || ns3) { | ||
| console.log( | ||
| `Bad whitespace in definition of ${algorithmName} in '${filename}':` | ||
| ); | ||
| console.log(line); | ||
| console.log(); | ||
| process.exitCode = 1; | ||
| } | ||
| if (lines[i + 1] !== "") { | ||
| console.log( | ||
| `No empty space after algorithm ${algorithmName} header in '${filename}'` | ||
| ); | ||
| console.log(); | ||
| process.exitCode = 1; | ||
| } | ||
| for (let j = i + 2; j < l; j++) { | ||
| const step = lines[j]; | ||
| if (!step.match(/^\s*(-|[0-9]+\.) /)) { | ||
| if (step !== "") { | ||
| console.log( | ||
| `Bad algorithm ${algorithmName} step in '${filename}':` | ||
| ); | ||
| console.log(step); | ||
| console.log(); | ||
| process.exitCode = 1; | ||
| } | ||
| break; | ||
| } | ||
| if (!step.match(/[.:]$/)) { | ||
| console.log( | ||
| `Bad formatting for '${algorithmName}' step (does not end in '.' or ':') in '${filename}':` | ||
| ); | ||
| console.log(step); | ||
| console.log(); | ||
| process.exitCode = 1; | ||
| } | ||
| if (step.match(/^\s*(-|[0-9]\.)\s+[a-z]/)) { | ||
| console.log( | ||
| `Bad formatting of '${algorithmName}' step (should start with a capital) in '${filename}':` | ||
| ); | ||
| console.log(step); | ||
| console.log(); | ||
| process.exitCode = 1; | ||
| } | ||
| const trimmedInnerLine = step.replace(/\s+/g, " "); | ||
| if ( | ||
| trimmedInnerLine.match( | ||
| /(?:[rR]eturn|is (?:not )?)(true|false|null)\b/ | ||
| ) && | ||
| !trimmedInnerLine.match(/null or empty/) | ||
| ) { | ||
| console.log( | ||
| `Potential bad formatting of '${algorithmName}' step (true/false/null should be wrapped in curly braces, e.g. '{true}') in '${filename}':` | ||
| ); | ||
| console.log(step); | ||
| console.log(); | ||
| process.exitCode = 1; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Check `- ...:` step is followed by an indent | ||
| { | ||
| const matches = line.match(/^(\s*)- .*:\s*$/); | ||
| if (matches) { | ||
| const indent = matches[1]; | ||
| const nextLine = lines[i + 1]; | ||
| if (!nextLine.startsWith(`${indent} `)) { | ||
| console.log( | ||
| `Lacking indent in '${filename}' following ':' character:` | ||
| ); | ||
| console.dir(line); | ||
| console.dir(nextLine); | ||
| console.log(); | ||
| // TODO: process.exitCode = 1; | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (process.exitCode === 0) { | ||
| console.log(`Everything looks okay!`); | ||
| } else { | ||
| console.log(`Please resolve the errors detailed above.`); | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This TODO is due to bad formatting in
MapSourceToResponseEvent, but that's something that's a little more controversial so I raised a separate PR for it and removed the TODO here:2d1c477