quicktype-core 23.0.94 → 23.0.96

package/dist/ConvenienceRenderer.d.ts

@@ -5,6 +5,7 @@ import { Sourcelike } from "./Source";
 import { Declaration } from "./DeclarationIR";
 import { Transformation } from "./Transformers";
 import { TargetLanguage } from "./TargetLanguage";
+import { type Comment, type CommentOptions } from "./support/Comments";
 export declare const topLevelNameOrder = 1;
 export declare const inferredNameOrder = 30;
 export type ForbiddenWordsInfo = {
@@ -128,7 +129,8 @@ export declare abstract class ConvenienceRenderer extends Renderer {
     protected forEachNamedType(blankLocations: BlankLineConfig, objectFunc: ((c: ClassType, className: Name, position: ForEachPosition) => void) | ((o: ObjectType, objectName: Name, position: ForEachPosition) => void), enumFunc: (e: EnumType, enumName: Name, position: ForEachPosition) => void, unionFunc: (u: UnionType, unionName: Name, position: ForEachPosition) => void): void;
     protected sourcelikeToString(src: Sourcelike): string;
     protected get commentLineStart(): string;
-    protected emitCommentLines(lines: Sourcelike[], lineStart?: string, beforeLine?: string, afterLine?: string, firstLineStart?: string): void;
+    protected emitComments(comments: Comment[]): void;
+    protected emitCommentLines(lines: Sourcelike[], { lineStart, firstLineStart, lineEnd, beforeComment, afterComment }?: CommentOptions): void;
     protected emitDescription(description: Sourcelike[] | undefined): void;
     protected emitDescriptionBlock(lines: Sourcelike[]): void;
     protected emitPropertyTable(c: ClassType, makePropertyRow: (name: Name, jsonName: string, p: ClassProperty) => Sourcelike[]): void;

package/dist/ConvenienceRenderer.js

@@ -15,6 +15,7 @@ const TypeAttributes_1 = require("./attributes/TypeAttributes");
 const Description_1 = require("./attributes/Description");
 const AccessorNames_1 = require("./attributes/AccessorNames");
 const Transformers_1 = require("./Transformers");
+const Comments_1 = require("./support/Comments");
 const wordWrap = require("wordwrap")(90);
 exports.topLevelNameOrder = 1;
 const givenNameOrder = 10;
@@ -548,27 +549,43 @@ class ConvenienceRenderer extends Renderer_1.Renderer {
     get commentLineStart() {
         return "// ";
     }
-    emitCommentLines(lines, lineStart, beforeLine, afterLine, firstLineStart) {
-        if (lineStart === undefined) {
-            lineStart = this.commentLineStart;
-        }
-        if (firstLineStart === undefined) {
-            firstLineStart = lineStart;
-        }
-        if (beforeLine !== undefined) {
-            this.emitLine(beforeLine);
+    emitComments(comments) {
+        comments.forEach(comment => {
+            if ((0, Comments_1.isStringComment)(comment)) {
+                this.emitCommentLines([comment]);
+            }
+            else if ("lines" in comment) {
+                this.emitCommentLines(comment.lines);
+            }
+            else if ("descriptionBlock" in comment) {
+                this.emitDescriptionBlock(comment.descriptionBlock);
+            }
+            else {
+                this.emitCommentLines(comment.customLines, comment);
+            }
+            this.ensureBlankLine();
+        });
+    }
+    emitCommentLines(lines, { lineStart = this.commentLineStart, firstLineStart = lineStart, lineEnd, beforeComment, afterComment } = {}) {
+        if (beforeComment !== undefined) {
+            this.emitLine(beforeComment);
         }
         let first = true;
         for (const line of lines) {
             let start = first ? firstLineStart : lineStart;
+            first = false;
             if (this.sourcelikeToString(line) === "") {
                 start = (0, Strings_1.trimEnd)(start);
             }
-            this.emitLine(start, line);
-            first = false;
+            if (lineEnd) {
+                this.emitLine(start, line, lineEnd);
+            }
+            else {
+                this.emitLine(start, line);
+            }
         }
-        if (afterLine !== undefined) {
-            this.emitLine(afterLine);
+        if (afterComment !== undefined) {
+            this.emitLine(afterComment);
         }
     }
     emitDescription(description) {

package/dist/Renderer.d.ts

@@ -3,6 +3,7 @@ import { Name, Namespace } from "./Naming";
 import { Source, Sourcelike } from "./Source";
 import { AnnotationData } from "./Annotation";
 import { TargetLanguage } from "./TargetLanguage";
+import { type Comment } from "./support/Comments";
 export type RenderResult = {
     sources: ReadonlyMap<string, Source>;
     names: ReadonlyMap<Name, string>;
@@ -11,13 +12,13 @@ export type BlankLinePosition = "none" | "interposing" | "leading" | "leading-an
 export type BlankLineConfig = BlankLinePosition | [BlankLinePosition, number];
 export type RenderContext = {
     typeGraph: TypeGraph;
-    leadingComments: string[] | undefined;
+    leadingComments?: Comment[];
 };
 export type ForEachPosition = "first" | "last" | "middle" | "only";
 export declare abstract class Renderer {
     protected readonly targetLanguage: TargetLanguage;
     protected readonly typeGraph: TypeGraph;
-    protected readonly leadingComments: string[] | undefined;
+    protected readonly leadingComments: Comment[] | undefined;
     private _names;
     private _finishedFiles;
     private _finishedEmitContexts;

package/dist/Run.d.ts

@@ -3,6 +3,7 @@ import { SerializedRenderResult } from "./Source";
 import { StringTypeMapping } from "./TypeBuilder";
 import { InputData } from "./input/Inputs";
 import { TransformedStringTypeKind } from "./Type";
+import { type Comment } from "./support/Comments";
 export declare function getTargetLanguage(nameOrInstance: string | TargetLanguage): TargetLanguage;
 export type RendererOptions = {
     [name: string]: string | boolean;
@@ -109,7 +110,7 @@ export type NonInferenceOptions = {
     /** Don't render output.  This is mainly useful for benchmarking. */
     noRender: boolean;
     /** If given, output these comments at the beginning of the main output file */
-    leadingComments: string[] | undefined;
+    leadingComments?: Comment[];
     /** Options for the target language's renderer */
     rendererOptions: RendererOptions;
     /** String to use for one indentation level.  If not given, use the target language's default. */

package/dist/TargetLanguage.d.ts

@@ -5,6 +5,7 @@ import { SerializedRenderResult } from "./Source";
 import { StringTypeMapping } from "./TypeBuilder";
 import { Type } from "./Type";
 import { DateTimeRecognizer } from "./DateTime";
+import { type Comment } from "./support/Comments";
 export type MultiFileRenderResult = ReadonlyMap<string, SerializedRenderResult>;
 export declare abstract class TargetLanguage {
     readonly displayName: string;
@@ -21,7 +22,7 @@ export declare abstract class TargetLanguage {
     protected abstract makeRenderer(renderContext: RenderContext, optionValues: {
         [name: string]: any;
     }): Renderer;
-    renderGraphAndSerialize(typeGraph: TypeGraph, givenOutputFilename: string, alphabetizeProperties: boolean, leadingComments: string[] | undefined, rendererOptions: {
+    renderGraphAndSerialize(typeGraph: TypeGraph, givenOutputFilename: string, alphabetizeProperties: boolean, leadingComments: Comment[] | undefined, rendererOptions: {
         [name: string]: any;
     }, indentation?: string): MultiFileRenderResult;
     protected get defaultIndentation(): string;

package/dist/language/CJSON.js

@@ -2390,7 +2390,7 @@ class CJSONRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
      * @param lines: description block lines
      */
     emitDescriptionBlock(lines) {
-        this.emitCommentLines(lines, " * ", "/**", " */");
+        this.emitCommentLines(lines, { lineStart: " * ", beforeComment: "/**", afterComment: " */" });
     }
     /**
      * Emit code block

package/dist/language/CPlusPlus.js

@@ -667,7 +667,7 @@ class CPlusPlusRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
             this._currentFilename = this.sourcelikeToString(basename);
         }
         if (this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
         }
         else if (!this._options.justTypes) {
             this.emitCommentLines([" To parse this JSON data, first install", ""]);
@@ -741,7 +741,7 @@ class CPlusPlusRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
         return kind === "class";
     }
     emitDescriptionBlock(lines) {
-        this.emitCommentLines(lines, " * ", "/**", " */");
+        this.emitCommentLines(lines, { lineStart: " * ", beforeComment: "/**", afterComment: " */" });
     }
     emitBlock(line, withSemicolon, f, withIndent = true) {
         this.emitLine(line, " {");

package/dist/language/CSharp.js

@@ -419,7 +419,7 @@ class CSharpRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
             this.emitLine(start, lines.join("; "), "</summary>");
         }
         else {
-            this.emitCommentLines(lines, "/// ", start, "/// </summary>");
+            this.emitCommentLines(lines, { lineStart: "/// ", beforeComment: start, afterComment: "/// </summary>" });
         }
     }
     blankLinesBetweenAttributes() {
@@ -562,7 +562,7 @@ class CSharpRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
     }
     emitSourceStructure() {
         if (this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
         }
         else {
             this.emitDefaultLeadingComments();

package/dist/language/Crystal.js

@@ -297,7 +297,7 @@ class CrystalRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
     }
     emitLeadingComments() {
         if (this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
             return;
         }
     }

package/dist/language/Dart.js

@@ -226,7 +226,7 @@ class DartRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
     }
     emitFileHeader() {
         if (this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
         }
         if (this._options.justTypes)
             return;
@@ -267,7 +267,7 @@ class DartRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
         }
     }
     emitDescriptionBlock(lines) {
-        this.emitCommentLines(lines, "///", "");
+        this.emitCommentLines(lines, { lineStart: "///", beforeComment: "" });
     }
     emitBlock(line, f) {
         this.emitLine(line, " {");

package/dist/language/Elm.js

@@ -157,10 +157,10 @@ class ElmRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
     }
     emitDescriptionBlock(lines) {
         if (lines.length === 1) {
-            this.emitLine("{-| ", lines[0], " -}");
+            this.emitComments([{ customLines: lines, lineStart: "{-| ", lineEnd: " -}" }]);
         }
         else {
-            this.emitCommentLines(lines, "", undefined, "-}", "{-| ");
+            this.emitCommentLines(lines, { firstLineStart: "{-| ", lineStart: "", afterComment: "-}" });
         }
     }
     get arrayType() {
@@ -445,7 +445,7 @@ class ElmRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
                 exports.push([name, "(..)"]);
         });
         if (this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
         }
         else if (!this._options.justTypes) {
             this.emitCommentLines([

package/dist/language/Haskell.js

@@ -134,10 +134,14 @@ class HaskellRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
     }
     emitDescriptionBlock(lines) {
         if (lines.length === 1) {
-            this.emitLine("{-| ", lines[0], " -}");
+            this.emitComments([{ customLines: lines, lineStart: "{-| ", lineEnd: " -}" }]);
         }
         else {
-            this.emitCommentLines(lines, "", undefined, "-}", "{-| ");
+            this.emitCommentLines(lines, {
+                firstLineStart: "{-| ",
+                lineStart: "",
+                afterComment: "-}"
+            });
         }
     }
     haskellType(t, noOptional = false) {

package/dist/language/Java.js

@@ -418,7 +418,7 @@ class JavaRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
         // FIXME: Why is this necessary?
         this.ensureBlankLine();
         if (!this._haveEmittedLeadingComments && this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
             this.ensureBlankLine();
             this._haveEmittedLeadingComments = true;
         }
@@ -440,7 +440,7 @@ class JavaRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
         this.ensureBlankLine();
     }
     emitDescriptionBlock(lines) {
-        this.emitCommentLines(lines, " * ", "/**", " */");
+        this.emitCommentLines(lines, { lineStart: " * ", beforeComment: "/**", afterComment: " */" });
     }
     emitBlock(line, f) {
         this.emitLine(line, " {");

package/dist/language/JavaScript.js

@@ -86,7 +86,7 @@ class JavaScriptRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
         return super.makeNameForProperty(c, className, p, jsonName, undefined);
     }
     emitDescriptionBlock(lines) {
-        this.emitCommentLines(lines, " * ", "/**", " */");
+        this.emitCommentLines(lines, { lineStart: " * ", beforeComment: "/**", afterComment: " */" });
     }
     typeMapTypeFor(t) {
         if (["class", "object", "enum"].indexOf(t.kind) >= 0) {
@@ -420,7 +420,7 @@ function r(name${stringAnnotation}) {
     }
     emitSourceStructure() {
         if (this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
         }
         else {
             this.emitUsageComments();

package/dist/language/JavaScriptPropTypes.js

@@ -104,7 +104,7 @@ class JavaScriptPropTypesRenderer extends ConvenienceRenderer_1.ConvenienceRende
             "MyComponent.propTypes = {",
             "  input: MyShape",
             "};"
-        ], "// ");
+        ], { lineStart: "// " });
     }
     emitBlock(source, end, emit) {
         this.emitLine(source, "{");
@@ -200,7 +200,7 @@ class JavaScriptPropTypesRenderer extends ConvenienceRenderer_1.ConvenienceRende
     }
     emitSourceStructure() {
         if (this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
         }
         else {
             this.emitUsageComments();

package/dist/language/Kotlin.js

@@ -163,7 +163,7 @@ class KotlinRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
         return (0, Naming_1.funPrefixNamer)("upper", s => kotlinNameStyle(true, s, (0, Acronyms_1.acronymStyle)(this._kotlinOptions.acronymStyle)));
     }
     emitDescriptionBlock(lines) {
-        this.emitCommentLines(lines, " * ", "/**", " */");
+        this.emitCommentLines(lines, { lineStart: " * ", beforeComment: "/**", afterComment: " */" });
     }
     emitBlock(line, f, delimiter = "curly") {
         const [open, close] = delimiter === "curly" ? ["{", "}"] : delimiter === "paren" ? ["(", ")"] : ["{", "})"];
@@ -200,7 +200,7 @@ class KotlinRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
     }
     emitHeader() {
         if (this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
         }
         else {
             this.emitUsageHeader();

package/dist/language/Objective-C.js

@@ -224,7 +224,7 @@ class ObjectiveCRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
         return type;
     }
     emitDescriptionBlock(lines) {
-        this.emitCommentLines(lines, "/// ");
+        this.emitCommentLines(lines, { lineStart: "/// " });
     }
     emitBlock(line, f) {
         this.emitLine(line, " {");
@@ -665,7 +665,7 @@ class ObjectiveCRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
         if (this._options.features.interface) {
             this.startFile(filename, "h");
             if (this.leadingComments !== undefined) {
-                this.emitCommentLines(this.leadingComments);
+                this.emitComments(this.leadingComments);
             }
             else if (!this._options.justTypes) {
                 this.emitCommentLines(["To parse this JSON:", ""]);

package/dist/language/Php.js

@@ -150,7 +150,7 @@ class PhpRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
     startFile(_basename) {
         this.ensureBlankLine();
         if (!this._haveEmittedLeadingComments && this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
             this.ensureBlankLine();
             this._haveEmittedLeadingComments = true;
         }
@@ -164,7 +164,7 @@ class PhpRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
         this.ensureBlankLine();
     }
     emitDescriptionBlock(lines) {
-        this.emitCommentLines(lines, " * ", "/**", " */");
+        this.emitCommentLines(lines, { lineStart: " * ", beforeComment: "/**", afterComment: " */" });
     }
     emitBlock(line, f) {
         this.emitLine(line, " {");

package/dist/language/Pike.js

@@ -219,7 +219,7 @@ class PikeRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
             "Bear in mind that these functions have unexpected behavior,",
             "and will likely throw an error, if the JSON string does not",
             "match the expected interface, even if the JSON itself is valid."
-        ], "// ");
+        ], { lineStart: "// " });
     }
     emitTopLevelTypedef(t, name) {
         this.emitLine("typedef ", this.sourceFor(t).source, " ", name, ";");

package/dist/language/Python.js

@@ -206,10 +206,14 @@ class PythonRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
                 }
                 return content;
             }, lines[0]);
-            this.emitLine('"""', docstring, '"""');
+            this.emitComments([{ customLines: [docstring], lineStart: '"""', lineEnd: '"""' }]);
         }
         else {
-            this.emitCommentLines(lines, "", undefined, '"""', '"""');
+            this.emitCommentLines(lines, {
+                firstLineStart: '"""',
+                lineStart: "",
+                afterComment: '"""'
+            });
         }
     }
     get needsTypeDeclarationBeforeUse() {
@@ -389,7 +393,7 @@ class PythonRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
         const closingLines = this.gatherSource(() => this.emitClosingCode());
         const supportLines = this.gatherSource(() => this.emitSupportCode());
         if (this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
         }
         this.ensureBlankLine();
         this.emitImports();

package/dist/language/Rust.js

@@ -356,7 +356,7 @@ class RustRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
     }
     emitLeadingComments() {
         if (this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
             return;
         }
         const topLevelName = (0, Support_1.defined)((0, collection_utils_1.mapFirst)(this.topLevels)).getCombinedName();

package/dist/language/Scala3.js

@@ -21,7 +21,7 @@ exports.scala3Options = {
     framework: new RendererOptions_1.EnumOption("framework", "Serialization framework", [
         ["just-types", Framework.None],
         ["circe", Framework.Circe],
-        ["upickle", Framework.Upickle],
+        ["upickle", Framework.Upickle]
     ], undefined),
     packageName: new RendererOptions_1.StringOption("package", "Package", "PACKAGE", "quicktype")
 };
@@ -116,7 +116,10 @@ const keywords = [
  * @param paramName
  */
 const shouldAddBacktick = (paramName) => {
-    return keywords.some(s => paramName === s) || invalidSymbols.some(s => paramName.includes(s)) || !isNaN(+parseFloat(paramName)) || !isNaN(parseInt(paramName.charAt(0)));
+    return (keywords.some(s => paramName === s) ||
+        invalidSymbols.some(s => paramName.includes(s)) ||
+        !isNaN(+parseFloat(paramName)) ||
+        !isNaN(parseInt(paramName.charAt(0))));
 };
 const wrapOption = (s, optional) => {
     if (optional) {
@@ -180,7 +183,7 @@ class Scala3Renderer extends ConvenienceRenderer_1.ConvenienceRenderer {
         return (0, Naming_1.funPrefixNamer)("upper", s => s.replace(" ", "")); // TODO - add backticks where appropriate
     }
     emitDescriptionBlock(lines) {
-        this.emitCommentLines(lines, " * ", "/**", " */");
+        this.emitCommentLines(lines, { lineStart: " * ", beforeComment: "/**", afterComment: " */" });
     }
     emitBlock(line, f, delimiter = "curly") {
         const [open, close] = delimiter === "curly"
@@ -229,7 +232,7 @@ class Scala3Renderer extends ConvenienceRenderer_1.ConvenienceRenderer {
     }
     emitHeader() {
         if (this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
         }
         else {
             this.emitUsageHeader();
@@ -304,7 +307,6 @@ class Scala3Renderer extends ConvenienceRenderer_1.ConvenienceRenderer {
             if (count > 0) {
                 this.emitItem("\t case ");
             }
-            ;
             this.forEachEnumCase(e, "none", (name, jsonName) => {
                 if (!(jsonName == "")) {
                     const backticks = shouldAddBacktick(jsonName) ||
@@ -377,7 +379,7 @@ exports.UpickleRenderer = UpickleRenderer;
 class Smithy4sRenderer extends Scala3Renderer {
     emitHeader() {
         if (this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
         }
         else {
             this.emitUsageHeader();
@@ -404,20 +406,20 @@ class Smithy4sRenderer extends Scala3Renderer {
         this.emitItem(["enum ", enumName, " { "]);
         let count = e.cases.size;
         this.forEachEnumCase(e, "none", (name, jsonName) => {
-            // if (!(jsonName == "")) { 
+            // if (!(jsonName == "")) {
             /*                 const backticks =
                                 shouldAddBacktick(jsonName) ||
                                 jsonName.includes(" ") ||
                                 !isNaN(parseInt(jsonName.charAt(0)))
                             if (backticks) {this.emitItem("`")} else  */
             this.emitLine();
-            this.emitItem([name, " = \"", jsonName, "\""]);
+            this.emitItem([name, ' = "', jsonName, '"']);
             //                if (backticks) {this.emitItem("`")}
             if (--count > 0)
                 this.emitItem([","]);
             //} else {
             //--count
-            //} 
+            //}
         });
         this.ensureBlankLine();
         this.emitItem(["}"]);
@@ -466,13 +468,13 @@ class CirceRenderer extends Scala3Renderer {
                                 jsonName.includes(" ") ||
                                 !isNaN(parseInt(jsonName.charAt(0)))
                             if (backticks) {this.emitItem("`")} else  */
-            this.emitItem(["\"", jsonName, "\""]);
+            this.emitItem(['"', jsonName, '"']);
             //                if (backticks) {this.emitItem("`")}
             if (--count > 0)
                 this.emitItem([" | "]);
             //} else {
             //--count
-            //} 
+            //}
         });
         this.ensureBlankLine();
     }
@@ -493,13 +495,29 @@ class CirceRenderer extends Scala3Renderer {
     emitTopLevelArray(t, name) {
         super.emitTopLevelArray(t, name);
         const elementType = this.scalaType(t.items);
-        this.emitLine(["given (using ev : ", elementType, "): Encoder[Map[String,", elementType, "]] = Encoder.encodeMap[String, ", elementType, "]"]);
+        this.emitLine([
+            "given (using ev : ",
+            elementType,
+            "): Encoder[Map[String,",
+            elementType,
+            "]] = Encoder.encodeMap[String, ",
+            elementType,
+            "]"
+        ]);
     }
     emitTopLevelMap(t, name) {
         super.emitTopLevelMap(t, name);
         const elementType = this.scalaType(t.values);
         this.ensureBlankLine();
-        this.emitLine(["given (using ev : ", elementType, "): Encoder[Map[String, ", elementType, "]] = Encoder.encodeMap[String, ", elementType, "]"]);
+        this.emitLine([
+            "given (using ev : ",
+            elementType,
+            "): Encoder[Map[String, ",
+            elementType,
+            "]] = Encoder.encodeMap[String, ",
+            elementType,
+            "]"
+        ]);
     }
     emitUnionDefinition(u, unionName) {
         function sortBy(t) {
@@ -536,7 +554,7 @@ class CirceRenderer extends Scala3Renderer {
             this.indent(() => {
                 this.emitLine(["List[Decoder[", unionName, "]]("]);
                 this.indent(() => {
-                    sourceLikeTypes.forEach((t) => {
+                    sourceLikeTypes.forEach(t => {
                         this.emitLine(["Decoder[", t[0], "].widen,"]);
                     });
                 });
@@ -548,7 +566,14 @@ class CirceRenderer extends Scala3Renderer {
             this.indent(() => {
                 sourceLikeTypes.forEach((t, i) => {
                     const paramTemp = `enc${i.toString()}`;
-                    this.emitLine(["case ", paramTemp, " : ", t[0], " => ", this.circeEncoderForType(t[1], false, false, paramTemp)]);
+                    this.emitLine([
+                        "case ",
+                        paramTemp,
+                        " : ",
+                        t[0],
+                        " => ",
+                        this.circeEncoderForType(t[1], false, false, paramTemp)
+                    ]);
                 });
             });
             this.emitLine("}");

package/dist/language/Smithy4s.js

@@ -16,9 +16,7 @@ var Framework;
     Framework[Framework["None"] = 0] = "None";
 })(Framework = exports.Framework || (exports.Framework = {}));
 exports.SmithyOptions = {
-    framework: new RendererOptions_1.EnumOption("framework", "Serialization framework", [
-        ["just-types", Framework.None]
-    ], undefined),
+    framework: new RendererOptions_1.EnumOption("framework", "Serialization framework", [["just-types", Framework.None]], undefined),
     packageName: new RendererOptions_1.StringOption("package", "Package", "PACKAGE", "quicktype")
 };
 // Use backticks for param names with symbols
@@ -102,7 +100,10 @@ const keywords = [
  * @param paramName
  */
 const shouldAddBacktick = (paramName) => {
-    return keywords.some(s => paramName === s) || invalidSymbols.some(s => paramName.includes(s)) || !isNaN(parseFloat(paramName)) || !isNaN(parseInt(paramName.charAt(0)));
+    return (keywords.some(s => paramName === s) ||
+        invalidSymbols.some(s => paramName.includes(s)) ||
+        !isNaN(parseFloat(paramName)) ||
+        !isNaN(parseInt(paramName.charAt(0))));
 };
 function isPartCharacter(codePoint) {
     return (0, Strings_1.isLetterOrUnderscore)(codePoint) || (0, Strings_1.isNumeric)(codePoint);
@@ -150,7 +151,7 @@ class Smithy4sRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
         return (0, Naming_1.funPrefixNamer)("upper", s => s.replace(" ", "")); // TODO - add backticks where appropriate
     }
     emitDescriptionBlock(lines) {
-        this.emitCommentLines(lines, " * ", "/**", " */");
+        this.emitCommentLines(lines, { lineStart: " * ", beforeComment: "/**", afterComment: " */" });
     }
     emitBlock(line, f, delimiter = "curly") {
         const [open, close] = delimiter === "curly"
@@ -199,13 +200,13 @@ class Smithy4sRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
     }
     emitHeader() {
         if (this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
         }
         else {
             this.emitUsageHeader();
         }
         this.ensureBlankLine();
-        this.emitLine("$version: \"2\"");
+        this.emitLine('$version: "2"');
         this.emitLine("namespace ", this._scalaOptions.packageName);
         this.ensureBlankLine();
         this.emitLine("document NullValue");
@@ -279,9 +280,21 @@ class Smithy4sRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
                 return;
             }
             (0, TypeUtils_1.matchCompoundType)(p.type, at => {
-                this.emitLine(["list ", this.scalaType(at, true), "{ member: ", this.scalaType(at.items, true), "}"]);
+                this.emitLine([
+                    "list ",
+                    this.scalaType(at, true),
+                    "{ member: ",
+                    this.scalaType(at.items, true),
+                    "}"
+                ]);
             }, ignore, mt => {
-                this.emitLine(["map ", this.scalaType(mt, true), "{ key: String , value: ", this.scalaType(mt.values, true), "}"]);
+                this.emitLine([
+                    "map ",
+                    this.scalaType(mt, true),
+                    "{ key: String , value: ",
+                    this.scalaType(mt.values, true),
+                    "}"
+                ]);
             }, ignore, ignore);
         });
     }
@@ -291,20 +304,20 @@ class Smithy4sRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
         this.emitItem(["enum ", enumName, " { "]);
         let count = e.cases.size;
         this.forEachEnumCase(e, "none", (name, jsonName) => {
-            // if (!(jsonName == "")) { 
+            // if (!(jsonName == "")) {
             /*                 const backticks =
-                                shouldAddBacktick(jsonName) ||
-                                jsonName.includes(" ") ||
-                                !isNaN(parseInt(jsonName.charAt(0)))
-                            if (backticks) {this.emitItem("`")} else  */
+                                    shouldAddBacktick(jsonName) ||
+                                    jsonName.includes(" ") ||
+                                    !isNaN(parseInt(jsonName.charAt(0)))
+                                if (backticks) {this.emitItem("`")} else  */
             this.emitLine();
-            this.emitItem([name, " = \"", jsonName, "\""]);
+            this.emitItem([name, ' = "', jsonName, '"']);
             //                if (backticks) {this.emitItem("`")}
             if (--count > 0)
                 this.emitItem([","]);
             //} else {
             //--count
-            //} 
+            //}
         });
         this.ensureBlankLine();
         this.emitItem(["}"]);
@@ -343,9 +356,21 @@ class Smithy4sRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
                 return;
             }
             (0, TypeUtils_1.matchCompoundType)(p, at => {
-                this.emitLine(["list ", this.scalaType(at, true), "{ member: ", this.scalaType(at.items, true), "}"]);
+                this.emitLine([
+                    "list ",
+                    this.scalaType(at, true),
+                    "{ member: ",
+                    this.scalaType(at.items, true),
+                    "}"
+                ]);
             }, ignore, mt => {
-                this.emitLine(["map ", this.scalaType(mt, true), "{ key: String , value: ", this.scalaType(mt.values, true), "}"]);
+                this.emitLine([
+                    "map ",
+                    this.scalaType(mt, true),
+                    "{ key: String , value: ",
+                    this.scalaType(mt.values, true),
+                    "}"
+                ]);
             }, ignore, ignore);
         });
     }

package/dist/language/Swift.js

@@ -558,7 +558,7 @@ class SwiftRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
         return kind === "array" || kind === "map";
     }
     emitDescriptionBlock(lines) {
-        this.emitCommentLines(lines, "/// ");
+        this.emitCommentLines(lines, { lineStart: "/// " });
     }
     emitBlock(line, f) {
         this.emitLine(line, " {");
@@ -631,7 +631,7 @@ class SwiftRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
     }
     renderHeader(type, name) {
         if (this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
         }
         else if (!this._options.justTypes) {
             if (this._options.multiFileOutput) {

package/dist/language/TypeScriptEffectSchema.js

@@ -147,7 +147,7 @@ class TypeScriptEffectSchemaRenderer extends ConvenienceRenderer_1.ConvenienceRe
     }
     emitSourceStructure() {
         if (this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
         }
         this.emitImports();
         this.emitSchemas();

package/dist/language/TypeScriptZod.js

@@ -152,7 +152,7 @@ class TypeScriptZodRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
     }
     emitSourceStructure() {
         if (this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
         }
         this.emitImports();
         this.emitSchemas();

package/dist/language/ruby/index.js

@@ -494,7 +494,7 @@ class RubyRenderer extends ConvenienceRenderer_1.ConvenienceRenderer {
     }
     emitSourceStructure() {
         if (this.leadingComments !== undefined) {
-            this.emitCommentLines(this.leadingComments);
+            this.emitComments(this.leadingComments);
         }
         else if (!this._options.justTypes) {
             this.emitLine("# This code may look unusually verbose for Ruby (and it is), but");

package/dist/support/Comments.d.ts

@@ -0,0 +1,21 @@
+import { Sourcelike } from "../Source";
+export type CommentOptions = {
+    lineStart?: string;
+    lineEnd?: string;
+    beforeComment?: string;
+    afterComment?: string;
+    firstLineStart?: string;
+};
+type DescriptionBlockCommentConfig = {
+    descriptionBlock: Sourcelike[];
+};
+type InlineCommentConfig = {
+    lines: Sourcelike[];
+};
+type CustomCommentConfig = CommentOptions & {
+    customLines: Sourcelike[];
+};
+export type CommentConfig = DescriptionBlockCommentConfig | InlineCommentConfig | CustomCommentConfig;
+export type Comment = string | CommentConfig;
+export declare const isStringComment: (comment: Comment) => comment is string;
+export {};

package/dist/support/Comments.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isStringComment = void 0;
+const isStringComment = (comment) => {
+    return typeof comment === "string";
+};
+exports.isStringComment = isStringComment;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "quicktype-core",
-    "version": "23.0.94",
+    "version": "23.0.96",
     "description": "The quicktype engine as a library",
     "license": "Apache-2.0",
     "main": "dist/index.js",