Package Health Score

55 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Active

Explore Similar Packages

Security

Security review needed

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

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
0.0.1-beta.2	\|	07/2018	Popular	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

Limited

Weekly Downloads (7)

GitHub Stars: 1.45K
Forks: 193
Contributors: 100

Direct Usage Popularity

The npm package create-json-schema-file receives a total of 7 downloads a week. As such, we scored create-json-schema-file popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package create-json-schema-file, we found that it has been starred 1,450 times.

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

Community

Active

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

With more than 10 contributors for the create-json-schema-file repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 83
Open PR: 12
Last Release: 6 years ago
Last Commit: 5 days ago

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

An important project maintenance signal to consider for create-json-schema-file is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

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: >=6.0.0

Age: 6 years
Dependencies: 4 Direct
Versions: 3
Install Size: 368 kB
Dist-tags: 1
# of Files: 323
Maintainers: 1
TS Typings: Yes

create-json-schema-file 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

ts-json-schema-generator

Extended version of https://github.com/xiag-ag/typescript-to-json-schema.

Inspired by YousefED/typescript-json-schema. Here's the differences list:

this implementation does not use typeChecker.getTypeAtLocation() (so probably it keeps correct type aliases)
the following features are not supported yet:
- class types
processing AST and formatting JSON schema have been split into two independent steps
not exported types, interfaces, enums are not exposed in the definitions section in the JSON schema

Usage

npm install --save ts-json-schema-generator
./node_modules/.bin/ts-json-schema-generator \
    --path 'my/project/**.*.ts' \
    --type 'My.Type.Full.Name' \
    --expose 'export' \
    --jsDoc 'extended' \
    --strictTuples

Options

-e, --expose 
    all: Create shared $ref definitions for all types.
    none: Do not create shared $ref definitions.
    export:  Create shared $ref definitions only for exported types.

-r, --no-top-ref
    Do not create a top-level $ref definition.

-j, --jsDoc 
    basic: Read JsDoc annotations to provide schema properties.
    extended: Also read @nullable, and @asType annotations.
    none: Do not use JsDoc annotations.

-u, --unstable
    Do not sort properties.

-s, --strictTuples
    Do not allow additional items on tuples.

Current state

interface types
enum types
union, tuple, type[] types
string, boolean, number types
"value", 123, true, false, null, undefined literals
type aliases
generics
typeof
keyof

Debug

npm run debug -- test/programs/type-alias-single/main.ts --aliasRefs true MyString

And connect via the debugger protocol.

AST Explorer is amazing for developers of this tool!

create-json-schema-file dependencies

commander glob json-stable-stringify typescript

create-json-schema-file development dependencies

@types/assertion-error @types/chai @types/glob @types/json-stable-stringify @types/mocha @types/node ajv chai jest source-map-support ts-jest ts-node tslint

FAQs

What is create-json-schema-file?

Generate JSON schema from your Typescript sources. Visit Snyk Advisor to see a full health score report for create-json-schema-file, including popularity, security, maintenance & community analysis.

Is create-json-schema-file popular?

The npm package create-json-schema-file receives a total of 7 weekly downloads. As such, create-json-schema-file popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is create-json-schema-file well maintained?

We found indications that create-json-schema-file is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is create-json-schema-file safe to use?

While scanning the latest version of create-json-schema-file, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 14 November-2024, at 20:32 (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

create-json-schema-file

Generate JSON schema from your Typescript sources For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Explore Similar Packages

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (7)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

ts-json-schema-generator

Usage

Options

Current state

Debug

create-json-schema-file dependencies

create-json-schema-file development dependencies

FAQs

What is create-json-schema-file?

Is create-json-schema-file popular?

Is create-json-schema-file well maintained?

Is create-json-schema-file safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (7)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

ts-json-schema-generator

Usage

Options

Current state

Debug

create-json-schema-file dependencies

create-json-schema-file development dependencies

FAQs

What is create-json-schema-file?

Is create-json-schema-file popular?

Is create-json-schema-file well maintained?

Is create-json-schema-file 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