https://github.com/fjc0k/vscode-typescript-to-json-schema
https://github.com/fjc0k/vscode-typescript-to-json-schema
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fjc0k/vscode-typescript-to-json-schema
- Owner: fjc0k
- Created: 2021-01-14T06:47:35.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-01-14T06:47:47.000Z (over 4 years ago)
- Last Synced: 2025-04-19T23:02:44.346Z (6 months ago)
- Language: TypeScript
- Size: 52.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Typescript JSON schema generator
The extension uses [ts-json-schema-generator](https://github.com/vega/ts-json-schema-generator) to generate JSON schemas from Typescript sources.
Use the command `"Generate JSON Schema for type..."` to get a list of type definitions and interfaces in the page for which a JSON schema can be generated.
The generated schema is opened on a new document and can be saved from there.
## Extension Settings
This extension contributes the following settings:
* `generateJSONSchema.expose`: Types to include in the 'definitions' section of the JSON Schema.
* `generateJSONSchema.topRef`: Include top reference.
* `generateJSONSchema.jsDoc`: JsDoc description to include in JSON schema.
* `generateJSONSchema.sortProps`: Sort properties in JSON schema.
* `generateJSONSchema.skipTypeCheck`: Skip type checks for better performance.
## Known Issues
The JSON schema generation does not work for classes and conditional types.
File scheme generations issues with [ts-json-schema-generator](https://github.com/vega/ts-json-schema-generator/issues)
## Release Notes
See [Change log](./CHANGELOG.md)