Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/harksys/npmvet
A simple CLI tool for vetting npm package versions
https://github.com/harksys/npmvet
checker checking ci ci-automation cli npm package packages version versions vet
Last synced: 3 months ago
JSON representation
A simple CLI tool for vetting npm package versions
- Host: GitHub
- URL: https://github.com/harksys/npmvet
- Owner: harksys
- License: mit
- Created: 2017-01-27T19:27:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-01T19:54:57.000Z (over 1 year ago)
- Last Synced: 2024-03-09T17:46:33.562Z (4 months ago)
- Topics: checker, checking, ci, ci-automation, cli, npm, package, packages, version, versions, vet
- Language: TypeScript
- Homepage: https://harksys.com/labs/npm-vet-a-simple-cli-tool-for-checking-npm-package-versions
- Size: 523 KB
- Stars: 204
- Watchers: 8
- Forks: 11
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Lists
- awesome - npmvet - A simple CLI tool for vetting npm package versions (TypeScript)
- awesome-web-dev-resources - npmvet
README
[](https://ci.appveyor.com/project/andrewhathaway/npmvet/branch/master)
NPM Vet is a simple CLI tool to help vet your npm package versions. NPM Vet can be used locally, or as a CI build-step to prevent builds passing with mismatched package versions. To read more about NPM Vet, visit the [Hark website](https://harksys.com/labs/npm-vet-a-simple-cli-tool-for-checking-npm-package-versions).
## Installation
$ npm install npmvet -g
## Usage
Usage: npmvet [options]
Options:
-h, --help output usage information
-V, --version output the version number
-p, --package package.json file location (Default: .)
-m, --modules node_modules folder location (Default: .)
-r, --renderer Renderer to use (Default: inlinetable)
-s, --strict Using the CI renderer, fail build if any packages unlocked (Default: false, flag)
## Strict Mode
If you're using the CI renderer (see below) the `-s` flag will enable strict mode. In which builds will fail if versions are unlocked, not just unmatching.
## Renderers
Renderers are used to dictate how to output the data NPM Vet collects. The default is `inlinetable`.
### Inline Table
$ npmvet -r inlinetable
The default renderer, `inlinetable` will print a table inline with your current process. You can use this locally to visualise package differences.
### CI
$ npmvet -r ci
To prevent your CI builds passing with mismatched package versions, use the CI renderer. If any package version mismatches are found, the build will fail:
Or if there are no mismatching package versions, your build will continue (and hopefully pass!):
### Blessed
The `blessed` renderer will render a table inside a screen, that has be exited by the user to escape.
$ npmvet -r blessed
### JSON
The `JSON` renderer will print a JSON array with match information for each package.
$ npmvet -r json
```json
[
{
"name": "blessed",
"packageVersion": "0.1.81",
"installedVersion": "0.1.81",
"matches": true,
"locked": false
},
{
"name": "chalk",
"packageVersion": "1.1.3",
"installedVersion": "1.1.3",
"matches": true,
"locked": false
},
{
"name": "jest",
"packageVersion": "18.1.0",
"installedVersion": "18.1.0",
"matches": true,
"locked": false
}
]
```
## Contributing
For information regarding contributing to this project, please read the [Contributing](./CONTRIBUTING.md) document.
## License
[MIT License](./LICENSE.md)