quicktype 23.0.176 → 23.1.0

package/README.md

@@ -186,6 +186,11 @@ 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.
 
+### 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/>
+Check out [this guide](./doc/CustomRenderer.md) for more info.
+
 ## Contributing
 
 `quicktype` is [Open Source](LICENSE) and we love contributors! In fact, we have a [list of issues](https://github.com/quicktype/quicktype/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3Ahelp-wanted) that are low-priority for us, but for which we'd happily accept contributions. Support for new target languages is also strongly desired. If you'd like to contribute, need help with anything at all, or would just like to talk things over, come [join us on Slack](http://slack.quicktype.io/).

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import { type Readable } from "readable-stream";
-import { JSONInput, type Options, type RendererOptions, type SerializedRenderResult, type TargetLanguage } from "quicktype-core";
-export interface CLIOptions {
+import { JSONInput, type LanguageName, type Options, type RendererOptions, type SerializedRenderResult, type TargetLanguage } from "quicktype-core";
+export interface CLIOptions<Lang extends LanguageName = LanguageName> {
     [option: string]: any;
     additionalSchema: string[];
     allPropertiesOptional: boolean;
@@ -13,11 +13,11 @@ export interface CLIOptions {
     help: boolean;
     httpHeader?: string[];
     httpMethod?: string;
-    lang: string;
+    lang: Lang;
     noRender: boolean;
     out?: string;
     quiet: boolean;
-    rendererOptions: RendererOptions;
+    rendererOptions: RendererOptions<Lang>;
     src: string[];
     srcLang: string;
     srcUrls?: string;

package/dist/index.js

@@ -206,17 +206,18 @@ function inferCLIOptions(opts, targetLanguage) {
     }
     else {
         const languageName = opts.lang ?? inferLang(opts, defaultDefaultTargetLanguageName);
-        const maybeLanguage = (0, quicktype_core_1.languageNamed)(languageName);
-        if (maybeLanguage === undefined) {
+        if ((0, quicktype_core_1.isLanguageName)(languageName)) {
+            language = (0, quicktype_core_1.languageNamed)(languageName);
+        }
+        else {
             return (0, quicktype_core_1.messageError)("DriverUnknownOutputLanguage", { lang: languageName });
         }
-        language = maybeLanguage;
     }
     const options = {
         src: opts.src ?? [],
         srcUrls: opts.srcUrls,
         srcLang: srcLang,
-        lang: language.displayName,
+        lang: language.name,
         topLevel: opts.topLevel ?? inferTopLevel(opts),
         noRender: !!opts.noRender,
         alphabetizeProperties: !!opts.alphabetizeProperties,
@@ -476,7 +477,8 @@ function parseCLIOptions(argv, targetLanguage) {
     // twice.  This is the first parse to get the renderer:
     const incompleteOptions = inferCLIOptions(parseOptions(optionDefinitions, argv, true), targetLanguage);
     if (targetLanguage === undefined) {
-        targetLanguage = (0, quicktype_core_1.getTargetLanguage)(incompleteOptions.lang);
+        const languageName = (0, quicktype_core_1.isLanguageName)(incompleteOptions.lang) ? incompleteOptions.lang : "typescript";
+        targetLanguage = (0, quicktype_core_1.getTargetLanguage)(languageName);
     }
     const rendererOptionDefinitions = targetLanguage.cliOptionDefinitions.actual;
     // Use the global options as well as the renderer options from now on:
@@ -506,16 +508,17 @@ function parseOptions(definitions, argv, partial) {
             });
         }
     }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const options = { rendererOptions: {} };
-    for (const o of definitions) {
-        if (!(0, collection_utils_1.hasOwnProperty)(opts, o.name))
+    for (const optionDefinition of definitions) {
+        if (!(0, collection_utils_1.hasOwnProperty)(opts, optionDefinition.name)) {
             continue;
-        const v = opts[o.name];
-        if (o.renderer !== undefined)
-            options.rendererOptions[o.name] = v;
+        }
+        const v = opts[optionDefinition.name];
+        if (optionDefinition.name in options.rendererOptions) {
+            options.rendererOptions[optionDefinition.name] = v;
+        }
         else {
-            const k = _.lowerFirst(o.name.split("-").map(_.upperFirst).join(""));
+            const k = _.lowerFirst(optionDefinition.name.split("-").map(_.upperFirst).join(""));
             options[k] = v;
         }
     }
@@ -582,7 +585,8 @@ function makeTypeScriptSource(fileNames) {
 }
 function jsonInputForTargetLanguage(targetLanguage, languages, handleJSONRefs = false) {
     if (typeof targetLanguage === "string") {
-        targetLanguage = (0, quicktype_core_1.defined)((0, quicktype_core_1.languageNamed)(targetLanguage, languages));
+        const languageName = (0, quicktype_core_1.isLanguageName)(targetLanguage) ? targetLanguage : "typescript";
+        targetLanguage = (0, quicktype_core_1.defined)((0, quicktype_core_1.languageNamed)(languageName, languages));
     }
     const compressedJSON = new CompressedJSONFromStream_1.CompressedJSONFromStream(targetLanguage.dateTimeRecognizer, handleJSONRefs);
     return new quicktype_core_1.JSONInput(compressedJSON);
@@ -736,10 +740,10 @@ async function makeQuicktypeOptions(options, targetLanguages) {
             }
         }
     }
-    const lang = (0, quicktype_core_1.languageNamed)(options.lang, targetLanguages);
-    if (lang === undefined) {
+    if (!(0, quicktype_core_1.isLanguageName)(options.lang)) {
         return (0, quicktype_core_1.messageError)("DriverUnknownOutputLanguage", { lang: options.lang });
     }
+    const lang = (0, quicktype_core_1.languageNamed)(options.lang, targetLanguages);
     const quicktypeOptions = {
         lang,
         alphabetizeProperties: options.alphabetizeProperties,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quicktype",
-  "version": "23.0.176",
+  "version": "23.1.0",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -34,9 +34,9 @@
     "graphql": "^0.11.7",
     "lodash": "^4.17.21",
     "moment": "^2.30.1",
-    "quicktype-core": "23.0.176",
-    "quicktype-graphql-input": "23.0.176",
-    "quicktype-typescript-input": "23.0.176",
+    "quicktype-core": "23.1.0",
+    "quicktype-graphql-input": "23.1.0",
+    "quicktype-typescript-input": "23.1.0",
     "readable-stream": "^4.5.2",
     "stream-json": "1.8.0",
     "string-to-stream": "^3.0.1",