npm-audit-visualizer v1.0.0-alpha.3

npm-audit-visualizer

A web-based tool to visualize audit reports generated by npm audit.

Previews

TODO: Add screenshots of the tool

Get the tool

npm install -g npm-audit-visualizer

To verify that the installation was successful, please try the --help flag:

npm-audit-visualizer --help

Usage

Navigate to a project that has package vulnerabilities and generate an audit report:

npm audit --json > audit.json

Then, run the tool on the generated audit report:

npm-audit-visualizer -f audit.json

By default, this should automatically open a new page in your web browser at the URL: http://localhost:1248. If it does not, please try navigating to that URL manually.

About

What

npm-audit-visualizer is a web-based tool to visualize audit reports generated by npm audit.

Why

With v7 of npm, the npm audit command was updated & it no longer displays results in a tabular format.

While the new textual format still contains useful information, there were visual elements to the tabular format that made it slightly easier to trace the vulnerability paths & dependencies.

The goal of this tool is to supplement the current textual output of npm audit with a visual interface that can help decipher & resolve vulnerabilities quicker in npm projects.

How

TODO

Development

This section will describe how to get the project setup for local development.

Dependencies

To work with this project, you will need to have the following dependencies installed:

• Node.js (v20+)
  • Official
  • fnm
  • nvm

Get the source

This project is hosted at: https://github.com/nrednav/npm-audit-visualizer

To clone it locally:

HTTPS:

git clone https://github.com/nrednav/npm-audit-visualizer.git

SSH:

git clone git@github.com:nrednav/npm-audit-visualizer.git

Installation

To install the project's dependencies:

cd npm-audit-visualizer/
npm install

Building

To build the project:

npm run build

This will also build the web-app.

Testing

To run all the project's tests:

npm run test

Alternatively, you can run just the web-app tests with:

npm run test:web-app

Run

To run the tool:

npm run dev -- -f <path/to/audit.json>

You can also run the tool in debug mode using the -d flag:

npm run dev -- -d -f <path/to/audit.json>

This will output additional logs for each stage the tool completes.

Issues & Requests

To request a new feature or report a bug, please open an issue by clicking here.

Resources

TODO: Add any resources that are relevant