npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@team-supercharge/audit-ci-wrapper

v3.1.3

Published

![Node.js Package](https://github.com/team-supercharge/audit-ci-wrapper/workflows/Node.js%20Package/badge.svg)

Downloads

1,346

Readme

@team-supercharge/audit-ci-wrapper

Node.js Package

Features

This package wraps the result of npm audit and creates a report.

json and text report types currently supported.

Fails with exit code 1 if any package has vulnerabilities that matches the criteria.

The text reporter writes probable root cause text to the output, if that package is the one that causes the error.

NPM version support

This package requires at least NPM 7 since >3.0.0. If you want to use it with NPM 6, then install the latest 1.x version.

Running

It can run without installation.

npx @team-supercharge/audit-ci-wrapper

Or can be added to the project.

npx @team-supercharge/audit-ci-wrapper --install
npm install --save-dev @team-supercharge/audit-ci-wrapper
npm run audit

It can be done manually. Install, generate an auditconfig file and add to the project.

npm install --save-dev @team-supercharge/audit-ci-wrapper
npx @team-supercharge/audit-ci-wrapper --generate-config
{
  "scripts": {
    "audit": "npx @team-supercharge/audit-ci-wrapper --config auditconfig.json"
  }
}
npm run audit

Options

usage: @team-supercharge/audit-ci-wrapper [-h] [-c CONFIG] [-gc] [-i] [-q] [-v]

Audit wrapper application for npm.

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
                        The config json file for auditing.
  -gc, --generate-config
                        Generates config file.
  -i, --install         Generates config file and add script to package.json.
  -q, --quiet           Turns off verbose logging.
  -v, --version         show program's version number and exit

Configfile

The schema for the configfile can be found at configschema.json.

| Fieldname | Description | Values | | --- | --- | --- | | severity | Level of severity that makes audit fail. | critical, high, moderate, low | | ignoreDevelopmentDependencies | If true development dependencies will be ignored. | true, false | | reportType | The type of the output. | text, json | | npmExtraParams | Extra parameters can be passed to npm audit, like ['--registry', '<URL>'] | string[] | | whitelist | Object like dependencies of package.json. Key specifies a package name, the value is the whitelisted versions in semver format. | Record<string, string> |

Contribution

To develop run npm install, npm link and npm start. This will run currently compiled version.

To run the test run npm test or npm test:dev to watch for changes.

Release

In order to properly generate changelog and version tags, run npm run release once master is ready for it. Publish action will be triggered when newly created tag is released manually on Github UI.