clean-pkg-json
Advanced tools
Clean package.json before publish by removing unnecessary properties
Script to remove unnecessary properties from package.json on prepublish hook.
Support this project by ⭐️ starring and sharing it. Follow me to see what other cool projects I'm working on! ❤️
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.
npm install --save-dev clean-pkg-json
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",
},
}
| Flag | Description |
|---|---|
-k, --keep <property name> | Property names to keep. Accepts multiple flags or a comma-delimited list. |
-r, --remove <property name> | Property names to remove. 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 |
By default, these properties are preserved in package.json:
nameversionprivatepublishConfigscripts.preinstallscripts.installscripts.postinstallscripts.dependenciesfilesbinbrowsermainmandependenciespeerDependenciespeerDependenciesMetabundledDependenciesoptionalDependenciesenginesoscpudescriptionkeywordsauthormaintainerscontributorslicensehomepagerepositorybugsfundingtypeexportsimportssponsorpublisherdisplayNamecategoriesgalleryBannerpreviewcontributesactivationEventsbadgesmarkdownqnasponsorextensionPackextensionDependenciesextensionKindiconfesm2022fesm2020fesm2015esm2020es2020typestypingstypesVersionsFAQs
Clean package.json before publish by removing unnecessary properties
The npm package clean-pkg-json receives a total of 4,277 weekly downloads. As such, clean-pkg-json popularity was classified as popular.
We found that clean-pkg-json demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.
Security News
This episode explores the hard problem of reachability analysis, from static analysis limits to handling dynamic languages and massive dependency trees.
Security News
/Research
Malicious Nx npm versions stole secrets and wallet info using AI CLI tools; Socket’s AI scanner detected the supply chain attack and flagged the malware.