Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lirantal/lockfile-prune

Lockfiles have needs too and this package takes care of them
https://github.com/lirantal/lockfile-prune

cli lock-file lockfile nodejs shrinkwrap

Last synced: about 2 months ago
JSON representation

Lockfiles have needs too and this package takes care of them

Awesome Lists containing this project

README

        


lockfile-prune


Lockfiles have needs too and this package takes care of them


npm version
license
downloads
build
codecov
Known Vulnerabilities
Responsible Disclosure Policy

# About

This package prunes any devDependencies entries in an npm's lockfile, supporting
either `npm-shrinkwrap.json` or `package-lock.json`.

# Usage

```bash
npx lockfile-prune
```

# Example

If you use this as part of an automated flow for releasing packages with
something like `semantic-release` then you only need to npx' the lockfile
before the release process.

However, you can also automate it in the following way, by adding these
run-script hooks into `package.json`:

```json
"scripts": {
"prepublishOnly": "npx lockfile-prune npm-shrinkwrap.json",
"postpublish": "git checkout npm-shrinkwrap.json"
}
```

The `postpublish` hook isn't strictly necessary on build systems but
can prove useful to maintain the same git tree if you are publishing
from a local development machine.

# Contributing

Please consult [CONTRIBUTING](./CONTRIBUTING.md) for guidelines on contributing to this project.

# Author

**lockfile-prune** © [Liran Tal](https://github.com/lirantal), Released under the [Apache-2.0](./LICENSE) License.