fix: JSDoc generation (#92)

Author: needim

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

@@ -101,7 +101,7 @@ describe("schemaToTypeAliasDeclaration", () => {
        * Cron timing schema for create requests.
        */
       export type Test = {
-          /*
+          /**
            * The string representing the timing's cron expression.
            *
            * @format cron-string
@@ -202,13 +202,13 @@ describe("schemaToTypeAliasDeclaration", () => {
        * An object
        */
       export type Test = {
-          /*
+          /**
            * I’m a foo
            *
            * @default boom
            */
           foo: string;
-          /*
+          /**
            * @minimum 0
            * @maximum 42
            */
@@ -273,19 +273,19 @@ describe("schemaToTypeAliasDeclaration", () => {
        * An object
        */
       export type Test = {
-          /*
+          /**
            * I’m a foo
            *
            * @default boom
            */
           foo: {
-              /*
+              /**
                * @minimum 0
                * @maximum 42
                */
               bar?: number;
               baz?: {
-                  /*
+                  /**
                    * @default yeah
                    */
                   oh?: string;
@@ -690,7 +690,7 @@ describe("schemaToTypeAliasDeclaration", () => {
          * A nice top-level description
          */
         export type Test = {
-            /*
+            /**
              * A nice description for foo
              */
             foo?: string;
@@ -793,66 +793,66 @@ describe("schemaToTypeAliasDeclaration", () => {
 
       expect(printSchema(schema)).toMatchInlineSnapshot(`
         "export type Test = {
-            /*
+            /**
              * Description of the gist
              *
              * @example Example Ruby script
              */
             description: string;
-            /*
+            /**
              * Names of files to be updated
              *
              * @example {\\"hello.rb\\":{\\"content\\":\\"blah\\",\\"filename\\":\\"goodbye.rb\\"}}
              */
             files?: {
                 [key: string]: {
-                    /*
+                    /**
                      * The new content of the file
                      */
                     content: string;
-                    /*
+                    /**
                      * The new filename for the file
                      */
                     filename?: string | null;
                 } | {
-                    /*
+                    /**
                      * The new content of the file
                      */
                     content?: string;
-                    /*
+                    /**
                      * The new filename for the file
                      */
                     filename: string | null;
                 } | {} | null;
             };
         } | {
-            /*
+            /**
              * Description of the gist
              *
              * @example Example Ruby script
              */
             description?: string;
-            /*
+            /**
              * Names of files to be updated
              *
              * @example {\\"hello.rb\\":{\\"content\\":\\"blah\\",\\"filename\\":\\"goodbye.rb\\"}}
              */
             files: {
                 [key: string]: {
-                    /*
+                    /**
                      * The new content of the file
                      */
                     content: string;
-                    /*
+                    /**
                      * The new filename for the file
                      */
                     filename?: string | null;
                 } | {
-                    /*
+                    /**
                      * The new content of the file
                      */
                     content?: string;
-                    /*
+                    /**
                      * The new filename for the file
                      */
                     filename: string | null;

plugins/typescript/src/core/schemaToTypeAliasDeclaration.ts

@@ -638,7 +638,7 @@ const addJSDocToNode = (node: ts.Node, jsDocComment: ts.JSDoc) => {
   ts.addSyntheticLeadingComment(
     node,
     ts.SyntaxKind.MultiLineCommentTrivia,
-    jsDocString,
+    "*" + jsDocString, // https://github.com/microsoft/TypeScript/issues/17146
     true
   );
 };

plugins/typescript/src/generators/generateReactQueryComponents.test.ts

@@ -205,11 +205,11 @@ describe("generateReactQueryComponents", () => {
       import type * as Schemas from \\"./petstoreSchemas\\";
 
       export type ListPetsQueryParams = {
-          /*
+          /**
            * Filter on the dog breed
            */
           breed: string;
-          /*
+          /**
            * Color of the dog
            */
           color?: \\"white\\" | \\"black\\" | \\"grey\\";
@@ -327,14 +327,14 @@ describe("generateReactQueryComponents", () => {
       import type * as Schemas from \\"./petstoreSchemas\\";
 
       export type ListPetsQueryParams = {
-          /*
+          /**
            * Color of the dog
            */
           color?: \\"white\\" | \\"black\\" | \\"grey\\";
       };
 
       export type ListPetsHeaders = {
-          /*
+          /**
            * Filter on the dog breed
            */
           breed?: string;

plugins/typescript/src/generators/generateSchemaTypes.test.ts

@@ -142,7 +142,7 @@ describe("generateSchemaTypes", () => {
          * A new pet.
          */
         export type Pet = NewPet & {
-            /*
+            /**
              * @format int64
              */
             id: number;
@@ -185,7 +185,7 @@ describe("generateSchemaTypes", () => {
          * An error :(
          */
         export type Error = {
-            /*
+            /**
              * @format int32
              */
             code: number;