Add Appendix C - Specified Type System Definitions (#1037)

* Add appendix C - builtin definitions

* also run prettier

* update graphql-js

* Update scripts/update-appendix-c.mjs

Co-authored-by: Benjie <[email protected]>

* add specified scalars

* manual tweaking

* built-in => specified

* another instance of BuiltIn => Specified

* update the order of fields to match graphql-js

* Update update-appendix-c.mjs

line break

---------

Co-authored-by: Benjie <[email protected]>
Co-authored-by: Lee Byron <[email protected]>

Author: 3 people

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);