Package Exports
- audit-export
- audit-export/src/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (audit-export) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Npm Audit Export 🕵️♂️
A convenient tool to export npm audit results to a comprehensive offline HTML page, providing a clear overview of your project's vulnerabilities.
Example of the output file from audit-export
Inspired by npm-audit-html, but with more Node.js versions supported, offline support and lightweight ⚡
Compatibility
This package is compatible with Node.js versions 10 through 20, as well as future versions.
The syntax remains consistent with the earlier version 1.0.0; however, it's advisable to always use the latest version, as it offers numerous new features and enhancements.
Installation
Install globally using npm:
npm install -g audit-exportUsage
The tool is packed with a help function to see the usage ways. To see it, just pass the --help option.
The simplest usage is as the following:
npm audit --json | audit-exportBut with more customizations you can use it in two different main ways:
npm audit --json | audit-export --folder <folder_path> --file <file_name.html> --title <HTML_file_title>or:
npm audit --json | audit-export <path> <file_name>All parameters are optional.
By default it will use the current folder, "audit-report.html" as file name, and "NPM Audit Report" as title.
Contributing
We welcome contributions from the community! Feel free to open issues and submit pull requests on our GitHub Issues page. Your feedback and suggestions are highly appreciated.
Download
You can download the package from npm.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Happy auditing! 🛡️🚀