test: 优化 jsDoc 多行显示

Author: cloudcome

TODO.md

@@ -11,4 +11,4 @@
 - [ ] 3.1 的完全支持 https://www.apimatic.io/blog/2021/09/migrating-to-and-from-openapi-3-1
 - [ ] 支持 query 多参格式 https://swagger.io/docs/specification/serialization/
 - [ ] 支持忽略未显式在 path 中的参数
-- [ ] 修正单值 JSDOC 位置 status: /**...*/ type -> /**...*/ status: type
+- [ ] 修正单根值类型提升

test/example-dest/3.0/pet-store.ts

@@ -3,13 +3,13 @@
  * @version 1.0.19
  * @contact <apiteam@swagger.io>
  * @description This is a sample Pet Store Server based on the OpenAPI 3.0 specification.  You can find out more about
-Swagger at [http://swagger.io](http://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!
-You can now help us improve the API whether it's by making changes to the definition itself or to the code.
-That way, with time, we can improve the API in general, and expose some of the new features in OAS3.
-
-Some useful links:
-- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)
-- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)
+ * Swagger at [http://swagger.io](http://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!
+ * You can now help us improve the API whether it's by making changes to the definition itself or to the code.
+ * That way, with time, we can improve the API in general, and expose some of the new features in OAS3.
+ * 
+ * Some useful links:
+ * - [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)
+ * - [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)
  */
 
 import axios from "axios";

test/example-dest/3.1/pet-store.ts

@@ -3,8 +3,8 @@
  * @version 1.0.6
  * @contact <apiteam@swagger.io>
  * @description This is a sample Pet Store Server based on the OpenAPI 3.1 specification.
-You can find out more about
-Swagger at [http://swagger.io](http://swagger.io).
+ * You can find out more about
+ * Swagger at [http://swagger.io](http://swagger.io).
  * @summary Pet Store 3.1
  * @see {@link http://swagger.io Find out more about Swagger}
  */

test/printer/arg.test.ts

@@ -0,0 +1,62 @@
+import { Printer } from '../../src/printer';
+
+test('top', () => {
+    const printer = new Printer({
+        openapi: '3.1.0',
+        info: {
+            title: 'test',
+            version: '1.0.0',
+        },
+        paths: {
+            '/': {
+                get: {
+                    deprecated: true,
+                    description: 'aaa\nbbb\nccc',
+                    summary: 'test1',
+                    operationId: 'test2',
+                    requestBody: {
+                        content: {
+                            '*': {
+                                schema: {
+                                    type: 'string',
+                                    description: 'test4',
+                                    deprecated: true,
+                                    default: 'test5',
+                                    example: 'test6',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    });
+
+    expect(
+        printer.print({
+            hideImports: true,
+            hideHeaders: true,
+            hideFooters: true,
+            hideInfo: true,
+            hideHelpers: true,
+        }),
+    ).toMatchInlineSnapshot(`
+      "/**
+       * @deprecated
+       * @description aaa
+       * bbb
+       * ccc
+       * @summary test1
+       * @param data test4
+       * @param [config] request config
+       */
+      export async function test2(data:string,config?:AxiosRequestConfig): AxiosPromise<unknown> {
+          return axios({
+              method: "get",
+              url: \`/\`,
+      data: data,
+      ...config
+          });
+      }"
+    `);
+});

test/printer/jsdoc.test.ts

@@ -0,0 +1,42 @@
+import { JsDoc } from '../../src/printer/JsDoc';
+
+test('multiple', () => {
+    const jsDoc = new JsDoc([
+        {
+            name: 't1',
+        },
+        {
+            name: 't2',
+            description: 't2 description',
+        },
+        {
+            name: 't3',
+            description: 't3 description 1\n\nt3 description 2',
+            externalDocs: {
+                url: 'https://example.com',
+                description: 'external docs 1\nexternal docs 2',
+            },
+        },
+    ]);
+    jsDoc.addComments({
+        description: 'aaa\nbbb\nccc',
+        deprecated: true,
+        summary: 'summary',
+        tags: ['t1', 't2', 't3'],
+    });
+    expect(jsDoc.print()).toMatchInlineSnapshot(`
+      "/**
+       * @description aaa
+       * bbb
+       * ccc
+       * @deprecated
+       * @summary summary
+       * @see t1 
+       * @see t2 t2 description
+       * @see t3 t3 description 1
+       * 
+       * t3 description 2 {@link https://example.com external docs 1
+       * external docs 2}
+       */"
+    `);
+});

test/schemas/nullable.test.ts

@@ -41,7 +41,7 @@ test('nullable + array', () => {
     // console.log(type);
     expect(type).toMatchInlineSnapshot(`
       "{
-      "t0":((T1[])|(null));
+      "t0":((Array<T1>)|(null));
       }"
     `);
 });