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

@competec/yarn-audit-competec

v2.0.0

Published

Competec Audit-Modules

Downloads

7

Readme

This module is built on the original yarn audit command yarn audit. With the following additional features:

  1. End with a non-zero code, if audit advisories exists for packages in your node-modules
  2. Allow suppression of specified advisories for any given module
  3. Generate a json file containing the yarn audit summary

Installation

  1. Install the npm audit module (yarn add yarn-audit-competec)
  2. Add the suppression file
  3. Add the following script to your package.json
"audit:competec": "yarn audit-competec",

Suppression file

The suppression file ~/.yarn-audit-competec/suppressions.js should be places in the folder .yarn-audit-competec, which should be located at the root of your project and structured as follows:

module.exports = {
    list: [
        {
            githubAdvisoryId: 'GHSA-hjp8-2cm3-cc45',
            suppress: {
                until: '2022-12-31Z',
                reason: 'Third party',
            },
        },
        ...more suppression entries
    ],
}
  • githubAdvisoryId: The Github Advisory ID of the entry you wish to suppress
  • suppress.until: The validity of the grace period until this audit is finished with error
  • suppress.reason: A note for yourself, to remember why you are suppressing this advisory

Audit summary

An audit summary is generated in JSON format and is structured as follows:

  • ts: The timestamp at which the audit took place
  • summary.vulnerabilities: a map of all severity levels found and the frequencies
  • summary.dependencies: the number of modules with advisories in the dependencies
  • summary.devDependencies: the number of modules with advisories in the devDependencies
  • summary.optionalDependencies: the number of modules with advisories in the optionalDependencies
  • summary.totalDependencies: the total number of modules with advisories

Example of audit summary:

{
  "ts": 1652107729515,
  "summary": {
    "vulnerabilities": {
      "info": 0,
      "low": 0,
      "moderate": 0,
      "high": 0,
      "critical": 0
    },
    "dependencies": 4,
    "devDependencies": 0,
    "optionalDependencies": 0,
    "totalDependencies": 4
  }
}

Version history

  • 1.0.0: Initial release
  • 1.0.1: Ignore licence check
  • 1.0.2: Treat "Unknown error" as failure
  • 2.0.0: removed githubAadvisoryId in favor of githubAdvisoryId in suppressions.js file