https://github.com/cy6erskunk/npm-audit-reporter-teamcity

Generate TeamCity code inspections from the output of `npm audit`
https://github.com/cy6erskunk/npm-audit-reporter-teamcity

npm-script teamcity

Last synced: 4 months ago
JSON representation

Generate TeamCity code inspections from the output of `npm audit`

• Host: GitHub
• URL: https://github.com/cy6erskunk/npm-audit-reporter-teamcity
• Owner: cy6erskunk
• License: mit
• Created: 2019-03-30T20:43:37.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-23T17:31:42.000Z (4 months ago)
• Last Synced: 2024-10-25T00:59:05.803Z (4 months ago)
• Topics: npm-script, teamcity
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/npm-audit-reporter-teamcity
• Size: 2.43 MB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## npm audit reporter for TeamCity

[![Build Status](https://github.com/cy6erskunk/npm-audit-reporter-teamcity/actions/workflows/nodejs.yml/badge.svg)](https://github.com/cy6erskunk/npm-audit-reporter-teamcity/actions/workflows/nodejs.yml)

[![NPM version](https://img.shields.io/npm/v/npm-audit-reporter-teamcity.svg)](https://www.npmjs.com/package/npm-audit-reporter-teamcity)

Generates TeamCity inspections from the [npm audit](https://docs.npmjs.com/cli/audit.html) report

![Demo report](tc-ui.png)

### Installation

1. Install packages

```

npm i npm-audit-reporter-teamcity

```

2. Add npm scripts to run checks locally and in a CI server, e.g.:

```

"audit:ci": "npm audit --json|npm-audit-reporter-teamcity"

```

3. 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:

```json

{

  "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`)