fix: Fix comment generation (#58)

* Deal with */ in JSDoc values

* Update plugins/typescript/src/core/schemaToTypeAliasDeclaration.ts

Co-authored-by: Arnold Trakhtenberg <[email protected]>

Co-authored-by: Arnold Trakhtenberg <[email protected]>

Author: fabien0102

plugins/typescript/src/core/schemaToTypeAliasDeclaration.test.ts

@@ -78,6 +78,40 @@ describe("schemaToTypeAliasDeclaration", () => {
     expect(printSchema(schema)).toBe(`export type Test = 1 | 2 | 3;`);
   });
 
+  it("should skip example which contains `*/` to avoid confusion", () => {
+    const schema: SchemaObject = {
+      title: "CronTimingCreate",
+      required: ["type", "cron_expression"],
+      type: "object",
+      properties: {
+        cron_expression: {
+          title: "Cron Expression",
+          type: "string",
+          description: "The string representing the timing's cron expression.",
+          format: "cron-string",
+          example: "*/5 * * * *", // `*/` is conflicting the multiline comment syntax
+        },
+      },
+      additionalProperties: false,
+      description: "Cron timing schema for create requests.",
+    };
+
+    expect(printSchema(schema)).toMatchInlineSnapshot(`
+      "/**
+       * Cron timing schema for create requests.
+       */
+      export type Test = {
+          /*
+           * The string representing the timing's cron expression.
+           *
+           * @format cron-string
+           * @example [see original specs]
+           */
+          cron_expression: string;
+      };"
+    `);
+  });
+
   it("should generate top-level documentation", () => {
     const schema: SchemaObject = {
       type: "null",

plugins/typescript/src/core/schemaToTypeAliasDeclaration.ts

@@ -544,6 +544,29 @@ const getJSDocComment = (
       }, schema)
     : schema;
 
+  const getJsDocIdentifier = (value: unknown) => {
+    const multilineEndChar = "*/";
+
+    if (typeof value === "string" && !value.includes(multilineEndChar)) {
+      return f.createIdentifier(value);
+    }
+
+    if (
+      typeof value === "object" &&
+      !JSON.stringify(value).includes(multilineEndChar)
+    ) {
+      return f.createIdentifier(JSON.stringify(value));
+    }
+
+    if (typeof value === "boolean" || typeof value === "number") {
+      return f.createIdentifier(value.toString());
+    }
+
+    // Value is not stringifiable
+    // See https://github.com/fabien0102/openapi-codegen/issues/36, https://github.com/fabien0102/openapi-codegen/issues/57
+    return f.createIdentifier("[see original specs]");
+  };
+
   const propertyTags: ts.JSDocPropertyTag[] = [];
   Object.entries(schemaWithAllOfResolved)
     .filter(
@@ -557,7 +580,7 @@ const getJSDocComment = (
           propertyTags.push(
             f.createJSDocPropertyTag(
               f.createIdentifier(singular(key)),
-              f.createIdentifier(v.toString()),
+              getJsDocIdentifier(v),
               false
             )
           )
@@ -566,11 +589,7 @@ const getJSDocComment = (
         propertyTags.push(
           f.createJSDocPropertyTag(
             f.createIdentifier(key),
-            f.createIdentifier(
-              typeof value === "object"
-                ? JSON.stringify(value)
-                : value.toString()
-            ),
+            getJsDocIdentifier(value),
             false
           )
         );