fast-typescript-to-jsonschema

fast-typescript-to-jsonschema

English | 简体中文

a tool generate json schema from typescript.

Feature

• compile Typescript to get all type information
• convert properties, extends, annotations, and initial values to jsonschema

Usage

1. install

yarn add fast-typescript-to-jsonschema -D

1. create type.ts

interface ITest {
  attr1: string;
  attr2: number;
  attr3?: boolean;
}

1. create test.js

3.1. gen jsonschema from file.

const { default: genTypeSchema } = require('fast-typescript-to-jsonschema');
const path = require('path');

// target file
const file = path.resolve(__dirname, './type.ts');

// generate data
genTypeSchema.genJsonDataFormFile(file);

// get all jsonschema data of current file
const json = genTypeSchema.genJsonData();

// get jsonschema of specific type
const jsonSchema = genTypeSchema.getJsonSchema(file, 'ITest');

// result
console.log(jsonSchema); 

3.2. gen jsonschema from code.

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); 

1. execute script

node ./test.js

jsonSchema result:

{
  "additionalProperties": false,
  "properties": {
    "attr1": {
      "type": "string",
    },
    "attr2": {
      "type": "number",
    },
    "attr3": {
      "type": "boolean",
    },
  },
  "required": [
    "attr1",
    "attr2",
  ],
  "type": "object",
}

see more examples at example.

Comments

Example1

interface Interface_1 {
  attr: string;
}

result:

{
  "additionalProperties": false,
  "properties": {
    "attr": {
      "type": "string",
    },
  },
  "required": [
    "attr",
  ],
  "type": "object",
}

Example2

interface Interface_4 {
  attr: string[];
}

result:

{
  "additionalProperties": false,
  "properties": {
    "attr": {
      "items": {
        "type": "string",
      },
      "type": "array",
    },
  },
  "required": [
    "attr",
  ],
  "type": "object",
}

Read more supported types here

• Interface
  • 1.1 Basic Types
  • 1.2 Union Types
  • 1.3 Intersection Types
  • 1.4 Array Types
    • 1.4.1 Basic Array Types
    • 1.4.2 Complex Array Types
  • 1.5 Nesting
    • 1.5.1 Nested Basic Types
    • 1.5.2 Nested Union Types
    • 1.5.3 Nested Intersection Types
    • 1.5.4 Nested Intersection Array Types
    • 1.5.5 Nested loop
  • 1.6 Index Types
• Modules
  • 1.1 Basic Modules
  • 1.2 Named Export Modules
• Extending Types
  • 1.1 Basic Extending Types
  • 1.2 Multiple Extending Types
• Enums
  • 1.1 Numeric Enums
  • 1.2 String Enums
  • 1.3 Computed Enums
  • 1.4 Complex Enums
    • 1.4.1 Basic Interface to Enums
    • 1.4.2 Complex Interface to Enums
• Generics
  • 1.1 Basic Generics
  • 1.2 Complex Generics
• Namespaces
  • 1.1 Basic Namespaces
  • 1.2 Complex Namespaces
• Type
  • 1.1 Basic Types
  • 1.2 Complex Types
    • 1.2.1 Union Types
    • 1.2.2 Union Array Types
    • 1.2.2 Import Enums
• Utility Types
  • 1.1 Utility for Objects
    • 1.1.1 Omit
      • 1.1.1.1 Basic Omit
      • 1.1.1.2 Union Omit
      • 1.1.1.3 Import Omit
    • 1.1.2 Pick
      • 1.1.2.1 Basic Pick
      • 1.1.2.2 Import Pick
    • 1.1.3 Record
      • 1.1.2.1 Basic Record
      • 1.1.2.2 Import Record
• Type Annotations
  • 1.1 Single-line annotations
  • 1.2 Single-line annotations with default value
  • 1.3 Multi-line annotations
  • 1.4 Multi-line annotations with default value
  • 1.5 Mixed annotations with default value

Contribution

Contributions are extremely welcomed by our team, you can contribute to this repository by several ways below.

• Submit GitHub Issue to report errors or ask questions
• Create Pull Request to improve our code
• Contribution guide

Changelog

0.0.9 (2023-03-01)

Bug Fixes

• 避免原有definitions被覆盖 (64d2ff6)
• 泛型默认值，进行深度克隆，避免被覆盖 (ffb5d2d)
• 完善重复引用逻辑 (136e9b0)
• 完善重复引用逻辑 (eed579e)
• 重复引用以及 namespace 多层嵌套解析 (a08d8d9)
• genJsonschema 方法 entry 增加默认值处理 (cde668a)
• namespace 多层嵌套解析问题 (78b7b27)

Features

• 1. 新增对npm包类型的支持 2.修复非同类型枚举类型结果不准确问题 3.修复枚举类型中key为字符串时深度循环问题 (1e9bbad)
• 1. 新增通过 code 生成 jsonschema (96770e3)
• 1.剔除工具函数$ref随机数命明，优化为静态名称 2.补充工具函数单测案例 (0af7eed)
• 补充code传入方式获取jsonschema单测用例 (beb20c3)
• 更新文档,新增测试案例 (84a5788)
• 更新文档,新增测试案例 (c480e6c)
• 关闭 source map (62fa4dc)
• 解析块级文档支持description参数 (176adcb)
• 枚举类型解析问题 (6467bae)
• 默认文档切换为英文文档 (df98316)
• 删除额外属性,处理type为数组情况，完善逻辑 (265ad1e)
• 完善additionalProperties处理，补充测试用例 (1e3fe87)
• 文档优化 (3591789)
• 新增测试覆盖率标识 (c94dca2)
• 新增测试覆盖率标识 (56daa19)
• 新增测试覆盖率标识 (96b1a17)
• 新增测试覆盖率标识 (1ad1c11)
• 新增测试覆盖率标识 (4fb6beb)
• 新增测试覆盖率标识 (cca0f42)
• 修复包名 (0813a33)
• 修复repository链接 (24eea13)
• 增加本文件查找引用类型，删除枚举类型时的空definitions (a7fc272)
• 增加Partial、Required对联合类型的处理 (a1c661b)
• 增加Pick/Omit对type的支持 (46f2a9e)
• 支持工具函数Partial (fbe9c68)
• 支持工具函数Required (486e1ea)
• add codecov_token (954b209)
• add codecov_token (900ffda)
• add codecov_token (22b7069)
• add English docs (0926ac6)
• add license (1f3fce9)
• enable sourcemap (882be37)
• typescript-to-jsonschema first version (15632cc)