Package Health Score

81 / 100

security
Security review needed
popularity
Recognized
maintenance
Healthy
community
Active

Explore Similar Packages

swagger
47

Security

Security review needed

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

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
10.5.5	\|	09/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
10.4.20	\|	08/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
9.2.2	\|	10/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
8.0.56	\|	06/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
7.2.9	\|	04/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

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 (22,593)

GitHub Stars: 50
Forks: 12
Contributors: 30

Direct Usage Popularity

The npm package jsii-docgen receives a total of 22,593 downloads a week. As such, we scored jsii-docgen popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package jsii-docgen, we found that it has been starred 50 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: Yes
Code of Conduct: Yes
Contributors: 30
Funding: No

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

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 16
Open PR: 2
Last Release: 1 month ago
Last Commit: 13 days ago

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

We found that jsii-docgen demonstrates a positive version release cadence with at least one new version released in the past 3 months.

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: not defined

Age: 5 years
Dependencies: 8 Direct
Versions: 970
Install Size: 658 kB
Dist-tags: 1
# of Files: 82
Maintainers: 3
TS Typings: Yes

jsii-docgen 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

jsii-docgen

Generates markdown reference documentation for jsii modules.

Usage

You can use this as a command line tool or as a library if you need more control.

$ jsii-docgen

Will produce a file called API.md with the api reference for this module.

As a library:

import { Documentation, Language } from 'jsii-docgen';

const docs = await Documentation.forProject('.');
const markdown = await docs.toMarkdown({ language: Language.TYPESCRIPT }).render(); // returns a markdown string

const json = await docs.toJson({ language: Language.TYPESCRIPT }).render(); // returns a JSON object

Curreently jsii-docgen supports generating documentation in the following languages:

TypeScript (typescript)
Python (python)
Java (java)
C# (csharp)
Go (go)

CLI Options

Option	Required	Description
`--output`, `-o`	optional	Output filename (defaults to API.md if format is markdown, and API.json if format is JSON). `jsii-docgen -o ./docs/API.md`
`--format`, `-f`	optional	Output format. Can be `markdown` or `json`. `jsii-docgen -f json`
`--language`, `-l`	optional	Language to generate documentation for. Can be `typescript`, `python`, `java`, `csharp` or `go`. `jsii-docgen -l typescript`
`--package`, `-p`	optional	The name@version of an NPM package to document. `jsii-docgen -p my-package`
`--readme`, `-r`	optional	Generate docs for user specified README.md. `jsii-docgen -r`
`--submodule`, `-s`	optional	Generate docs for a specific submodule or "root". `jsii-docgen -s my-submodule`
`--split-by-submodule`	optional	Generate a separate file for each submodule. `jsii-docgen --split-by-submodule`

Contributions

All contributions are welcome, just raise an issue or submit a PR. Add a test, update readme. Do the right thing.

License

Apache 2.0

jsii-docgen dependencies

@jsii/spec case fs-extra glob glob-promise jsii-reflect semver yargs

jsii-docgen development dependencies

@types/fs-extra @types/jest @types/node @types/semver @typescript-eslint/eslint-plugin @typescript-eslint/parser cdklabs-projen-project-types commit-and-tag-version constructs eslint eslint-import-resolver-typescript eslint-plugin-import jest jest-junit jsii-rosetta projen ts-jest ts-node typescript

FAQs

What is jsii-docgen?

generates api docs for jsii modules. Visit Snyk Advisor to see a full health score report for jsii-docgen, including popularity, security, maintenance & community analysis.

Is jsii-docgen popular?

The npm package jsii-docgen receives a total of 22,593 weekly downloads. As such, jsii-docgen popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is jsii-docgen well maintained?

We found that jsii-docgen demonstrated a healthy version release cadence and project activity. It has a community of 30 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is jsii-docgen safe to use?

While scanning the latest version of jsii-docgen, 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 3 November-2024, at 20:40 (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

jsii-docgen

generates api docs for jsii modules 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 (22,593)

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

jsii-docgen

Usage

CLI Options

Contributions

License

jsii-docgen dependencies

jsii-docgen development dependencies

FAQs

What is jsii-docgen?

Is jsii-docgen popular?

Is jsii-docgen well maintained?

Is jsii-docgen 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 (22,593)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

jsii-docgen

Usage

CLI Options

Contributions

License

jsii-docgen dependencies

jsii-docgen development dependencies

FAQs

What is jsii-docgen?

Is jsii-docgen popular?

Is jsii-docgen well maintained?

Is jsii-docgen 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