# npmclean

> Clean local module before install

Latest version **1.1.1** (published 2017-07-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install npmclean
pnpm add npmclean
yarn add npmclean
bun add npmclean
```

Provides the command `npmclean`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2017-07-01 |
| First published | 2017-06-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | bySabi Files |
| Maintainers | bysabi |
| Keywords | npm, clean, npmclean, development, package-lock.json |

## Links

- npm: https://www.npmjs.com/package/npmclean
- Repository: https://github.com/bySabi/npmclean
- Homepage: https://github.com/bySabi/npmclean#readme
- Issues: https://github.com/bySabi/npmclean/issues
- npm.io page: https://npm.io/package/npmclean

## Dependencies (6)

- [execa](https://npm.io/package/execa.md) ^0.7.0
- [globby](https://npm.io/package/globby.md) 6.x.x
- [bluebird](https://npm.io/package/bluebird.md) 3.x.x
- [fs-extra](https://npm.io/package/fs-extra.md) 3.x.x
- [safe-commander](https://npm.io/package/safe-commander.md) 2.x.x
- [loglevel-colored-level-prefix](https://npm.io/package/loglevel-colored-level-prefix.md) 1.x.x

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.1.1 (latest) — 2017-07-01
- 1.1.0 — 2017-07-01
- 1.0.3 — 2017-06-25
- 1.0.2 — 2017-06-25
- 1.0.1 — 2017-06-23
- 1.0.0 — 2017-06-23

## README

# npmclean

[![npm version](https://badge.fury.io/js/npmclean.svg)](https://badge.fury.io/js/npmclean)
[![npm downloads](https://img.shields.io/npm/dm/npmclean.svg?style=flat-square)](https://www.npmjs.com/package/npmclean)
[![Windows Tests](https://img.shields.io/appveyor/ci/bySabi/npmclean/master.svg?label=Windows%20Tests)](https://ci.appveyor.com/project/bySabi/npmclean)
[![bitHound Overall Score](https://www.bithound.io/github/bySabi/npmclean/badges/score.svg)](https://www.bithound.io/github/bySabi/npmclean)

> In development flows some `npm 5` new features can be tiresome. With `npmclean` you could easily:
- remove `package-lock.json` only
- clean all modules, cache and `package-lock.json`

## Installation

### npm
```bash
$ npm install npmclean -g
```

## Shell usage
### Full clean & install all modules
```bash
$ cd my-module
$ npmclean && npm i
```

### Install new modules only
```bash
$ cd my-module
$ npmclean -l && npm i
```

## `package.json` useful run-scripts
```json
"scripts": {
  ...
  "npmi": "npmclean -l && npm i",
  "clean-install": "npmclean && npm i"
}
```

## CLI options
```bash
$ npmclean -h

  Usage: npmclean [options]

  Options:

    -h, --help     output usage information
    -V, --version  output the version number
    -l, --rm-lock  Remove only package-lock.json
    -s, --silent   Silent output console
```

## How full clean environment is performed

```bash
$ rm -rf node_modules
$ rm -rf package-lock.json*
$ npm cache clean --force
```

## Contributing

* Documentation improvement
* Feel free to send any PR

## License

[ISC][isc-license]

[isc-license]:./LICENSE

---
_Source: https://npm.io/package/npmclean · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._