clean-pkg-json
Script to remove unnecessary properties from package.json on prepublish hook.
Support this project by
Why?
package.json is primarily for declaring an npm package and describing how it can be consumed.
However, it can often get bloated with development concerns such as devDependencies and configuration like eslintConfig, prettier, lint-staged, simple-git-hooks, etc.
Use clean-pkg-json in a prepublish hook to remove unnecessary properties from package.json. Useful in micropackages where every byte matters.
Usage
Add clean-pkg-json to the prepack hook, which runs before npm publish and npm pack.
// package.json
{
"name": "my-package",
// ...
"scripts": {
// ...
"prepack": "clean-pkg-json"
}
}
Flags
| Flag | Description |
|---|---|
-k, --keep <property name> |
Property names to keep. Accepts multiple flags or a comma-delimited list. |
-v, --verbose |
Verbose logs. |
-d, --dry |
Dry run mode. Instead of writing to disk, it will log it. |
-h, --help |
Show help |
--version |
Show version |
Default preserved properties
By default, these properties are preserved in package.json:
name, version, private, publishConfig, type, scripts.preinstall, scripts.install, scripts.postinstall, scripts.prepublish, scripts.preprepare, scripts.prepare, scripts.postprepare, files, bin, browser, main, module, types, exports, imports, man, dependencies, peerDependencies, peerDependenciesMeta, bundledDependencies, optionalDependencies, engines, os, cpu, description, keywords, author, contributors, license, homepage, repository, bugs, funding
7.2k Jan 9, 2023
37 Nov 22, 2022
18 Nov 30, 2022
2 May 15, 2022
1 Dec 25, 2021
2.8k Jan 5, 2023
2 Mar 29, 2022
51 Dec 13, 2022
4 Nov 28, 2022
34 Dec 18, 2022