Gathering detailed insights and metrics for @jsdoc/salty
Gathering detailed insights and metrics for @jsdoc/salty
An API documentation generator for JavaScript.
Installations
npm install @jsdoc/saltyDeveloper Guide
BETA
Typescript
No
Module System
N/A
Min. Node Version
>=v12.0.0
Node Version
18.20.4
NPM Version
lerna/8.1.9/node@v18.20.4+x64 (darwin)
Score
99.4
Supply Chain
99.5
Quality
76.8
Maintenance
100
Vulnerability
99.6
License
Releases
12
Languages
2
JavaScript
CSS
JavaScript (99.4%)
CSS (0.6%)
Developer
Download Statistics
Total Downloads
214,233,898
Last Day
73,296
Last Week
1,522,962
Last Month
6,649,726
Last Year
81,148,786
GitHub Statistics
Apache-2.0 License
15,260 Stars
2,992 Commits
1,465 Forks
274 Watchers
10 Branches
80 Contributors
Updated on Jul 03, 2025
Bundle Size
71.74 kB
Minified
25.11 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
0.2.9
Package Id
@jsdoc/salty@0.2.9
Unpacked Size
26.12 kB
Size
8.72 kB
File Count
5
NPM Version
lerna/8.1.9/node@v18.20.4+x64 (darwin)
Node Version
18.20.4
Published on
Dec 15, 2024
Total Downloads
Cumulative downloads
Total Downloads
214,233,898
Last Day
-3.5%
73,296
Compared to previous day
Last Week
-7.2%
1,522,962
Compared to previous week
Last Month
-2%
6,649,726
Compared to previous month
Last Year
-27.5%
81,148,786
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
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 8.15.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
Note: By default, npm adds your package using the caret operator in front of
the version number (for example, ^3.6.3). We recommend using the tilde
operator instead (for example, ~3.6.3), which limits updates to the most
recent patch-level version. See
this Stack Overflow answer for
more information about the caret and tilde operators.
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
- jaguarjs-jsdoc
- DocStrap (example)
- jsdoc3Template (example)
- minami
- docdash (example)
- tui-jsdoc-template (example)
- better-docs (example)
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
jsdocto Stack Overflow.
License
JSDoc is copyright (c) 2011-present Michael Mathews micmath@gmail.com and the contributors to JSDoc.
JSDoc is free software, licensed under the Apache License, Version 2.0. See the
LICENSE file for more details.
No vulnerabilities found.
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
GitHub workflow tokens follow principle of least privilege
Details
- Info: found token with 'none' permissions: .github/workflows/ci.yaml:1
- Info: no jobLevel write permissions found
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0
Reason
1 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdoc/jsdoc/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdoc/jsdoc/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdoc/jsdoc/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdoc/jsdoc/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdoc/jsdoc/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdoc/jsdoc/ci.yaml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:38
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:56
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:74
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 3 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Score
5.2
/10
Last Scanned on 2025-06-23
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More