Package Health Score

64 / 100

security
No known security issues
popularity
Recognized
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
3.19.2	\|	06/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.18.0	\|	03/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.7.0	\|	06/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.0	\|	09/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.0	\|	06/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (27,678)

GitHub Stars: 578
Forks: 93
Contributors: 40

Direct Usage Popularity

The npm package dtsgenerator receives a total of 27,678 downloads a week. As such, we scored dtsgenerator popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package dtsgenerator, we found that it has been starred 578 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 40
Funding: Yes

With more than 10 contributors for the dtsgenerator repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like dtsgenerator is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 23
Open PR: 0
Last Release: 7 months ago
Last Commit: 7 months ago

Further analysis of the maintenance status of dtsgenerator based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that dtsgenerator demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >= 18.0

Age: 10 years
Dependencies: 9 Direct
Versions: 92
Install Size: 377 kB
Dist-tags: 1
# of Files: 73
Maintainers: 1
TS Typings: Yes

dtsgenerator has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

dtsgenerator

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

Install

npm install -g dtsgenerator

Releases

Usage

CLI

$ 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.

NodeJS API

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

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

Use HTTP/HTTPS Proxy

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

export http_proxy=https://proxy.example.com:8080/
export https_proxy=https://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

How to find plug-in

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.

How to create plug-in

Scaffold by the command:
- npm init @dtsgenerator **plugin-name**
Edit **plugin-name**/index.ts
Do test:
- npm test
Build it:
- npm run build
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.19.2 (2024-06-11)

fixed:
- Support a negative number by #566. Thank you @maximebiloe 👍

v3.19.1 (2023-08-25)

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.

v3.18.0 (2023-03-02)

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

v3.17.0 (2023-02-21)

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

v3.16.2 (2022-12-20)

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

v3.16.0 (2022-06-10)

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

older versions history

ChangeLogs

License

dtsgenerator is licensed under the MIT license.

dtsgenerator dependencies

commander cross-fetch debug glob http-proxy-agent https-proxy-agent js-yaml tslib typescript

FAQs

What is dtsgenerator?

TypeScript d.ts file generator for JSON Schema file. Visit Snyk Advisor to see a full health score report for dtsgenerator, including popularity, security, maintenance & community analysis.

Is dtsgenerator popular?

The npm package dtsgenerator receives a total of 27,678 weekly downloads. As such, dtsgenerator popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is dtsgenerator well maintained?

We found indications that dtsgenerator is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is dtsgenerator safe to use?

The npm package dtsgenerator was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 26 November-2024, at 11:59 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (27,678)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

dtsgenerator

Table of Contents

Install

Usage

CLI

NodeJS API

Use HTTP/HTTPS Proxy

Migration from v2

Plug-in

How to find plug-in

How to create plug-in

Development

Debug

Links about JSON Schema and Swagger

Supported spec and features

ChangeLog

v3.19.2 (2024-06-11)

v3.19.1 (2023-08-25)

v3.18.0 (2023-03-02)

v3.17.0 (2023-02-21)

v3.16.2 (2022-12-20)

v3.16.0 (2022-06-10)

older versions history

License

dtsgenerator dependencies

dtsgenerator development dependencies

FAQs

What is dtsgenerator?

Is dtsgenerator popular?

Is dtsgenerator well maintained?

Is dtsgenerator safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues