-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Martynas Žilinskas
committed
Aug 5, 2016
1 parent
97e3295
commit 2628ead
Showing
1 changed file
with
53 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
cleanup-package-json | ||
===================== | ||
|
||
## Get started | ||
```sh | ||
$ npm install cleanup-package-json -g | ||
``` | ||
|
||
## Features | ||
- Removes unnecessary parts of `package.json`. | ||
|
||
## Usage | ||
```sh | ||
$ scss-bundle -h | ||
``` | ||
|
||
### Examples | ||
_Default config:_ | ||
|
||
Default config name is `cpj.config.json`. | ||
|
||
```sh | ||
$ cleanup-package-json | ||
``` | ||
|
||
_With custom name config:_ | ||
```sh | ||
$ cleanup-package-json -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 | false | Backups `package.json` to `package.bak.json`. | | ||
| writeChanges | boolean | true | Writes changes to `package.json`. | | ||
|
||
## License | ||
Released under the [PGL-3.0 license](LICENSE). |