Have ideas to improve npm?Join in the discussion! »

    remove-lockfiles

    2.1.3 • Public • Published

    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

    Contributors

    Thanks goes to these people (emoji key):


    Lufty Wiranda

    💻 📖 🚇

    Sindre Sorhus

    💬 🤔

    Dan Abramov

    💬 🤔

    Ade Viankakrisna Fadlil

    💬 🤔

    Jon Crenshaw

    🤔

    This project follows the all-contributors specification. Contributions of any kind welcome!

    License

    MIT © Lufty Wiranda

    Install

    npm i remove-lockfiles

    DownloadsWeekly Downloads

    51

    Version

    2.1.3

    License

    MIT

    Unpacked Size

    9.26 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar