Package Health Score

83 / 100

security
No known security issues
popularity
Key ecosystem project
maintenance
Sustainable
community
Active

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
4.0.4	\|	10/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.0.2	\|	02/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.6.11	\|	07/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.0	\|	09/2011		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

Key ecosystem project

Weekly Downloads (1,883,621)

GitHub Stars: 15.09K
Forks: 1.45K
Contributors: 90

Direct Usage Popularity

The npm package jsdoc receives a total of 1,883,621 downloads a week. As such, we scored jsdoc popularity level to be Key ecosystem project.

Based on project statistics from the GitHub repository for the npm package jsdoc, we found that it has been starred 15,090 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: 90
Funding: No

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

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 397
Open PR: 45
Last Release: 2 months ago
Last Commit: 7 days ago

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

We found that jsdoc 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: >=12.0.0

Age: 13 years
Dependencies: 15 Direct
Versions: 53
Install Size: 1.53 MB
Dist-tags: 1
# of Files: 125
Maintainers: 1
TS Typings: No

jsdoc 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

JSDoc

An API documentation generator for JavaScript.

Want to contribute to JSDoc? Please read CONTRIBUTING.md.

Installation and Usage

JSDoc supports stable versions of Node.js 12.0.0 and later. You can install JSDoc globally or in your project's node_modules folder.

To install the latest version on npm globally (might require sudo; learn how to fix this):

npm install -g jsdoc

To install the latest version on npm locally and save it in your package's package.json file:

npm install --save-dev jsdoc

To install the latest development version locally, without updating your project's package.json file:

npm install git+https://github.com/jsdoc/jsdoc.git

If you installed JSDoc locally, the JSDoc command-line tool is available in ./node_modules/.bin. To generate documentation for the file yourJavaScriptFile.js:

./node_modules/.bin/jsdoc yourJavaScriptFile.js

If you installed JSDoc globally, run the jsdoc command:

jsdoc yourJavaScriptFile.js

By default, the generated documentation is saved in a directory named out. You can use the --destination (-d) option to specify another directory.

Run jsdoc --help for a complete list of command-line options.

Templates and tools

The JSDoc community has created templates and other tools to help you generate and customize your documentation. Here are a few of them:

Templates

Build tools

Other tools

For more information

Documentation is available at jsdoc.app.
Contribute to the docs at jsdoc/jsdoc.github.io.
Join JSDoc's Slack channel.
Ask for help on the JSDoc Users mailing list.
Post questions tagged jsdoc to Stack Overflow.

License

JSDoc is free software, licensed under the Apache License, Version 2.0. See the file LICENSE.md in this distribution for more details.

jsdoc dependencies

klaw marked mkdirp bluebird catharsis requizzle underscore markdown-it @jsdoc/salty js2xmlparser @babel/parser @types/markdown-it markdown-it-anchor strip-json-comments escape-string-regexp

jsdoc development dependencies

ajv nyc gulp gulp-eslint gulp-json-editor

FAQs

What is jsdoc?

An API documentation generator for JavaScript. Visit Snyk Advisor to see a full health score report for jsdoc, including popularity, security, maintenance & community analysis.

Is jsdoc popular?

The npm package jsdoc receives a total of 1,883,621 weekly downloads. As such, jsdoc popularity was classified as a key ecosystem project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is jsdoc well maintained?

We found indications that jsdoc maintenance is sustainable demonstrating some project activity. We saw a total of 90 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is jsdoc safe to use?

The npm package jsdoc 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 18 December-2024, at 12:37 (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

jsdoc

An API documentation generator for JavaScript. 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 (1,883,621)

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

JSDoc

Installation and Usage

Templates and tools

Templates

Build tools

Other tools

For more information

License

jsdoc dependencies

jsdoc development dependencies

FAQs

What is jsdoc?

Is jsdoc popular?

Is jsdoc well maintained?

Is jsdoc 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 (1,883,621)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

JSDoc

Installation and Usage

Templates and tools

Templates

Build tools

Other tools

For more information

License

jsdoc dependencies

jsdoc development dependencies

FAQs

What is jsdoc?

Is jsdoc popular?

Is jsdoc well maintained?

Is jsdoc 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