graphql-jerky 1.0.9 → 1.0.11

package/README.md

@@ -31,6 +31,9 @@ By default, the working directory is searched recursively for `*.graphql` files.
 All of which are combined into a single schema and rendered to `schema_gen.ts`
 in the same directory.
 
+Jerky reads the schema files and the resolver files in the order of their
+paths. Thus, the output is the same on all platforms and file systems.
+
 A path to a directory or file can be passed as the first parameter to limit to
 scope of the search.
 

package/build/lib.cjs

@@ -277,6 +277,30 @@ class RequiredPackages {
     }
 }
 
+/**
+ * Glob options that make Windows paths work as patterns. On Windows, a
+ * backslash is a path separator and not an escape character.
+ */
+const globOptions = {
+    windowsPathsNoEscape: path.sep === "\\",
+};
+/**
+ * Converts native path separators to forward slashes.
+ *
+ * Glob patterns and module specifiers must use forward slashes, even on
+ * Windows.
+ */
+function toPosixPath(p) {
+    return path.sep === "\\" ? p.replaceAll("\\", "/") : p;
+}
+/**
+ * Compares paths by code unit. The result does not change with the locale
+ * or with the order in which the file system returns entries.
+ */
+function comparePaths(a, b) {
+    return a < b ? -1 : a > b ? 1 : 0;
+}
+
 function renderSymbolReference(pkgs, ref, alias) {
     const ns = ref.module
         ? jen.jen.id(pkgs.addRequires(ref.module, ref.symbol, alias ?? ref.alias))
@@ -285,10 +309,10 @@ function renderSymbolReference(pkgs, ref, alias) {
 }
 
 function compareEntryKey([a], [b]) {
-    return a.localeCompare(b);
+    return a.localeCompare(b, "en");
 }
 function compareName({ name: a }, { name: b }) {
-    return a.localeCompare(b);
+    return a.localeCompare(b, "en");
 }
 const PRIMITIVE_TYPES = new Set(["ID", "Int", "Float", "String", "Boolean"]);
 function isPrimitiveType(type) {
@@ -307,8 +331,9 @@ function renderImports(base, imports, aliases, extMode = "omit") {
         if (mod.startsWith("file:///")) {
             mod = node_url.fileURLToPath(mod);
         }
-        if (mod.startsWith("/")) {
-            mod = path.relative(base, mod);
+        if (path.isAbsolute(mod)) {
+            // NOTE: module specifiers always use forward slashes, even on Windows.
+            mod = toPosixPath(path.relative(base, mod));
             if (!mod.startsWith(".")) {
                 mod = `./${mod}`;
             }
@@ -324,8 +349,8 @@ function renderImports(base, imports, aliases, extMode = "omit") {
         }
         return jen.import
             .obj(...Array.from(symbols)
-            .sort((a, b) => a.localeCompare(b) ||
-            importAlias(a).localeCompare(importAlias(b)))
+            .sort((a, b) => a.localeCompare(b, "en") ||
+            importAlias(a).localeCompare(importAlias(b), "en"))
             .map((symbol) => symbol in aliases
             ? jen.id(aliases[symbol]).as.id(symbol)
             : jen.id(symbol)))
@@ -1036,7 +1061,10 @@ class GeneratorContext {
                 ? [
                     jen.prop("subscription", this._renderGraphQLTypeIdentifier(subscriptionType)),
                 ]
-                : []), jen.prop("types", jen.array(...types.map((type) => this._renderGraphQLTypeIdentifier(type)))), jen.prop("directives", jen.array(...Array.from(schema.getDirectives())
+                : []), jen.prop("types", jen.array(...types.map((type) => this._renderGraphQLTypeIdentifier(type)))), 
+            // graphql-js adds the built-in directives only when the
+            // directives list is not given, so include them explicitly.
+            jen.prop("directives", jen.array(jen.spread(this._gql("specifiedDirectives")), ...Array.from(schema.getDirectives())
                 .filter((d) => !isBuiltInDirective(d.name))
                 .map((d) => this._renderGraphQLTypeIdentifier(d)))))),
             jen.export.default.id("schema"),
@@ -1092,9 +1120,9 @@ class GeneratorContext {
         ];
     }
     renderFile(outfile, renderStatements) {
-        const base = outfile.startsWith("/") ? outfile : path.resolve(outfile);
+        const base = path.resolve(outfile);
         const statements = renderStatements.call(this);
-        const [localImports, externalImports] = partition(Object.entries(this._pkgs.requires), ([pkg]) => pkg.startsWith("/"));
+        const [localImports, externalImports] = partition(Object.entries(this._pkgs.requires), ([pkg]) => path.isAbsolute(pkg));
         return format(jen
             .statements(renderImports(path.dirname(base), externalImports, this._pkgs.aliases, this._extMode), renderImports(path.dirname(base), localImports, this._pkgs.aliases, this._extMode), ...statements)
             .toString());
@@ -1275,23 +1303,25 @@ async function parseResolverFile(path) {
 async function parseTypeResolvers(typeName, glob$1, ignore) {
     const shouldIgnore = createMatcher(ignore);
     const result = {};
-    for await (const entry of glob.globIterate(glob$1, { withFileTypes: true })) {
-        const fullpath = entry.fullpath();
-        if (!shouldIgnore(fullpath) &&
-            entry.isFile() &&
-            entry.name.endsWith(".ts")) {
-            for (const [name, reference] of Object.entries(await parseResolverFile(fullpath))) {
-                let realName = name;
-                if (realName === "default" &&
-                    typeof glob$1 === "string" &&
-                    glob$1.endsWith("/*.ts")) {
-                    realName = path.basename(fullpath, path.extname(fullpath));
-                }
-                if (realName in result) {
-                    console.warn(`WARNING: Duplicate resolver name: ${typeName ? `${typeName}.` : ""}${name} in ${fullpath} and ${result[name].module}`);
-                }
-                result[realName] = reference;
+    // NOTE: sort the files so that the result (and the warnings) do not change
+    // with the order in which the file system returns entries.
+    const fullpaths = (await glob.glob(glob$1, { ...globOptions, withFileTypes: true }))
+        .filter((entry) => entry.isFile() && entry.name.endsWith(".ts"))
+        .map((entry) => toPosixPath(entry.fullpath()))
+        .filter((fullpath) => !shouldIgnore(fullpath))
+        .sort(comparePaths);
+    for (const fullpath of fullpaths) {
+        for (const [name, reference] of Object.entries(await parseResolverFile(fullpath))) {
+            let realName = name;
+            if (realName === "default" &&
+                typeof glob$1 === "string" &&
+                toPosixPath(glob$1).endsWith("/*.ts")) {
+                realName = path.basename(fullpath, path.extname(fullpath));
             }
+            if (realName in result) {
+                console.warn(`WARNING: Duplicate resolver name: ${typeName ? `${typeName}.` : ""}${realName} in ${fullpath} and ${result[realName].module}`);
+            }
+            result[realName] = reference;
         }
     }
     return result;
@@ -1303,8 +1333,9 @@ async function parse$2(dirpath, ignore) {
     }
     const out = {};
     const shouldIgnore = createMatcher(ignore);
-    for await (const name of await fs.readdir(dirpath)) {
-        const file = path.join(dirpath, name);
+    const names = (await fs.readdir(dirpath)).sort(comparePaths);
+    for (const name of names) {
+        const file = path.posix.join(toPosixPath(dirpath), name);
         const entry = await fs.stat(file);
         if (entry.isDirectory()) {
             out[name] = await parseTypeResolvers(name, `${file}/*.ts`, shouldIgnore);
@@ -1614,7 +1645,7 @@ function namedNodesDict(nodes = []) {
     return Object.fromEntries(nodes.map((node) => [node.name.value, node]));
 }
 function sortNamedNodes(nodes) {
-    return Array.from(nodes).sort(({ name: { value: a } }, { name: { value: b } }) => a.localeCompare(b));
+    return Array.from(nodes).sort(({ name: { value: a } }, { name: { value: b } }) => a.localeCompare(b, "en"));
 }
 function isIntValueNodeEqual(a, b) {
     return a.value === b.value;
@@ -1948,21 +1979,31 @@ function mergeDocumentNodes(documentNodes) {
     };
 }
 
-async function* findSchemaFiles(glob$1) {
-    for await (const path$1 of glob.globIterate(glob$1)) {
+async function collectSchemaFiles(glob$1, files) {
+    for (const path$1 of await glob.glob(glob$1, globOptions)) {
         const entry = await fs.stat(path$1);
         if (entry.isFile()) {
-            yield path$1;
+            files.add(toPosixPath(path$1));
         }
         else if (entry.isDirectory()) {
-            yield* findSchemaFiles(path.join(path$1, "**/*.graphql"));
+            await collectSchemaFiles(path.posix.join(toPosixPath(path$1), "**/*.graphql"), files);
         }
     }
 }
+/**
+ * Finds the schema files and sorts them by path. The order of the files sets
+ * the order of the merged definitions and fields, so it must not change with
+ * the file system or the platform.
+ */
+async function findSchemaFiles(glob) {
+    const files = new Set();
+    await collectSchemaFiles(glob, files);
+    return Array.from(files).sort(comparePaths);
+}
 async function parse(glob, ignore) {
     const shouldIgnore = createMatcher(ignore);
     const documentNodes = [];
-    for await (const entry of findSchemaFiles(glob)) {
+    for (const entry of await findSchemaFiles(glob)) {
         if (shouldIgnore(entry)) {
             continue;
         }

package/build/lib.mjs

@@ -1,4 +1,4 @@
-import path, { resolve, basename, extname, join } from 'node:path';
+import path, { resolve, basename, extname, posix } from 'node:path';
 import { pathToFileURL, fileURLToPath } from 'node:url';
 import { GraphQLNonNull, GraphQLList, GraphQLScalarType, GraphQLEnumType, GraphQLDirective, Kind, GraphQLObjectType, getNamedType, getNullableType, GraphQLInterfaceType, GraphQLUnionType, GraphQLInputObjectType, DirectiveLocation, specifiedDirectives, isTypeExtensionNode, GraphQLError, isTypeDefinitionNode, parse as parse$3, Source, buildASTSchema, validateSchema } from 'graphql';
 import jen$1, { jen } from 'jennifer-js';
@@ -7,7 +7,7 @@ import partition from 'just-partition';
 import pascalCase from 'just-pascal-case';
 import fs from 'node:fs/promises';
 import ts, { getLineAndCharacterOfPosition } from 'typescript';
-import { globIterate } from 'glob';
+import { glob } from 'glob';
 import pm from 'picomatch';
 import zip from 'just-zip-it';
 
@@ -275,6 +275,30 @@ class RequiredPackages {
     }
 }
 
+/**
+ * Glob options that make Windows paths work as patterns. On Windows, a
+ * backslash is a path separator and not an escape character.
+ */
+const globOptions = {
+    windowsPathsNoEscape: path.sep === "\\",
+};
+/**
+ * Converts native path separators to forward slashes.
+ *
+ * Glob patterns and module specifiers must use forward slashes, even on
+ * Windows.
+ */
+function toPosixPath(p) {
+    return path.sep === "\\" ? p.replaceAll("\\", "/") : p;
+}
+/**
+ * Compares paths by code unit. The result does not change with the locale
+ * or with the order in which the file system returns entries.
+ */
+function comparePaths(a, b) {
+    return a < b ? -1 : a > b ? 1 : 0;
+}
+
 function renderSymbolReference(pkgs, ref, alias) {
     const ns = ref.module
         ? jen.id(pkgs.addRequires(ref.module, ref.symbol, alias ?? ref.alias))
@@ -283,10 +307,10 @@ function renderSymbolReference(pkgs, ref, alias) {
 }
 
 function compareEntryKey([a], [b]) {
-    return a.localeCompare(b);
+    return a.localeCompare(b, "en");
 }
 function compareName({ name: a }, { name: b }) {
-    return a.localeCompare(b);
+    return a.localeCompare(b, "en");
 }
 const PRIMITIVE_TYPES = new Set(["ID", "Int", "Float", "String", "Boolean"]);
 function isPrimitiveType(type) {
@@ -305,8 +329,9 @@ function renderImports(base, imports, aliases, extMode = "omit") {
         if (mod.startsWith("file:///")) {
             mod = fileURLToPath(mod);
         }
-        if (mod.startsWith("/")) {
-            mod = path.relative(base, mod);
+        if (path.isAbsolute(mod)) {
+            // NOTE: module specifiers always use forward slashes, even on Windows.
+            mod = toPosixPath(path.relative(base, mod));
             if (!mod.startsWith(".")) {
                 mod = `./${mod}`;
             }
@@ -322,8 +347,8 @@ function renderImports(base, imports, aliases, extMode = "omit") {
         }
         return jen$1.import
             .obj(...Array.from(symbols)
-            .sort((a, b) => a.localeCompare(b) ||
-            importAlias(a).localeCompare(importAlias(b)))
+            .sort((a, b) => a.localeCompare(b, "en") ||
+            importAlias(a).localeCompare(importAlias(b), "en"))
             .map((symbol) => symbol in aliases
             ? jen$1.id(aliases[symbol]).as.id(symbol)
             : jen$1.id(symbol)))
@@ -1034,7 +1059,10 @@ class GeneratorContext {
                 ? [
                     jen$1.prop("subscription", this._renderGraphQLTypeIdentifier(subscriptionType)),
                 ]
-                : []), jen$1.prop("types", jen$1.array(...types.map((type) => this._renderGraphQLTypeIdentifier(type)))), jen$1.prop("directives", jen$1.array(...Array.from(schema.getDirectives())
+                : []), jen$1.prop("types", jen$1.array(...types.map((type) => this._renderGraphQLTypeIdentifier(type)))), 
+            // graphql-js adds the built-in directives only when the
+            // directives list is not given, so include them explicitly.
+            jen$1.prop("directives", jen$1.array(jen$1.spread(this._gql("specifiedDirectives")), ...Array.from(schema.getDirectives())
                 .filter((d) => !isBuiltInDirective(d.name))
                 .map((d) => this._renderGraphQLTypeIdentifier(d)))))),
             jen$1.export.default.id("schema"),
@@ -1090,9 +1118,9 @@ class GeneratorContext {
         ];
     }
     renderFile(outfile, renderStatements) {
-        const base = outfile.startsWith("/") ? outfile : path.resolve(outfile);
+        const base = path.resolve(outfile);
         const statements = renderStatements.call(this);
-        const [localImports, externalImports] = partition(Object.entries(this._pkgs.requires), ([pkg]) => pkg.startsWith("/"));
+        const [localImports, externalImports] = partition(Object.entries(this._pkgs.requires), ([pkg]) => path.isAbsolute(pkg));
         return format(jen$1
             .statements(renderImports(path.dirname(base), externalImports, this._pkgs.aliases, this._extMode), renderImports(path.dirname(base), localImports, this._pkgs.aliases, this._extMode), ...statements)
             .toString());
@@ -1270,26 +1298,28 @@ async function parseResolverFile(path) {
         return [];
     })));
 }
-async function parseTypeResolvers(typeName, glob, ignore) {
+async function parseTypeResolvers(typeName, glob$1, ignore) {
     const shouldIgnore = createMatcher(ignore);
     const result = {};
-    for await (const entry of globIterate(glob, { withFileTypes: true })) {
-        const fullpath = entry.fullpath();
-        if (!shouldIgnore(fullpath) &&
-            entry.isFile() &&
-            entry.name.endsWith(".ts")) {
-            for (const [name, reference] of Object.entries(await parseResolverFile(fullpath))) {
-                let realName = name;
-                if (realName === "default" &&
-                    typeof glob === "string" &&
-                    glob.endsWith("/*.ts")) {
-                    realName = basename(fullpath, extname(fullpath));
-                }
-                if (realName in result) {
-                    console.warn(`WARNING: Duplicate resolver name: ${typeName ? `${typeName}.` : ""}${name} in ${fullpath} and ${result[name].module}`);
-                }
-                result[realName] = reference;
+    // NOTE: sort the files so that the result (and the warnings) do not change
+    // with the order in which the file system returns entries.
+    const fullpaths = (await glob(glob$1, { ...globOptions, withFileTypes: true }))
+        .filter((entry) => entry.isFile() && entry.name.endsWith(".ts"))
+        .map((entry) => toPosixPath(entry.fullpath()))
+        .filter((fullpath) => !shouldIgnore(fullpath))
+        .sort(comparePaths);
+    for (const fullpath of fullpaths) {
+        for (const [name, reference] of Object.entries(await parseResolverFile(fullpath))) {
+            let realName = name;
+            if (realName === "default" &&
+                typeof glob$1 === "string" &&
+                toPosixPath(glob$1).endsWith("/*.ts")) {
+                realName = basename(fullpath, extname(fullpath));
             }
+            if (realName in result) {
+                console.warn(`WARNING: Duplicate resolver name: ${typeName ? `${typeName}.` : ""}${realName} in ${fullpath} and ${result[realName].module}`);
+            }
+            result[realName] = reference;
         }
     }
     return result;
@@ -1301,8 +1331,9 @@ async function parse$2(dirpath, ignore) {
     }
     const out = {};
     const shouldIgnore = createMatcher(ignore);
-    for await (const name of await fs.readdir(dirpath)) {
-        const file = join(dirpath, name);
+    const names = (await fs.readdir(dirpath)).sort(comparePaths);
+    for (const name of names) {
+        const file = posix.join(toPosixPath(dirpath), name);
         const entry = await fs.stat(file);
         if (entry.isDirectory()) {
             out[name] = await parseTypeResolvers(name, `${file}/*.ts`, shouldIgnore);
@@ -1612,7 +1643,7 @@ function namedNodesDict(nodes = []) {
     return Object.fromEntries(nodes.map((node) => [node.name.value, node]));
 }
 function sortNamedNodes(nodes) {
-    return Array.from(nodes).sort(({ name: { value: a } }, { name: { value: b } }) => a.localeCompare(b));
+    return Array.from(nodes).sort(({ name: { value: a } }, { name: { value: b } }) => a.localeCompare(b, "en"));
 }
 function isIntValueNodeEqual(a, b) {
     return a.value === b.value;
@@ -1946,21 +1977,31 @@ function mergeDocumentNodes(documentNodes) {
     };
 }
 
-async function* findSchemaFiles(glob) {
-    for await (const path of globIterate(glob)) {
+async function collectSchemaFiles(glob$1, files) {
+    for (const path of await glob(glob$1, globOptions)) {
         const entry = await fs.stat(path);
         if (entry.isFile()) {
-            yield path;
+            files.add(toPosixPath(path));
         }
         else if (entry.isDirectory()) {
-            yield* findSchemaFiles(join(path, "**/*.graphql"));
+            await collectSchemaFiles(posix.join(toPosixPath(path), "**/*.graphql"), files);
         }
     }
 }
+/**
+ * Finds the schema files and sorts them by path. The order of the files sets
+ * the order of the merged definitions and fields, so it must not change with
+ * the file system or the platform.
+ */
+async function findSchemaFiles(glob) {
+    const files = new Set();
+    await collectSchemaFiles(glob, files);
+    return Array.from(files).sort(comparePaths);
+}
 async function parse(glob, ignore) {
     const shouldIgnore = createMatcher(ignore);
     const documentNodes = [];
-    for await (const entry of findSchemaFiles(glob)) {
+    for (const entry of await findSchemaFiles(glob)) {
         if (shouldIgnore(entry)) {
             continue;
         }

package/package.json

@@ -1,9 +1,11 @@
 {
 	"name": "graphql-jerky",
-	"version": "1.0.9",
+	"version": "1.0.11",
 	"description": "Jerky is a schema-first static graphql schema lightweight code generator.",
 	"type": "module",
-	"bin": "./build/bin/jerky.cjs",
+	"bin": {
+		"graphql-jerky": "build/bin/jerky.cjs"
+	},
 	"types": "./build/lib.d.ts",
 	"module": "./build/lib.mjs",
 	"main": "./build/lib.cjs",