feat: 1. 新增通过 code 生成 jsonschema

2. 修复解析泛型不成功问题

Author: wangw19

README.md

@@ -1,6 +1,6 @@
 # fast-typescript-to-jsonschema
 
-[![npm version](https://img.shields.io/npm/v/fast-typescript-to-jsonschema.svg)](https://www.npmjs.com/package/fast-typescript-to-jsonschema) 
+[![npm version](https://img.shields.io/npm/v/fast-typescript-to-jsonschema.svg)](https://www.npmjs.com/package/fast-typescript-to-jsonschema)
 ![Test](https://github.com/yunke-yunfly/fast-typescript-to-jsonschema/workflows/Test/badge.svg)
 [![codecov](https://codecov.io/gh/yunke-yunfly/fast-typescript-to-jsonschema/branch/master/graph/badge.svg)](https://app.codecov.io/gh/yunke-yunfly/fast-typescript-to-jsonschema)
 
@@ -33,6 +33,8 @@ interface ITest {
 
 3. create `test.js`
 
+3.1. gen jsonschema from file.
+
 ```js
 const { default: genTypeSchema } = require('fast-typescript-to-jsonschema');
 const path = require('path');
@@ -53,6 +55,31 @@ const jsonSchema = genTypeSchema.getJsonSchema(file, 'ITest');
 console.log(jsonSchema); 
 ```
 
+3.2. gen jsonschema from code.
+
+```js
+const { default: genTypeSchema } = require('fast-typescript-to-jsonschema');
+
+const code = `
+interface ITest {
+  attr1: string;
+  attr2: number;
+  attr3?: boolean;
+}
+`
+// generate data
+genTypeSchema.genJsonDataFromCode(code);
+
+// get all jsonschema data of current file
+const json = genTypeSchema.genJsonData();
+
+// get jsonschema of specific type
+const jsonSchema = genTypeSchema.getJsonSchema('ITest');
+
+// result
+console.log(jsonSchema); 
+```
+
 4. execute script
 
 ```js
@@ -161,7 +188,7 @@ result:
   - [1.2 Named Export Modules](docs/module.en-US.md#12-named-export-modules)
 - [Extending Types](docs/extends.en-US.md#extending-types)
   - [1.1 Basic Extending Types](docs/extends.en-US.md#11-basic-extending-types)
-  - [1.2 Multiple Extending Types ](docs/extends.en-US.md#12-multiple-extending-types)
+  - [1.2 Multiple Extending Types](docs/extends.en-US.md#12-multiple-extending-types)
 - [Enums](docs/enum.en-US.md#enums)
   - [1.1 Numeric Enums](docs/enum.en-US.md#11-numeric-enums)
   - [1.2 String Enums](docs/enum.en-US.md#12-string-enums)

README.zh-cn.md

@@ -1,6 +1,6 @@
 # fast-typescript-to-jsonschema
 
-[![npm version](https://img.shields.io/npm/v/fast-typescript-to-jsonschema.svg)](https://www.npmjs.com/package/fast-typescript-to-jsonschema) 
+[![npm version](https://img.shields.io/npm/v/fast-typescript-to-jsonschema.svg)](https://www.npmjs.com/package/fast-typescript-to-jsonschema)
 ![Test](https://github.com/yunke-yunfly/fast-typescript-to-jsonschema/workflows/Test/badge.svg)
 [![codecov](https://codecov.io/gh/yunke-yunfly/fast-typescript-to-jsonschema/branch/master/graph/badge.svg)](https://app.codecov.io/gh/yunke-yunfly/fast-typescript-to-jsonschema)
 
@@ -31,7 +31,9 @@ interface ITest {
 }
 ```
 
-3.创建`test.js`文件，内容如下:
+3. 创建`test.js`文件，内容如下:
+
+3.1 通过文件生成 jsonschema
 
 ```js
 const { default: genTypeSchema } = require('fast-typescript-to-jsonschema');
@@ -53,6 +55,31 @@ const jsonSchema = genTypeSchema.getJsonSchema(file, 'ITest');
 console.log(jsonSchema); 
 ```
 
+3.2 通过 code 生成 jsonschema
+
+```js
+const { default: genTypeSchema } = require('fast-typescript-to-jsonschema');
+
+const code = `
+interface ITest {
+  attr1: string;
+  attr2: number;
+  attr3?: boolean;
+}
+`
+// generate data
+genTypeSchema.genJsonDataFromCode(code);
+
+// get all jsonschema data of current file
+const json = genTypeSchema.genJsonData();
+
+// get jsonschema of specific type
+const jsonSchema = genTypeSchema.getJsonSchema('ITest');
+
+// result
+console.log(jsonSchema); 
+```
+
 4.执行脚本
 
 ```js
@@ -84,7 +111,7 @@ node ./test.js
 ```
 
 - example 案例地址：
-https://github.com/yunke-yunfly/fast-typescript-to-jsonschema/tree/master/example
+<https://github.com/yunke-yunfly/fast-typescript-to-jsonschema/tree/master/example>
 
 ## 注释
 
@@ -141,7 +168,6 @@ interface Interface_4 {
 }
 ```
 
-
 > 更多支持的类型解析[请看](docs/index.md),目录如下:
 
 - [接口](docs/interface.md)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fast-typescript-to-jsonschema",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "fast-typescript-to-jsonschema generates JSON Schema files from your Typescript sources.",
   "main": "./dist/index.js",
   "typings": "dist/index.d.ts",

src/__tests__/__snapshots__/generic.test.ts.snap

@@ -34,6 +34,76 @@ Object {
 }
 `;
 
+exports[`Generic多层对象_类型_2 1`] = `
+Object {
+  "additionalProperties": false,
+  "definitions": Object {
+    "Generic_8<string>": Object {
+      "additionalProperties": false,
+      "properties": Object {
+        "value1": Object {
+          "additionalProperties": false,
+          "properties": Object {
+            "value2": Object {
+              "additionalProperties": false,
+              "properties": Object {
+                "value3": Object {
+                  "type": "string",
+                },
+              },
+              "required": Array [
+                "value3",
+              ],
+              "type": "object",
+            },
+          },
+          "required": Array [
+            "value2",
+          ],
+          "type": "object",
+        },
+      },
+      "required": Array [
+        "value1",
+      ],
+      "type": "object",
+    },
+  },
+  "properties": Object {
+    "value": Object {
+      "items": Object {
+        "$realRef": "Generic_8",
+        "$ref": "#/definitions/Generic_8<string>",
+      },
+      "type": "array",
+    },
+  },
+  "required": Array [
+    "value",
+  ],
+  "type": "object",
+}
+`;
+
+exports[`Generic多层对象_类型_3 1`] = `
+Object {
+  "additionalProperties": false,
+  "definitions": Object {},
+  "properties": Object {
+    "value": Object {
+      "items": Object {
+        "type": "string",
+      },
+      "type": "array",
+    },
+  },
+  "required": Array [
+    "value",
+  ],
+  "type": "object",
+}
+`;
+
 exports[`Generic引用别的文件_类型_1 1`] = `
 Object {
   "additionalProperties": false,

src/__tests__/generic.test.ts

@@ -38,6 +38,15 @@ test('Generic多层对象_类型_1', () => {
   expect(getSchema('Generic_9')).toMatchSnapshot();
 });
 
+test('Generic多层对象_类型_2', () => {
+  expect(getSchema('Generic_11')).toMatchSnapshot();
+});
+
+test('Generic多层对象_类型_3', () => {
+  expect(getSchema('Generic_13')).toMatchSnapshot();
+});
+
 test('Generic引用别的文件_类型_1', () => {
   expect(getSchema('Generic_10')).toMatchSnapshot();
-});
+});
+

src/get-jsonschema-from-data.ts

@@ -34,10 +34,18 @@ export default class genTypeSchema extends typescriptToFileDatas {
     file: string,
     type: string,
     entry?: { keySet: Set<string>; refKeyTime: Record<string, number> },
+    isLast?: boolean
   ): AnyOption {
     if (!entry) {
       entry = { keySet: new Set(), refKeyTime: {} };
     }
+
+    // 支持输入的是 code 场景
+    if (file && !type) {
+      type = file;
+      file = 'index.ts';
+    }
+
     if (!file || !type) return { type: 'object' };
 
     // 处理 Param.C.D.E.F.GetBaseDetailResponse 这种外部导入路径
@@ -60,8 +68,13 @@ export default class genTypeSchema extends typescriptToFileDatas {
           refFile,
           typeJson.from ? type.replace(/.+?(?=\.)|.+/, typeJson.from) : type,
           entry,
+          true,
         );
 
+        if (!isLast && typeJson.typeParams) {
+          delete typeJson.typeParams
+        }
+
         return typeJson;
       }
     }
@@ -85,6 +98,11 @@ export default class genTypeSchema extends typescriptToFileDatas {
       }
       typeJson.definitions[type] = cloneTypeJson;
     }
+
+    if (!isLast && typeJson.typeParams) {
+      delete typeJson.typeParams
+    }
+
     return typeJson;
   }
 
@@ -200,7 +218,7 @@ export default class genTypeSchema extends typescriptToFileDatas {
         // 别的文件ref
         if (realRef.$ref && realRef.type !== ImportType.ImportNamespaceSpecifier) {
           const refFile = realRef.$ref.replace(/#\/definitions|#/, '');
-          const realSchema = this.getJsonSchema(refFile, result.$realRef);
+          const realSchema = this.getJsonSchema(refFile, result.$realRef, undefined, true);
           delete realRef.$ref;
           delete realRef.from;
           Object.assign(realRef, realSchema);
@@ -280,10 +298,10 @@ export default class genTypeSchema extends typescriptToFileDatas {
 
     // 处理继承
     const handleExtends = (item: AnyOption) => {
-      const newTypeJson = this.getJsonSchema(file as string, item.extends, entry);
+      const newTypeJson = this.getJsonSchema(file as string, item.extends, entry, true);
       if (newTypeJson) {
         const result = newTypeJson.$ref
-          ? this.getJsonSchema(newTypeJson.$ref.replace(/#/g, ''), item.extends, entry)
+          ? this.getJsonSchema(newTypeJson.$ref.replace(/#/g, ''), item.extends, entry, true)
           : this.genJsonschema(fileJson, newTypeJson, entry);
         if (typeof result === 'object') {
           item = merge(result, item, {
@@ -358,6 +376,7 @@ export default class genTypeSchema extends typescriptToFileDatas {
         $dependRefKey,
         $refJson.from ? $refKey.replace(/.+?(?=\.)|.+/, $refJson.from) : $refKey,
         entry,
+        true
       );
       handle && handleCommonRef(result, $refKey);
       return result;
@@ -650,6 +669,11 @@ export default class genTypeSchema extends typescriptToFileDatas {
     // anyOf|allOf
     allOfAnyOfHandle(typeJson);
 
+    // 处理泛型
+    if (typeJson.typeParams && Object.keys(typeJson.typeParams).length) {
+      handleGenericDefaultType(typeJson.properties, typeJson.typeParams);
+    }
+
     // 数组类型
     if (typeJson.type === 'array') {
       commonArrayHandle(typeJson);
@@ -660,7 +684,6 @@ export default class genTypeSchema extends typescriptToFileDatas {
       typeJson = handleExtends(typeJson);
     }
 
-
     // 对象类型
     if (typeJson.properties && Object.keys(typeJson.properties)) {
       // eslint-disable-next-line guard-for-in

src/typescript-to-file-datas.ts

@@ -7,7 +7,7 @@ import * as fs from 'fs';
 // types
 import type { AnyOption, TSTypeAnnotationConfig, TypeAnnotationConfig } from './types';
 // utils
-import { genAst } from './utils';
+import { genAst, genAstFromCode } from './utils';
 // require
 const chalk = require('chalk');
 const doctrine = require('doctrine');
@@ -142,6 +142,13 @@ export default class typescriptToFileDatas {
     return { filePath: file, fileType: 'npm' };
   }
 
+  /**
+   * 查找npm包types
+   *
+   * @param {{ sourceValue: string }} { sourceValue }
+   * @return {*} 
+   * @memberof typescriptToFileDatas
+   */
   getTypeFileFromNpm({ sourceValue }: { sourceValue: string }) {
     // 1. 优先查找 index.d.ts 其次查找 ${sourceValue}.d.ts
     const sourceValueArr = sourceValue.split('/');
@@ -191,6 +198,13 @@ export default class typescriptToFileDatas {
     return source
   }
 
+  /**
+   * 查找文件 import types
+   *
+   * @param {{ dir: string; sourceValue: string; ext: string }} { dir, sourceValue, ext }
+   * @return {*} 
+   * @memberof typescriptToFileDatas
+   */
   getTypeFileFromImport({ dir, sourceValue, ext }: { dir: string; sourceValue: string; ext: string }) {
     let source = '';
     // 找依赖的文件,优先级 .ts >> .d.ts >> /index.ts >> /index.d.ts
@@ -502,6 +516,19 @@ export default class typescriptToFileDatas {
     return { data: result, file };
   }
 
+  /**
+   * 通过代码获得解析数据
+   *
+   * @param {string} code
+   * @return {*}  {AnyOption}
+   * @memberof typescriptToFileDatas
+   */
+  genJsonDataFromCode(code: string): AnyOption {
+    // ast
+    const ast_ = genAstFromCode(code);
+    return this.genJsonDataFormFile('index.ts', ast_);
+  }
+
   /**
    * 只获取代码前注释 支持行内注释与块注释
    *