Package Health Score

53 / 100

security
No known security issues
popularity
Recognized
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.3.0	\|	11/2018	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Unrecognized

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 (10,473)

GitHub Stars: 176
Forks: 56
Contributors: 20

Direct Usage Popularity

The npm package braintree-jsdoc-template receives a total of 10,473 downloads a week. As such, we scored braintree-jsdoc-template popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package braintree-jsdoc-template, we found that it has been starred 176 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: No
Code of Conduct: No
Contributors: 20
Funding: No

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

We found a way for you to contribute to the project! Looks like braintree-jsdoc-template is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 0
Open PR: 0
Last Release: 6 years ago
Last Commit: 1 year ago

Further analysis of the maintenance status of braintree-jsdoc-template 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 braintree-jsdoc-template 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.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

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: 6 years
Dependencies: 0 Direct
Versions: 2
Install Size: 1.47 MB
Dist-tags: 1
# of Files: 57
Maintainers: 1
TS Typings: No

braintree-jsdoc-template 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

Braintree JSDoc Template

Note! This is not in any way made by me, I simply published it to NPM for convenience.

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

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-template"
}

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.

braintree-jsdoc-template development dependencies

eslint eslint-config-braintree taffydb

FAQs

What is braintree-jsdoc-template?

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

Is braintree-jsdoc-template popular?

The npm package braintree-jsdoc-template receives a total of 10,473 weekly downloads. As such, braintree-jsdoc-template popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is braintree-jsdoc-template well maintained?

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

Is braintree-jsdoc-template safe to use?

The npm package braintree-jsdoc-template 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 20 November-2024, at 14:10 (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

braintree-jsdoc-template

Braintree 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 (10,473)

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

Braintree JSDoc Template

Responsive

Uses

Usage

Node.js Dependency

Example JSDoc Config

License

braintree-jsdoc-template development dependencies

FAQs

What is braintree-jsdoc-template?

Is braintree-jsdoc-template popular?

Is braintree-jsdoc-template well maintained?

Is braintree-jsdoc-template 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 (10,473)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Braintree JSDoc Template

Responsive

Uses

Usage

Node.js Dependency

Example JSDoc Config

License

braintree-jsdoc-template development dependencies

FAQs

What is braintree-jsdoc-template?

Is braintree-jsdoc-template popular?

Is braintree-jsdoc-template well maintained?

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