-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into async-lists
- Loading branch information
Showing
12 changed files
with
349 additions
and
123 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,177 @@ | ||
| 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*)$/); | ||
| const grammarMatches = | ||
| filename === "Section 2 -- Language.md" && | ||
| line.match(/^([A-Za-z0-9]+) :\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.dir(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.dir(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.dir(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.dir(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.dir(step); | ||
| console.log(); | ||
| process.exitCode = 1; | ||
| } | ||
| } | ||
| } else if (grammarMatches) { | ||
| // This is super loosey-goosey | ||
| const [, grammarName, rest] = grammarMatches; | ||
| if (rest.trim() === "one of") { | ||
| // Still grammar, not algorithm | ||
| continue; | ||
| } | ||
| if (rest.trim() === "" && lines[i + 1] !== "") { | ||
| console.log( | ||
| `No empty space after grammar ${grammarName} header in '${filename}'` | ||
| ); | ||
| console.log(); | ||
| process.exitCode = 1; | ||
| } | ||
| if (!lines[i + 2].startsWith("- ")) { | ||
| // Not an algorithm; probably more grammar | ||
| continue; | ||
| } | ||
| for (let j = i + 2; j < l; j++) { | ||
| const step = lines[j]; | ||
| if (!step.match(/^\s*(-|[0-9]+\.) /)) { | ||
| if (step !== "") { | ||
| console.log(`Bad grammar ${grammarName} step in '${filename}':`); | ||
| console.dir(step); | ||
| console.log(); | ||
| process.exitCode = 1; | ||
| } | ||
| break; | ||
| } | ||
| if (!step.match(/[.:]$/)) { | ||
| console.log( | ||
| `Bad formatting for '${grammarName}' step (does not end in '.' or ':') in '${filename}':` | ||
| ); | ||
| console.dir(step); | ||
| console.log(); | ||
| process.exitCode = 1; | ||
| } | ||
| if (step.match(/^\s*(-|[0-9]\.)\s+[a-z]/)) { | ||
| console.log( | ||
| `Bad formatting of '${grammarName}' step (should start with a capital) in '${filename}':` | ||
| ); | ||
| console.dir(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 '${grammarName}' step (true/false/null should be wrapped in curly braces, e.g. '{true}') in '${filename}':` | ||
| ); | ||
| console.dir(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 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 |
|---|---|---|
|
|
@@ -21,3 +21,7 @@ words: | |
| - tatooine | ||
| - zuck | ||
| - zuckerberg | ||
| # Forbid Alternative spellings | ||
| flagWords: | ||
| - implementor | ||
| - implementors | ||
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
Oops, something went wrong.