# cleanup-package-json

> Cleans package.json file.

Latest version **0.2.1** (published 2016-08-08) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install cleanup-package-json
pnpm add cleanup-package-json
yarn add cleanup-package-json
bun add cleanup-package-json
```

Provides the command `cpj`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2016-08-08 |
| First published | 2016-08-05 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Martynas Zilinskas |
| Maintainers | quatrodev |
| Keywords | cleanup, package |

## Links

- npm: https://www.npmjs.com/package/cleanup-package-json
- Repository: https://github.com/quatrocode/cleanup-package-json
- Homepage: https://github.com/QuatroCode/cleanup-package-json
- Issues: https://github.com/QuatroCode/cleanup-package-json/issues
- npm.io page: https://npm.io/package/cleanup-package-json

## Dependencies (1)

- [yargs](https://npm.io/package/yargs.md) ^4.8.1

## Recent versions

- 0.2.1 (latest) — 2016-08-08
- 0.2.0 — 2016-08-08
- 0.1.0 — 2016-08-05
- 0.0.1 — 2016-08-05

## README

cleanup-package-json
=====================

## Get started
```sh
$ npm install cpj -g
```

## Features
- Removes unnecessary parts of `package.json`.

## Usage
```sh
$ cpj --help
```

### Examples
_Default config:_

Default config name is `cpj.config.json`.

```sh
$ cpj
```

_With custom file config:_
```sh
$ cpj -c custom-config.json
```

## Config example
```json
{
    "include": {
        "scripts": ["test"]
    },
    "exclude": {
        "keywords": ["*"],
        "scripts": ["*"]
    },
    "backup": true
}
```

| Argument     | Type                           | Default | Description                                               |
|--------------|--------------------------------|---------|-----------------------------------------------------------|
| include      | [arg: string]: Array\<string\> | none    | Parts that must be included.                              |
| exclude      | [arg: string]: Array\<string\> | none    | Parts that will be removed (Lower priority then include). |
| backup       | boolean                        | true    | Backups `package.json` to `package.bak.json`.             |
| writeChanges | boolean                        | true    | Writes changes to `package.json`.                         |

## License
Released under the [PGL-3.0 license](LICENSE).

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