Package Health Score

63 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Sustainable

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
3.0.0	\|	08/2023	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.2	\|	05/2023	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.1	\|	08/2021	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.5	\|	10/2020	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Yes

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

Small

Weekly Downloads (4,309)

GitHub Stars: 14
Forks: 10
Contributors: 30

Direct Usage Popularity

The npm package jsdoc-fresh receives a total of 4,309 downloads a week. As such, we scored jsdoc-fresh popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package jsdoc-fresh, we found that it has been starred 14 times.

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

Community

Sustainable

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

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

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 4
Open PR: 5
Last Release: 1 year ago
Last Commit: 4 months ago

Further analysis of the maintenance status of jsdoc-fresh 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 jsdoc-fresh 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: >=14.0.0

Age: 5 years
Dependencies: 1 Direct
Versions: 11
Install Size: 1.54 MB
Dist-tags: 2
# of Files: 125
Maintainers: 2
TS Typings: No

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

Fresh JSDoc Template

A clean, responsive documentation template with search and navigation highlighting for JSDoc 3. Forked from github.com/braintree/jsdoc-template.

Braintree JS Doc Template Screenshot

Responsive

Braintree JS Doc Template Screenshot

Uses

Usage

Clone repository to your designated jsdoc template directory, then:

Node.js Dependency

In your projects package.json file add a generate script:

"script": {
  "generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
}

In your .jsdoc.json file, add a template option.

"opts": {
  "template": "node_modules/jsdoc-fresh"
}

Example JSDoc Config

{
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc"]
    },
    "source": {
        "include": ["lib", "package.json", "README.md"],
        "includePattern": ".js$",
        "excludePattern": "(node_modules/|docs)"
    },
    "plugins": [
        "plugins/markdown"
    ],
    "templates": {
        "referenceTitle": "My SDK Name",
        "disableSort": false,
        "collapse": true,
        "resources": {
            "google": "https://www.google.com/"
        }
    },
    "opts": {
        "destination": "./docs/",
        "encoding": "utf8",
        "private": true,
        "recurse": true,
        "template": "./node_modules/jsdoc-template"
    }
}

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.

"templates": {
    "search": {
        "apiKey": "your-api-key",
        "indexName": "Your index name. Defaults to braintree.",
        "hitsPerPage": "Number of Results to show. Defaults to 7.",
    }
}

License

Licensed under the Apache2 license.

jsdoc-fresh dependencies

@jsdoc/salty

jsdoc-fresh development dependencies

gts typescript

FAQs

What is jsdoc-fresh?

Fresh JSDoc 3 Template. Visit Snyk Advisor to see a full health score report for jsdoc-fresh, including popularity, security, maintenance & community analysis.

Is jsdoc-fresh popular?

The npm package jsdoc-fresh receives a total of 4,309 weekly downloads. As such, jsdoc-fresh popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is jsdoc-fresh well maintained?

We found indications that jsdoc-fresh is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is jsdoc-fresh safe to use?

The npm package jsdoc-fresh 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 5 November-2024, at 01:48 (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-fresh

Fresh JSDoc 3 Template For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (4,309)

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

Fresh JSDoc Template

Responsive

Uses

Usage

Node.js Dependency

Example JSDoc Config

License

jsdoc-fresh dependencies

jsdoc-fresh development dependencies

FAQs

What is jsdoc-fresh?

Is jsdoc-fresh popular?

Is jsdoc-fresh well maintained?

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

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (4,309)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Fresh JSDoc Template

Responsive

Uses

Usage

Node.js Dependency

Example JSDoc Config

License

jsdoc-fresh dependencies

jsdoc-fresh development dependencies

FAQs

What is jsdoc-fresh?

Is jsdoc-fresh popular?

Is jsdoc-fresh well maintained?

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