Merge branch 'main' into benjie/incremental-common

Author: leebyron

.github/algorithm-format-check.mjs

@@ -28,7 +28,7 @@ for (const filename of filenames) {
       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).*)$/);
+        line.match(/^([A-Za-z0-9]+) ::?\s+((\S).*)$/);
       if (matches) {
         const [, algorithmName, ns1, _args, ns2, ns3] = matches;
         if (ns1 || ns2 || ns3) {
@@ -67,14 +67,23 @@ for (const filename of filenames) {
             console.log();
             process.exitCode = 1;
           }
-          if (step.match(/^\s*(-|[0-9]\.)\s+[a-z]/)) {
+          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 assertMatch = step.match(/^\s*(-|[0-9]+\.)\s*Assert([^:])/);
+          if (assertMatch) {
+            console.log(
+              `Bad formatting of '${algorithmName}' step (Assert should be immediately followed by ':'; found '${assertMatch[2]}') in '${filename}':`
+            );
+            console.dir(step);
+            console.log();
+            process.exitCode = 1;
+          }
 
           const stepWithoutValueLiterals = step.replace(
             valueLiteralsRegexp,
@@ -131,6 +140,10 @@ for (const filename of filenames) {
           console.log();
           process.exitCode = 1;
         }
+        while (lines[i + 1].trim() !== "") {
+          // Continuation of definition
+          i++;
+        }
         if (!lines[i + 2].startsWith("- ")) {
           // Not an algorithm; probably more grammar
           continue;
@@ -176,6 +189,15 @@ for (const filename of filenames) {
             console.log();
             process.exitCode = 1;
           }
+          const assertMatch = step.match(/^\s*(-|[0-9]+\.)\s*Assert([^:])/);
+          if (assertMatch) {
+            console.log(
+              `Bad formatting of '${grammarName}' step (Assert should be immediately followed by ':'; found '${assertMatch[2]}') in '${filename}':`
+            );
+            console.dir(step);
+            console.log();
+            process.exitCode = 1;
+          }
         }
       }
     }

package-lock.json

@@ -21,13 +21,15 @@
     "suggest:format": "echo \"\nTo resolve this, run: $(tput bold)npm run format$(tput sgr0)\" && exit 1",
     "build": "./build.sh",
     "test:build": "spec-md --metadata spec/metadata.json spec/GraphQL.md > /dev/null",
-    "watch": "nodemon -e json,md --exec \"npm run build\""
+    "watch": "nodemon -e json,md --exec \"npm run build\"",
+    "update-appendix-c": "node scripts/update-appendix-c.mjs; prettier --write \"spec/Appendix C -- Built-in Definitions.md\""
   },
   "devDependencies": {
     "cspell": "5.9.1",
     "nodemon": "2.0.20",
     "prettier": "2.8.2",
-    "spec-md": "3.1.0"
+    "spec-md": "3.1.0",
+    "graphql": "^17.0.0-alpha.8"
   },
   "prettier": {
     "proseWrap": "always",

package.json

@@ -0,0 +1,28 @@
+import { writeFile } from 'node:fs/promises';
+import { printIntrospectionSchema, buildSchema, specifiedScalarTypes, printType } from 'graphql';
+
+const FILE = './spec/Appendix C -- Specified Definitions.md';
+function printSpecifiedScalars() {
+  return specifiedScalarTypes
+    .map((type) => printType(type))
+    .join('\n\n');
+}
+
+const introspectionSchema = printIntrospectionSchema(buildSchema(`type Query { i: Int }`));
+const prefix = `
+# C. Appendix: Type System Definitions
+
+This appendix lists the specified type system definitions.
+
+The descriptions are non-normative. Implementations are recommended to use them
+for consistency but different descriptions are allowed.
+
+The order of types, fields, arguments, values and directives is non-normative.
+
+\`\`\`graphql
+`
+
+const suffix = `
+\`\`\`
+`
+await writeFile(FILE, prefix + printSpecifiedScalars() + '\n\n' + introspectionSchema + suffix);