Generates an npm audit badge
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
__tests__
bin
src
.editorconfig
.gitignore
CONTRIBUTING.md
LICENSE
README.md
code-of-conduct.md
package-lock.json
package.json

README.md

audit-badge

Generates a badge with the number of vulnarable packages in your package.json

Installing

For local usage:

npm i audit-badge --save-dev

For global usage:

npm i audit-badge -g

One time remote execution:

npx audit-badge

Usage

$ audit-badge -h

  Usage: audit-badge [options]

  Options:

    -v, --version            output the version number
    -c, --config <location>  Set path for package.json to be introspected, uses cwd as default
    -p, --production         Scan for production vulnarabilities only
    -q, --quiet              No reporting output
    -o, --output <file>      Pathname of the output file, will write to stdout if not given
    -h, --help               output usage information

Running the tests

You can run the test with:

npm test

And coding style tests

This project adheres to the rules of StandardJS

npm run lint

Built With

  • Dropwizard - The web framework used
  • Maven - Dependency Management
  • ROME - Used to generate RSS Feeds

Contributing

Please read CONTRIBUTING.md for details on the process for submitting pull requests to us and code-of-conduct.md for details on our code of conduct when contributing.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details