typescript-to-json-schema-extra
v0.2.1
Published
Some extra features for typescript-to-json-schema
Downloads
28
Readme
typescript-to-json-schema-extra
Provides some extras for typescript-to-json-schema.
- Generate schemas for all types:
SchemaGenerator.createSchemas(filter: (fileName: string) => boolean): Map<Schema>
. - Create a program from a list of files:
ExtConfig.paths
. - Provide custom compiler options for a program:
createProgram(config: Config, options?: ts.CompilerOptions): ts.Program
. - Treat line comments
//
the same as jsDoc comments/** */
:ExtConfig.lineComment
. Warning: This is not very stable, use on your own risk! - Add
extra: { filename: string; members?: string[] }
property to the schema containing the typescript filename and the member names of enums.
Development
The development is done in the develop
branch.
Releasing is done by updating the version with npm version patch|minor|major
and by rebasing the develop branch onto the master branch.
Travis CI will then pick this up and perform the release.
To publish to npmjs.com, the environment variable NPM_TOKEN
must be set. Do this by executing
npm login
locally and the take the corresponding value out of ~/.nmprc
.