Skip to content

cy6erskunk/npm-audit-reporter-teamcity

Repository files navigation

npm audit reporter for TeamCity

Build Status NPM version

Generates TeamCity inspections from the npm audit report Demo report

Installation

  1. Install packages
npm i npm-audit-reporter-teamcity
  1. Add npm scripts to run checks locally and in a CI server, e.g.:
"audit:ci": "npm audit --json|npm-audit-reporter-teamcity"
  1. Configure build step in TeamCity e.g. Command Line runner with script to install dependencies and run checks:
npm install
npm run audit:ci

Configuration

Put npm-audit-reporter.conf.json config file in a project root directory to override any of the dafault values:

{
  "inspectionTypeId": "npm-audit-security-inspection",
  "inspectionName": "NPM audit security inspection",
  "inspectionCategory": "security",
  "inspectionSeverity": "WARNING",
}
  • To debug provide truthy DEBUG env variable (e.g. DEBUG=1 npm run audit:ci)