Package Exports

typescript-to-json-schema
typescript-to-json-schema/dist
typescript-to-json-schema/dist/factory/formatter
typescript-to-json-schema/dist/factory/parser

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (typescript-to-json-schema) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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
- conditional 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 typescript-to-json-schema
./node_modules/.bin/typescript-to-json-schema \
    --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, 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!