fix: 对象属性未生成注释

Author: geekact

package.json

@@ -55,7 +55,7 @@
   "homepage": "https://foca.js.org",
   "license": "MIT",
   "volta": {
-    "node": "18.19.0",
+    "node": "20.13.0",
     "pnpm": "9.5.0"
   },
   "packageManager": "[email protected]",

src/lib/parse-parameters.ts

@@ -1,7 +1,7 @@
 import type { OpenAPIV3 } from 'openapi-types';
 import { refToObject } from './ref-to-object';
 import { generateComments } from './generate-comments';
-import { parseSchemaType } from './parse-schema-type';
+import { parseSchemaType } from './parse-schema';
 
 export const parseParameters = (
   docs: OpenAPIV3.Document,

src/lib/parse-request-body.ts

@@ -1,5 +1,5 @@
 import type { OpenAPIV3 } from 'openapi-types';
-import { parseSchemaType } from './parse-schema-type';
+import { parseSchemaType } from './parse-schema';
 import { refToObject } from './ref-to-object';
 
 export const parseRequestBody = (

src/lib/parse-response.ts

@@ -1,5 +1,5 @@
 import type { OpenAPIV3 } from 'openapi-types';
-import { parseSchemaType } from './parse-schema-type';
+import { parseSchemaType } from './parse-schema';
 import { refToObject } from './ref-to-object';
 
 export const parseResponse = (

src/lib/parse-schema-type.ts renamed to src/lib/parse-schema.ts

@@ -1,5 +1,6 @@
 import type { OpenAPIV3 } from 'openapi-types';
 import { refToObject } from './ref-to-object';
+import { generateComments } from './generate-comments';
 
 export const parseSchemaType = (
   docs: OpenAPIV3.Document,
@@ -18,7 +19,8 @@ export const parseSchemaType = (
     case 'object':
       const requiredProperties = parsed.required || [];
       const properties = Object.entries(parsed.properties || {}).map(([key, schema]) => {
-        return `${key}${requiredProperties.includes(key) ? '' : '?'}: ${parseSchemaType(docs, schema)}`;
+        const schemaObj = refToObject(docs, schema);
+        return `${generateComments(schemaObj)}${key}${requiredProperties.includes(key) ? '' : '?'}: ${parseSchemaType(docs, schemaObj)}`;
       });
       return `{ ${properties.join(';')} }`;
     case 'string':

test/lib/parse-parameters.test.ts

@@ -169,3 +169,38 @@ test('所有结构都不是必填时，optional=true', () => {
     }
   `);
 });
+
+test('包含描述', () => {
+  const docs = getBasicDocument({
+    '/': {
+      get: {
+        parameters: [
+          {
+            name: 'foo',
+            in: 'query',
+            required: false,
+            description: 'foo-bar',
+            deprecated: true,
+            schema: { type: 'string' },
+          },
+        ],
+        responses: {},
+      },
+    },
+  });
+  const result = parseParameters(docs, docs.paths['/']!, docs.paths['/']!.get!, 'query');
+  expect(result).toMatchInlineSnapshot(`
+    {
+      "optional": true,
+      "types": [
+        "{ 
+    /**
+    * foo-bar
+    * @deprecated 
+    */
+    foo?: string
+           }",
+      ],
+    }
+  `);
+});

test/lib/parse-schema.test.ts

@@ -1,5 +1,5 @@
 import { expect, test } from 'vitest';
-import { parseSchemaType } from '../../src/lib/parse-schema-type';
+import { parseSchemaType } from '../../src/lib/parse-schema';
 import { getBasicDocument } from '../mocks/get-basic-document';
 
 const docs = getBasicDocument();
@@ -40,6 +40,20 @@ test('对象', () => {
   expect(type).toMatchInlineSnapshot(`"{ foo?: string }"`);
 });
 
+test('对象属性包含描述', () => {
+  const type = parseSchemaType(docs, {
+    type: 'object',
+    properties: { foo: { type: 'string', description: 'foo=bar' } },
+  });
+  expect(type).toMatchInlineSnapshot(`
+    "{ 
+    /**
+    * foo=bar 
+    */
+    foo?: string }"
+  `);
+});
+
 test('空对象', () => {
   const type = parseSchemaType(docs, { type: 'object' });
   expect(type).toMatchInlineSnapshot(`"{  }"`);