0.0.1-beta.2 • Published 6 years ago
create-json-schema-file v0.0.1-beta.2
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
npm install --save ts-json-schema-generator
./node_modules/.bin/ts-json-schema-generator \
--path 'my/project/**.*.ts' \
--type 'My.Type.Full.Name' \
--expose 'export' \
--jsDoc 'extended' \
--strictTuples
Options
-e, --expose <all|none|export>
all: Create shared $ref definitions for all types.
none: Do not create shared $ref definitions.
export: Create shared $ref definitions only for exported types.
-r, --no-top-ref
Do not create a top-level $ref definition.
-j, --jsDoc <extended|none|basic>
basic: Read JsDoc annotations to provide schema properties.
extended: Also read @nullable, and @asType annotations.
none: Do not use JsDoc annotations.
-u, --unstable
Do not sort properties.
-s, --strictTuples
Do not allow additional items on tuples.
Current state
interface
typesenum
typesunion
,tuple
,type[]
typesstring
,boolean
,number
types"value"
,123
,true
,false
,null
,undefined
literals- type aliases
- generics
typeof
keyof
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!
0.0.1-beta.2
6 years ago
0.0.1-beta.1
6 years ago