dtsgenerator

TypeScript d.ts file generator from JSON Schema file or OpenAPI(Swagger) spec file.


Table of Contents

- Install
- Usage
- Migration from v2
- Plug-in
- Development
- ChangeLog
- License

Install

npm install -g dtsgenerator

- Releases

Usage

$3

``sh
$ dtsgen --help
Usage: dtsgenerator [options]

Options:
-V, --version output the version number
-c, --config set configuration file path.
--url input json schema from the url. (default: [])
--stdin read stdin with other files or urls.
-o, --out output filename.
-t, --target Specify ECMAScript target version: 'ES3', 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018',
'ES2019', 'ES2020', or 'ESNEXT' (default).
--info for developer mode. output loaded config and plugin details only.
--output-ast output TypeScript AST instead of d.ts file.
-h, --help display help for command

Examples:
$ dtsgen --help
$ dtsgen --out types.d.ts schema/*/.schema.json
$ cat schema1.json | dtsgen -c dtsgen.json
$ dtsgen -o swaggerSchema.d.ts --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/schemas/v2.0/schema.json
$ dtsgen -o petstore.d.ts --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v2.0/yaml/petstore.yaml
$ dtsgen -c dtsgen-test.json --info

`

For the configuration file, please refer to the file in the config_sample directory.

$3

`js
const { default: dtsgenerator, parseSchema } = require('dtsgenerator');

dtsgenerator({
contents: [parseSchema({/ JsonSchema object /})],
config: {/ Config object /},
}).then(content => {
/ Do someting with parsed content /
}).catch(err => {
/ Handle errors /
});
`

$3

If you need a proxy to fetch the schema, please set the following environment variables.

`bash
export http_proxy=http://proxy.example.com:8080/
export https_proxy=http://proxy.example.com:8080/


If there are exceptionally hosts that do not go through a proxy


export no_proxy=google.com, yahoo.com
`

Migration from v2

The dtsgenerator v3 has made the following breaking changes from v2.

- Support Plug-in feature. See the Plug-in section for more information.
- Change the command line options.
- Remove the --namespace option. Use the @dtsgenerator/replace-namespace plug-in instead.
- Add the --config option. Mainly for setting up the Plug-in.
- And add more options.
- TypeScript AST is now used internally to generate type definitions.

Plug-in

$3

- Search by npm:
- Find by the @dtsgenerator repositories:
- @dtsgenerator/replace-namespace : This plug-in is instead the --namespace option on old version.
- @dtsgenerator/decorate-typename : This plug-in can decorate the output type name.
- @dtsgenerator/single-quote : This plug-in replace the quote mark to single.

$3

1. Scaffold by the command:
- npm init @dtsgenerator plugin-name
1. Edit plugin-name/index.ts
1. Do test:
- npm test
1. Build it:
- npm run build
1. Publish to npm:
- npm publish

Development

$3

Output debug message by debug library.

DEBUG=dtsgen dtsgen schema/news.json

$3

- The home of JSON Schema
- The OpenAPI Specification

$3

- JSON Schema
- Draft-04 and before
- Draft-07 and before
- OpenAPI
- OpenAPI Specification version 2.0
- OpenAPI Specification version 3.0

- supported features in these spec

ChangeLog

$3

- features:
- Update plugins for new TypeScript AST.
- Changed supported Node.js version to 16 or later. Also, we have confirmed that it works with Node.js v20.

$3

- features:
- Support 'application/json' with parameter media type for #551. Thank you @denizkenan :+1:

$3

- features:
- Return exit code 1 when error occurs by #549. Thank you @lhotamir :+1:

$3

- fixed:
- Fix to remove deprecated decorators parameters for #547. Thank you @mcollina :+1:

$3

- features:
- Support 'image/*' media types for #539. Thank you @Geloosa :+1:

$3

ChangeLogs

License

dtsgenerator` is licensed under the MIT license.

Copyright © 2016-2020, Hiroki Horiuchi