Skip to content
master
Go to file
Code

readme.md

remove-lockfiles

Prevent committing lockfiles

Package Version Downloads Status Build Status: Linux Build Status: Windows Coverage Status

Why

Installation

npm install --save-dev remove-lockfiles

Usage

Pre-commit hook

Install husky:

npm install husky --save-dev

Edit package.json to include this configuration:

{
  "scripts": {
    "precommit": "remove-lockfiles"
  }
}

Looking for alternative to husky? We can also use remove-lockfiles with pre-commit.

CLI

Install remove-lockfiles globally:

npm install --global remove-lockfiles

Run the script:

$ remove-lockfiles --help

  Usage
    $ remove-lockfiles [path|options]

  Options
    --shrinkwrap  Remove `npm-shrinkwrap.json` if found

  Examples
    $ remove-lockfiles
    $ remove-lockfiles ../foo
    $ remove-lockfiles --shrinkwrap
    $ remove-lockfiles --shrinkwrap ../foo

API

removeLockfiles([options])

Returns Promise<Array> of deleted lockfiles.

options

Type: Object

cwd

Type: string
Default: process.cwd()

Current working directory.

shrinkwrap

Type: boolean
Default: false

Set to true to remove npm-shrinkwrap.json.

Related

  • del-nm-cli - Delete node_modules and lockfiles
  • force-del - Force delete files or folders using glob patterns
  • has-lockfile - Detect lockfiles in the working directory

License

MIT © Lufty Wiranda

You can’t perform that action at this time.