quicktype 24.0.1 → 25.0.0-pre1

package/README.md

@@ -189,6 +189,42 @@ main();
 
 The argument to `quicktype` is a complex object with many optional properties. [Explore its definition](https://github.com/quicktype/quicktype/blob/master/packages/quicktype-core/src/Run.ts#L637) to understand what options are allowed.
 
+#### TypeScript: the `lang` option is a `LanguageName`, not a `string`
+
+In TypeScript, the `lang` option of `quicktype` and the argument of `jsonInputForTargetLanguage` are typed as `LanguageName`, a union of all supported language names — passing a plain `string` is a compile-time error. If the language name is known statically, just pass the literal (`lang: "swift"`). For wrappers that take the language name at runtime — from CLI arguments or configuration — validate it with the `isLanguageName` type guard instead of casting:
+
+```typescript
+import { type LanguageName, isLanguageName, quicktype } from "quicktype-core";
+
+async function quicktypeJSON(targetLanguage: LanguageName, typeName: string, jsonString: string) {
+    // same body as above
+}
+
+const lang = process.argv[2]; // untrusted string
+if (!isLanguageName(lang)) {
+    throw new Error(`Unknown language: ${lang}`);
+}
+// lang now has type LanguageName
+const { lines } = await quicktypeJSON(lang, "Person", jsonString);
+```
+
+#### Bundling `quicktype-core` as ESM
+
+`quicktype-core` ships both CommonJS and ESM builds. If you bundle it into an ESM output for Node with esbuild (`--format=esm --platform=node`), the bundle may throw at runtime:
+
+```
+Error: Dynamic require of "process" is not supported
+```
+
+This is not specific to quicktype: some of its dependencies (e.g. `yaml`) expose an ESM entry that wraps a CommonJS core, and esbuild replaces `require` calls inside inlined CommonJS with a shim that throws in ESM output. The standard workaround is to inject a `createRequire` banner:
+
+```bash
+esbuild main.js --bundle --format=esm --platform=node \
+    --banner:js="import { createRequire } from 'module'; const require = createRequire(import.meta.url);"
+```
+
+Bundling to CommonJS output (`--format=cjs`) works without any workaround.
+
 ### Adding Custom logic or Rendering:
 
 Quicktype supports creating your own custom languages and rendering output, you can extend existing classes or create your own to be using by the `quicktype function`.<br/>

package/dist/GraphQLIntrospection.js

@@ -26,7 +26,7 @@ async function introspectServer(url, method, headerStrings) {
     try {
         const response = await globalThis.fetch(url, {
             method,
-            headers: headers,
+            headers,
             body: JSON.stringify({ query: (0, graphql_1.getIntrospectionQuery)() }),
         });
         result = (await response.json());

package/dist/index.js

@@ -68,7 +68,8 @@ async function sourceFromFileOrUrlArray(name, filesOrUrls, httpHeaders) {
 }
 function typeNameFromFilename(filename) {
     const name = path.basename(filename);
-    return name.substring(0, name.lastIndexOf("."));
+    const extIndex = name.lastIndexOf(".");
+    return extIndex === -1 ? "" : name.slice(0, extIndex);
 }
 async function samplesFromDirectory(dataDir, httpHeaders) {
     async function readFilesOrURLsInDirectory(d) {
@@ -79,8 +80,8 @@ async function samplesFromDirectory(dataDir, httpHeaders) {
         // Each file is a (Name, JSON | URL)
         const sourcesInDir = [];
         const graphQLSources = [];
-        let graphQLSchema = undefined;
-        let graphQLSchemaFileName = undefined;
+        let graphQLSchema;
+        let graphQLSchemaFileName;
         for (let file of files) {
             const name = typeNameFromFilename(file);
             let fileOrUrl = file;
@@ -160,14 +161,14 @@ async function samplesFromDirectory(dataDir, httpHeaders) {
         if (jsonSamples.length > 0 &&
             schemaSources.length + graphQLSources.length > 0) {
             return (0, quicktype_core_1.messageError)("DriverCannotMixJSONWithOtherSamples", {
-                dir: dir,
+                dir,
             });
         }
         // FIXME: rewrite this to be clearer
         const oneUnlessEmpty = (xs) => Math.sign(xs.length);
         if (oneUnlessEmpty(schemaSources) + oneUnlessEmpty(graphQLSources) >
             1) {
-            return (0, quicktype_core_1.messageError)("DriverCannotMixNonJSONInputs", { dir: dir });
+            return (0, quicktype_core_1.messageError)("DriverCannotMixNonJSONInputs", { dir });
         }
         if (jsonSamples.length > 0) {
             sources.push({
@@ -242,7 +243,7 @@ function inferCLIOptions(opts, targetLanguage) {
     const options = {
         src: opts.src ?? [],
         srcUrls: opts.srcUrls,
-        srcLang: srcLang,
+        srcLang,
         lang: language.name,
         topLevel: opts.topLevel ?? inferTopLevel(opts),
         noRender: !!opts.noRender,
@@ -279,7 +280,7 @@ function negatedInferenceFlagName(name) {
     if (name.startsWith(prefix)) {
         name = name.slice(prefix.length);
     }
-    return "no" + (0, quicktype_core_1.capitalize)(name);
+    return `no${(0, quicktype_core_1.capitalize)(name)}`;
 }
 function dashedFromCamelCase(name) {
     return (0, quicktype_core_1.splitIntoWords)(name)
@@ -348,7 +349,7 @@ function makeOptionDefinitions(targetLanguages) {
         return {
             name: dashedFromCamelCase(negatedInferenceFlagName(name)),
             optionType: "boolean",
-            description: flag.negationDescription + ".",
+            description: `${flag.negationDescription}.`,
             kind: "cli",
         };
     }).values());
@@ -638,7 +639,10 @@ async function getSources(options) {
     return sources;
 }
 function makeTypeScriptSource(fileNames) {
-    return Object.assign({ kind: "schema" }, (0, quicktype_typescript_input_1.schemaForTypeScriptSources)(fileNames));
+    return {
+        kind: "schema",
+        ...(0, quicktype_typescript_input_1.schemaForTypeScriptSources)(fileNames),
+    };
 }
 function jsonInputForTargetLanguage(targetLanguage, languages, handleJSONRefs = false) {
     if (typeof targetLanguage === "string") {
@@ -694,11 +698,11 @@ async function makeQuicktypeOptions(options, targetLanguages) {
         return undefined;
     }
     let sources = [];
-    let leadingComments = undefined;
+    let leadingComments;
     let fixedTopLevels = false;
     switch (options.srcLang) {
-        case "graphql":
-            let schemaString = undefined;
+        case "graphql": {
+            let schemaString;
             let wroteSchemaToFile = false;
             if (options.graphqlIntrospect !== undefined) {
                 schemaString = await (0, GraphQLIntrospection_1.introspectServer)(options.graphqlIntrospect, (0, collection_utils_1.withDefault)(options.httpMethod, "POST"), (0, collection_utils_1.withDefault)(options.httpHeader, []));
@@ -723,7 +727,7 @@ async function makeQuicktypeOptions(options, targetLanguages) {
             }
             const gqlSources = [];
             for (const queryFile of options.src) {
-                let schemaFileName = undefined;
+                let schemaFileName;
                 if (schemaString === undefined) {
                     schemaFileName = (0, quicktype_core_1.defined)(options.graphqlSchema);
                     schemaString = fs.readFileSync(schemaFileName, "utf8");
@@ -737,6 +741,7 @@ async function makeQuicktypeOptions(options, targetLanguages) {
             }
             sources = gqlSources;
             break;
+        }
         case "json":
         case "schema":
             sources = await getSources(options);
@@ -749,7 +754,10 @@ async function makeQuicktypeOptions(options, targetLanguages) {
                 const collectionJSON = fs.readFileSync(collectionFile, "utf8");
                 const { sources: postmanSources, description } = (0, quicktype_core_1.sourcesFromPostmanCollection)(collectionJSON, collectionFile);
                 for (const src of postmanSources) {
-                    sources.push(Object.assign({ kind: "json" }, stringSourceDataToStreamSourceData(src)));
+                    sources.push({
+                        kind: "json",
+                        ...stringSourceDataToStreamSourceData(src),
+                    });
                 }
                 if (postmanSources.length > 1) {
                     fixedTopLevels = true;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "quicktype",
-    "version": "24.0.1",
+    "version": "25.0.0-pre1",
     "license": "Apache-2.0",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -17,12 +17,12 @@
         "test:unit": "vitest run",
         "test:unit:watch": "vitest",
         "test:fixtures": "script/test",
-        "test:release": "ts-node test/release-version.ts",
+        "test:release": "tsx test/release-version.ts",
         "start": "script/watch",
         "clean": "rm -rf dist *~ packages/*/{dist,out}",
         "debug": "node --inspect-brk --max-old-space-size=4096 ./dist/index.js",
-        "lint": "eslint src/** packages/*/src/**",
-        "lint:fix": "eslint --fix src/** packages/*/src/**"
+        "lint": "biome check .",
+        "lint:fix": "biome check --write ."
     },
     "workspaces": [
         "./packages/quicktype-core",
@@ -40,16 +40,16 @@
         "graphql": "^16.11.0",
         "lodash": "^4.18.1",
         "moment": "^2.30.1",
-        "quicktype-core": "24.0.1",
-        "quicktype-graphql-input": "24.0.1",
-        "quicktype-typescript-input": "24.0.1",
+        "quicktype-core": "25.0.0-pre1",
+        "quicktype-graphql-input": "25.0.0-pre1",
+        "quicktype-typescript-input": "25.0.0-pre1",
         "readable-stream": "^4.5.2",
         "stream-json": "1.8.0",
         "string-to-stream": "^3.0.1",
-        "typescript": "~5.8.3"
+        "wordwrap": "^1.0.0"
     },
     "devDependencies": {
-        "@biomejs/biome": "^1.9.4",
+        "@biomejs/biome": "^2.5.3",
         "@tsconfig/node20": "^20.1.6",
         "@types/command-line-args": "^5.2.0",
         "@types/command-line-usage": "^5.0.4",
@@ -60,12 +60,9 @@
         "@types/stream-json": "^1.7.3",
         "@types/urijs": "^1.19.25",
         "@types/wordwrap": "^1.0.3",
-        "@typescript-eslint/eslint-plugin": "^6.3.0",
-        "@typescript-eslint/parser": "^6.3.0",
         "ajv": "^5.5.2",
         "deep-equal": "^2.2.3",
         "esbuild": "^0.28.1",
-        "exit": "^0.1.2",
         "promise-timeout": "^1.3.0",
         "semver": "^7.5.4",
         "shelljs": "^0.10.0",
@@ -81,7 +78,8 @@
         "tree-sitter-rust": "^0.24.0",
         "tree-sitter-scala": "^0.24.0",
         "tree-sitter-typescript": "^0.23.2",
-        "ts-node": "^10.9.2",
+        "tsx": "^4.23.1",
+        "typescript": "~7.0.2",
         "vitest": "^4.1.10",
         "watch": "^1.0.2",
         "web-tree-sitter": "^0.26.9"