chore: Clean up OptionDefinition (#2747)

* expose enum option value map

* update option.type to optionType union

* add comments to OptionDefinition

Author: inferrinizzard

packages/quicktype-core/src/RendererOptions/index.ts

@@ -77,7 +77,7 @@ export class BooleanOption<Name extends string> extends Option<Name, boolean> {
         super({
             name,
             kind,
-            type: Boolean,
+            optionType: "boolean",
             description,
             defaultValue,
         });
@@ -134,15 +134,14 @@ export class StringOption<Name extends string> extends Option<Name, string> {
         defaultValue: string,
         kind: OptionKind = "primary",
     ) {
-        const definition = {
+        super({
             name,
             kind,
-            type: String,
+            optionType: "string",
             description,
             typeLabel,
             defaultValue,
-        };
-        super(definition);
+        });
     }
 }
 
@@ -163,15 +162,15 @@ export class EnumOption<
         defaultValue: NoInfer<EnumKey>,
         kind: OptionKind = "primary",
     ) {
-        const definition = {
+        super({
             name,
             kind,
-            type: String,
+            optionType: "enum",
             description,
             typeLabel: Object.keys(values).join("|"),
             defaultValue,
-        };
-        super(definition);
+            values,
+        });
 
         this._values = values;
     }

packages/quicktype-core/src/RendererOptions/types.ts

@@ -8,14 +8,25 @@ import type { EnumOption, Option } from "./index";
 export type OptionKind = "primary" | "secondary" | "cli";
 
 export interface OptionDefinition<Name extends string = string, T = unknown> {
+    /** Option Name */
+    name: Name;
+    /** Option Alias for CLI */
     alias?: string;
-    defaultOption?: boolean;
-    defaultValue?: T;
+    /** Option Description */
     description: string;
+    /** Category of Option */
+    optionType: "string" | "boolean" | "enum";
+    /** Default Value for Option */
+    defaultValue?: T;
+    /** Enum only, map of possible keys and values */
+    values?: Record<string, unknown>;
+
+    /** Primary, Secondary, or CLI */
     kind?: OptionKind;
+    /** Whether multiple CLI inputs are allowed for this option */
     multiple?: boolean;
-    name: Name;
-    type: StringConstructor | BooleanConstructor;
+
+    // Unknown
     typeLabel?: string;
 }
 

src/index.ts

@@ -411,15 +411,15 @@ function makeOptionDefinitions(
         {
             name: "out",
             alias: "o",
-            type: String,
+            optionType: "string",
             typeLabel: "FILE",
             description: "The output file. Determines --lang and --top-level.",
             kind: "cli",
         },
         {
             name: "top-level",
             alias: "t",
-            type: String,
+            optionType: "string",
             typeLabel: "NAME",
             description: "The name for the top level type.",
             kind: "cli",
@@ -432,7 +432,7 @@ function makeOptionDefinitions(
                   {
                       name: "lang",
                       alias: "l",
-                      type: String,
+                      optionType: "string",
                       typeLabel: "LANG",
                       description: "The target language.",
                       kind: "cli",
@@ -442,24 +442,23 @@ function makeOptionDefinitions(
         {
             name: "src-lang",
             alias: "s",
-            type: String,
+            optionType: "string",
             defaultValue: undefined,
             typeLabel: "SRC_LANG",
             description: "The source language (default is json).",
             kind: "cli",
         },
         {
             name: "src",
-            type: String,
+            optionType: "string",
             multiple: true,
-            defaultOption: true,
             typeLabel: "FILE|URL|DIRECTORY",
             description: "The file, url, or data directory to type.",
             kind: "cli",
         },
         {
             name: "src-urls",
-            type: String,
+            optionType: "string",
             typeLabel: "FILE",
             description: "Tracery grammar describing URLs to crawl.",
             kind: "cli",
@@ -469,7 +468,7 @@ function makeOptionDefinitions(
         mapMap(mapFromObject(inferenceFlags), (flag, name) => {
             return {
                 name: dashedFromCamelCase(negatedInferenceFlagName(name)),
-                type: Boolean,
+                optionType: "boolean" as const,
                 description: flag.negationDescription + ".",
                 kind: "cli" as const,
             };
@@ -478,29 +477,29 @@ function makeOptionDefinitions(
     const afterInference: OptionDefinition[] = [
         {
             name: "graphql-schema",
-            type: String,
+            optionType: "string",
             typeLabel: "FILE",
             description: "GraphQL introspection file.",
             kind: "cli",
         },
         {
             name: "graphql-introspect",
-            type: String,
+            optionType: "string",
             typeLabel: "URL",
             description: "Introspect GraphQL schema from a server.",
             kind: "cli",
         },
         {
             name: "http-method",
-            type: String,
+            optionType: "string",
             typeLabel: "METHOD",
             description:
                 "HTTP method to use for the GraphQL introspection query.",
             kind: "cli",
         },
         {
             name: "http-header",
-            type: String,
+            optionType: "string",
             multiple: true,
             typeLabel: "HEADER",
             description:
@@ -510,69 +509,69 @@ function makeOptionDefinitions(
         {
             name: "additional-schema",
             alias: "S",
-            type: String,
+            optionType: "string",
             multiple: true,
             typeLabel: "FILE",
             description: "Register the $id's of additional JSON Schema files.",
             kind: "cli",
         },
         {
             name: "no-render",
-            type: Boolean,
+            optionType: "boolean",
             description: "Don't render output.",
             kind: "cli",
         },
         {
             name: "alphabetize-properties",
-            type: Boolean,
+            optionType: "boolean",
             description: "Alphabetize order of class properties.",
             kind: "cli",
         },
         {
             name: "all-properties-optional",
-            type: Boolean,
+            optionType: "boolean",
             description: "Make all class properties optional.",
             kind: "cli",
         },
         {
             name: "build-markov-chain",
-            type: String,
+            optionType: "string",
             typeLabel: "FILE",
             description: "Markov chain corpus filename.",
             kind: "cli",
         },
         {
             name: "quiet",
-            type: Boolean,
+            optionType: "boolean",
             description: "Don't show issues in the generated code.",
             kind: "cli",
         },
         {
             name: "debug",
-            type: String,
+            optionType: "string",
             typeLabel: "OPTIONS or all",
             description:
                 "Comma separated debug options: print-graph, print-reconstitution, print-gather-names, print-transformations, print-schema-resolving, print-times, provenance",
             kind: "cli",
         },
         {
             name: "telemetry",
-            type: String,
+            optionType: "string",
             typeLabel: "enable|disable",
             description: "Enable anonymous telemetry to help improve quicktype",
             kind: "cli",
         },
         {
             name: "help",
             alias: "h",
-            type: Boolean,
+            optionType: "boolean",
             description: "Get some help.",
             kind: "cli",
         },
         {
             name: "version",
             alias: "v",
-            type: Boolean,
+            optionType: "boolean",
             description: "Display the version of quicktype",
             kind: "cli",
         },