Gathering detailed insights and metrics for jsdoc-fresh
Gathering detailed insights and metrics for jsdoc-fresh
Installations
npm install jsdoc-freshScore
86.8
Supply Chain
97.6
Quality
78.1
Maintenance
100
Vulnerability
99.6
License
Releases
12
Contributors
118
![gcf-owl-bot[bot]](https://avatars.githubusercontent.com/in/99011?v=4){kind=avatar}
![release-please[bot]](https://avatars.githubusercontent.com/in/40688?v=4){kind=avatar}
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4){kind=avatar}
Developer
googleapis
Developer Guide
BETA
Module System
Unable to determine the module system for this package.
Min. Node Version
>=14.0.0
Typescript Support
No
Node Version
14.21.3
NPM Version
6.14.18
Statistics
14 Stars
178 Commits
10 Forks
42 Watching
32 Branches
118 Contributors
Updated on 21 Oct 2024
Languages
JavaScript (57.86%)
CSS (40.51%)
Python (1.63%)
Total Downloads
Cumulative downloads
Total Downloads
6,821,003
Last day
-29.4%
1,303
Compared to previous day
Last week
-0.4%
5,948
Compared to previous week
Last month
11.7%
22,988
Compared to previous month
Last year
-56.8%
182,168
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Dev Dependencies
2
Versions
Fresh JSDoc Template
A clean, responsive documentation template with search and navigation highlighting for JSDoc 3. Forked from github.com/braintree/jsdoc-template.
Responsive
Uses
Usage
Clone repository to your designated jsdoc template directory, then:
Node.js Dependency
In your projects package.json file add a generate script:
1"script": { 2 "generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose" 3}
In your .jsdoc.json file, add a template option.
1"opts": { 2 "template": "node_modules/jsdoc-fresh" 3}
Example JSDoc Config
1{ 2 "tags": { 3 "allowUnknownTags": true, 4 "dictionaries": ["jsdoc"] 5 }, 6 "source": { 7 "include": ["lib", "package.json", "README.md"], 8 "includePattern": ".js$", 9 "excludePattern": "(node_modules/|docs)" 10 }, 11 "plugins": [ 12 "plugins/markdown" 13 ], 14 "templates": { 15 "referenceTitle": "My SDK Name", 16 "disableSort": false, 17 "collapse": true, 18 "resources": { 19 "google": "https://www.google.com/" 20 } 21 }, 22 "opts": { 23 "destination": "./docs/", 24 "encoding": "utf8", 25 "private": true, 26 "recurse": true, 27 "template": "./node_modules/jsdoc-template" 28 } 29}
Note: referenceTitle and disableSort will affect the output of this theme.
If you would like to enable Algolia DocSearch, you can pass a search object into the templates object.
1"templates": { 2 "search": { 3 "apiKey": "your-api-key", 4 "indexName": "Your index name. Defaults to braintree.", 5 "hitsPerPage": "Number of Results to show. Defaults to 7.", 6 } 7}
License
Licensed under the Apache2 license.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1
- Info: Found text in security policy: SECURITY.md:1
Reason
all changesets reviewed
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
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
SAST tool is not run on all commits -- score normalized to 2
Details
- Warn: 8 commits out of 30 are checked with a SAST tool
Reason
1 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yaml:1
- Warn: no topLevel permission defined: .github/workflows/response.yaml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/ci.yaml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yaml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/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/googleapis/jsdoc-fresh/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/response.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/response.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/response.yaml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/response.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/response.yaml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/response.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/response.yaml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/response.yaml/main?enable=pin
- Warn: npmCommand not pinned by hash: .kokoro/docs.sh:23
- Warn: npmCommand not pinned by hash: .kokoro/lint.sh:23
- Warn: npmCommand not pinned by hash: .kokoro/lint.sh:29
- Warn: npmCommand not pinned by hash: .kokoro/publish.sh:29
- Warn: npmCommand not pinned by hash: .kokoro/release/docs-devsite.sh:27
- Warn: npmCommand not pinned by hash: .kokoro/release/docs-devsite.sh:28
- Warn: npmCommand not pinned by hash: .kokoro/release/docs.sh:27
- Warn: npmCommand not pinned by hash: .kokoro/release/docs.sh:31
- Warn: npmCommand not pinned by hash: .kokoro/samples-test.sh:35
- Warn: npmCommand not pinned by hash: .kokoro/samples-test.sh:40
- Warn: npmCommand not pinned by hash: .kokoro/system-test.sh:34
- Warn: npmCommand not pinned by hash: .kokoro/test.sh:23
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:23
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:26
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:48
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:57
- Info: 0 out of 12 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
- Info: 0 out of 16 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Score
5.7
/10
Last Scanned on 2024-11-25
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