vega/ts-json-schema-generator

Name: ts-json-schema-generator

Owner: Vega

Description: Generate JSON schema from your Typescript sources

Forked from: xiag-ag/typescript-to-json-schema

Created: 2017-06-02 05:09:01.0

Updated: 2017-12-27 12:17:45.0

Pushed: 2017-12-30 23:26:02.0

Homepage: null

Size: 331

Language: TypeScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

ts-json-schema-generator

Extended version of https://github.com/xiag-ag/typescript-to-json-schema.

Inspired by YousefED/typescript-json-schema. Here's the differences list:

• this implementation does not use typeChecker.getTypeAtLocation() (so probably it keeps correct type aliases)
• the following features are not supported yet:
• class types
• processing AST and formatting JSON schema have been split into two independent steps
• not exported types, interfaces, enums are not exposed in the definitions section in the JSON schema

Usage

install --save ts-json-schema-generator
de_modules/.bin/ts-json-schema-generator \
--path 'my/project/**.*.ts' \
--type 'My.Type.Full.Name' \
--expose 'export' \
--topRef 'yes' \
--jsDoc 'extended'

Current state

• interface types
• enum types
• union, tuple, type[] types
• string, boolean, number types
• "value", 123, true, false, null literals
• type aliases
• generics
• typeof
• @nullable annotations
• @hide annotations for enum values and object properties

Debug

npm run debug -- test/programs/type-alias-single/main.ts --aliasRefs true MyString

And connect via the debugger protocol.

AST Explorer is amazing for developers of this tool!