Skip to content

Commit 2628ead

Browse files
author
Martynas Žilinskas
committed
Added readme.
1 parent 97e3295 commit 2628ead

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

readme.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
cleanup-package-json
2+
=====================
3+
4+
## Get started
5+
```sh
6+
$ npm install cleanup-package-json -g
7+
```
8+
9+
## Features
10+
- Removes unnecessary parts of `package.json`.
11+
12+
## Usage
13+
```sh
14+
$ scss-bundle -h
15+
```
16+
17+
### Examples
18+
_Default config:_
19+
20+
Default config name is `cpj.config.json`.
21+
22+
```sh
23+
$ cleanup-package-json
24+
```
25+
26+
_With custom name config:_
27+
```sh
28+
$ cleanup-package-json -c custom-config.json
29+
```
30+
31+
## Config example
32+
```json
33+
{
34+
"include": {
35+
"scripts": ["test"]
36+
},
37+
"exclude": {
38+
"keywords": ["*"],
39+
"scripts": ["*"]
40+
},
41+
"backup": true
42+
}
43+
```
44+
45+
| Argument | Type | Default | Description |
46+
|--------------|--------------------------------|---------|-----------------------------------------------------------|
47+
| include | [arg: string]: Array\<string\> | none | Parts that must be included. |
48+
| exclude | [arg: string]: Array\<string\> | none | Parts that will be removed (Lower priority then include). |
49+
| backup | boolean | false | Backups `package.json` to `package.bak.json`. |
50+
| writeChanges | boolean | true | Writes changes to `package.json`. |
51+
52+
## License
53+
Released under the [PGL-3.0 license](LICENSE).

0 commit comments

Comments
 (0)