https://github.com/lee5i3/audit-check

NPM module for filtering down the npm audit functionality
https://github.com/lee5i3/audit-check

audit-check nodejs npm-audit npmjs

Last synced: 4 months ago
JSON representation

NPM module for filtering down the npm audit functionality

• Host: GitHub
• URL: https://github.com/lee5i3/audit-check
• Owner: lee5i3
• License: mit
• Archived: true
• Created: 2020-03-18T20:29:47.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-03-30T19:20:54.000Z (about 4 years ago)
• Last Synced: 2025-01-17T23:38:57.937Z (4 months ago)
• Topics: audit-check, nodejs, npm-audit, npmjs
• Language: JavaScript
• Homepage:
• Size: 744 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# audit-check

### Badges  

[![Build Status](https://circleci.com/gh/lee5i3/audit-check.svg?style=shield)](https://circleci.com/gh/lee5i3/audit-check)

[![codecov](https://codecov.io/gh/lee5i3/audit-check/branch/master/graph/badge.svg)](https://codecov.io/gh/lee5i3/audit-check)

[![Known Vulnerabilities](https://snyk.io/test/github/lee5i3/audit-check/badge.svg)](https://snyk.io/test/github/lee5i3/audit-check)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=lee5i3_audit-check&metric=alert_status)](https://sonarcloud.io/dashboard?id=lee5i3_audit-check)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f91b80021c6d4f0cb4f1dda56f580273)](https://www.codacy.com/manual/lee5i3/audit-check?utm_source=github.com&utm_medium=referral&utm_content=lee5i3/audit-check&utm_campaign=Badge_Grade)

### Install

```

npm install -g audit-check

```

### Common Configuration Options

| Options | Description  | Type | Default  |

|---|---|---|---|

| ```severity``` | Severity to ignore, will filter from the result and return the correct exit code | ```String```  | ```info```  |

| ```json``` | Weither to return a JSON or Table | ```Boolean```  | ```false```  |

| ```ignore-dev``` | Weither to ignore dev-dependencies  | ```Boolean```  | ```false``` |

| ```output``` | Path to save output to  | ```String```  |  |

| ```whitelist``` | List of module names to ignore, comma-separated | ```String``` | |

### Examples

Outputs a JSON but excluding debug

```

audit-check --json --whitelist debug

```

Outputs a JSON but only showing high or greater severity

```

audit-check --severity high --json

```

Outputs a json to file with only low and higher severity, excludes debug and only from production dependencies

```

audit-check --severity low --whitelist debug --ignore-dev --output ./result.json

```

Outputs a table with only low and higher severity, excludes debug and only from production dependencies

```

audit-check --severity low --whitelist debug --ignore-dev

```