yarn-audit-ci

CI-friendly yarn audit wrapper. Only returns a non-zero exit code for at least the requested severity level.

Installation

1$ yarn add yarn-audit-ci --dev

Usage

In the console:

1$ yarn-audit-ci             // only fail on critical issues (default)
2$ yarn-audit-ci --critical  // only fail on critical issues (explicit)
3$ yarn-audit-ci --high      // only fail on high or critical issues
4$ yarn-audit-ci --moderate  // only fail on at least moderate issues
5$ yarn-audit-ci --low       // only fail on at least low issues
6$ yarn-audit-ci --info      // fail on any issues

Using shorter options:

1$ yarn-audit-ci -c          // only fail on critical issues (explicit)
2$ yarn-audit-ci -h          // only fail on high or critical issues
3$ yarn-audit-ci -m          // only fail on at least moderate issues
4$ yarn-audit-ci -l          // only fail on at least low issues
5$ yarn-audit-ci -i          // fail on any issues

Using a shorter yaudit alias:

1$ yaudit
2$ yaudit -h
3$ yaudit --high

In the console using yarn:

1$ yarn yarn-audit-ci --high
2$ yarn yaudit --high

In the package.json

1// package.json
2"scripts": {
3  "audit": "yarn-audit-ci"
4},
5
6// console
7$ yarn run audit

In the package.json using a script name different from audit, which is a yarn CLI command thus explicit run in the previous example:

1// package.json
2"scripts": {
3  "audit:ci": "yarn-audit-ci",
4  "audit:high": "yarn-audit-ci --high"
5},
6
7// console
8$ yarn audit:ci
9$ yarn audit:high

In the package.json using a yaudit alias:

1// package.json
2"scripts": {
3  "audit:high": "yaudit --high"
4},
5
6// console
7$ yarn audit:high

In package.json in combination with the yall-scripts tool:

1// package.json
2"scripts": {
3  "audit": "yaudit",
4  "check": "eslint ./src",
5  "test": "jest ./src",
6  "all": "yall audit check test"
7},
8
9// console
10$ yarn all