Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

dtsgenerator

3.3.1 • Public • Published

dtsgenerator

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

nodejs version npm version build status Coverage Status npm download count dtsgenerator Dev Token MIT license

Table of Contents

Install

npm install -g dtsgenerator

Usage

$ dtsgen --help
Usage: dtsgenerator [options] <file ... | file patterns using node-glob>
 
Options:
  -V, --version           output the version number
  -c, --config <file>     set configuration file path. (default: "dtsgen.json")
  --url <url>             input json schema from the url. (default: [])
  --stdin                 read stdin with other files or urls.
  -o, --out <file>        output filename.
  -t, --target <version>  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

Use HTTP/HTTPS Proxy

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

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 braking 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

How to find plug-in

How to create plug-in

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

Development

Debug

Output debug message by debug library.

$ DEBUG=dtsgen dtsgen schema/news.json

Links about JSON Schema and Swagger

Supported spec and features

  • 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

v3.3.1 (2020-10-05)

  • fixed:
    • Elements get type "any" instead of the correct one by #448. Thank you for your report @nachtigall-83 👍

v3.3.0 (2020-07-29)

  • features:
    • Support the patternProperties by #436. Thank you @nfroidure 👍
  • fixed:
    • Definition generated improperly when multiple instances of a resource are inherited by #279. Thank you @btg5679 👍
    • Apply the prettier config on .eslintrc.json.

v3.2.0 (2020-07-20)

  • features:
    • Add support for application/octet-stream media type by #431. Thank you @MisterChateau 👍

v3.1.1 (2020-06-23)

  • fixed:
    • Cannot load config file of relative path by #428. Thank you @DamianOsipiuk 👍

v3.1.0 (2020-06-22)

  • features:
    • Add support for nullable anyOf in OpenApi v3 by #426. Thank you @joost-kersjes-webpower 👍

v3.0.3 (2020-06-15)

  • fixed:
    • Fix the command option example by #422. Thank you @maapteh 👍
    • Omit load config error on not config option by #425. Thank you @Christian24 👍

v3.0.2 (2020-06-11)

  • fixed:
    • Remove old example by #421. Thank you @maapteh 👍

v3.0.1 (2020-06-09)

  • features:
    • Support the plug-in for pre-process and post-process.
    • Change command line options and Support config file.
    • Use the TypeScript AST for intermediate format.

older versions history

ChangeLogs

License

dtsgenerator is licensed under the MIT license.

Copyright © 2016-2020, Hiroki Horiuchi

Install

npm i dtsgenerator

DownloadsWeekly Downloads

14,574

Version

3.3.1

License

MIT

Unpacked Size

558 kB

Total Files

91

Last publish

Collaborators

  • avatar