https://github.com/luftywiranda13/remove-lockfiles

Prevent committing lockfiles
https://github.com/luftywiranda13/remove-lockfiles

cli cli-app commit cross-platform git git-hooks hooks lockfile npm pre-commit yarn

Last synced: 15 days ago
JSON representation

Prevent committing lockfiles

• Host: GitHub
• URL: https://github.com/luftywiranda13/remove-lockfiles
• Owner: luftywiranda13
• License: mit
• Created: 2017-08-08T14:30:11.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-06-03T09:20:12.000Z (over 4 years ago)
• Last Synced: 2024-10-10T23:12:09.965Z (29 days ago)
• Topics: cli, cli-app, commit, cross-platform, git, git-hooks, hooks, lockfile, npm, pre-commit, yarn
• Language: JavaScript
• Homepage:
• Size: 341 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# remove-lockfiles

> Prevent committing lockfiles

[![Package Version](https://img.shields.io/npm/v/remove-lockfiles.svg?style=flat-square)](https://www.npmjs.com/package/remove-lockfiles)

[![Downloads Status](https://img.shields.io/npm/dm/remove-lockfiles.svg?style=flat-square)](https://npm-stat.com/charts.html?package=remove-lockfiles&from=2016-04-01)

[![Build Status: Linux](https://img.shields.io/travis/luftywiranda13/remove-lockfiles/master.svg?style=flat-square)](https://travis-ci.org/luftywiranda13/remove-lockfiles)

[![Build Status: Windows](https://img.shields.io/appveyor/ci/luftywiranda13/remove-lockfiles/master.svg?style=flat-square&logo=appveyor)](https://ci.appveyor.com/project/luftywiranda13/remove-lockfiles/branch/master)

[![Coverage Status](https://img.shields.io/codecov/c/github/luftywiranda13/remove-lockfiles/master.svg?style=flat-square)](https://codecov.io/gh/luftywiranda13/remove-lockfiles)

## Why

* [Lockfiles are for apps, not for libraries/packages](https://github.com/sindresorhus/ama/issues/479#issuecomment-310661514)

* [Listing lockfiles in .gitignore is considered a bad approach](https://github.com/facebookincubator/create-react-app/pull/2014#issuecomment-300811661)

* _[Unstaging only](https://github.com/facebookincubator/create-react-app/pull/2700)_ will introduce new problems

* Uses [force-del](https://github.com/luftywiranda13/force-del) to get rid of lockfiles

* No need to force contributors to use `npm` or `yarn`

* No need to use 2 extra dot files (`.npmrc` and `.yarnrc`) to avoid generating lockfiles

* Works on macOS, Linux, and Windows

## Installation

```sh

npm install --save-dev remove-lockfiles

```

## Usage

### Pre-commit hook

Install [husky](https://github.com/typicode/husky):

```sh

npm install husky --save-dev

```

Edit `package.json` to include this configuration:

```js

{

  "scripts": {

    "precommit": "remove-lockfiles"

  }

}

```

Looking for alternative to `husky`? We can also use `remove-lockfiles` with [pre-commit](https://github.com/observing/pre-commit).

### CLI

Install `remove-lockfiles` globally:

```sh

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` 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](https://github.com/luftywiranda13/del-nm-cli) － Delete `node_modules` and lockfiles

* [force-del](https://github.com/luftywiranda13/force-del) － Force delete files or folders using glob patterns

* [has-lockfile](https://github.com/luftywiranda13/has-lockfile) － Detect lockfiles in the working directory

## License

MIT © [Lufty Wiranda](https://www.luftywiranda.com)