Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/privatenumber/clean-pkg-json
Script to remove unnecessary properties from package.json on prepublish hook
https://github.com/privatenumber/clean-pkg-json
clean hook npm package-json prepublish
Last synced: 3 months ago
JSON representation
Script to remove unnecessary properties from package.json on prepublish hook
- Host: GitHub
- URL: https://github.com/privatenumber/clean-pkg-json
- Owner: privatenumber
- License: mit
- Created: 2022-07-06T20:39:41.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2022-09-30T05:03:26.000Z (over 2 years ago)
- Last Synced: 2024-10-19T01:11:29.309Z (3 months ago)
- Topics: clean, hook, npm, package-json, prepublish
- Language: TypeScript
- Homepage:
- Size: 54.7 KB
- Stars: 52
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# clean-pkg-json
Script to remove unnecessary properties from `package.json` on prepublish hook.
Support this project by ⭐️ starring and sharing it. [Follow me](https://github.com/privatenumber) to see what other cool projects I'm working on! ❤️
## 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`](https://eslint.org/docs/latest/user-guide/configuring/), [`prettier`](https://prettier.io/docs/en/configuration.html), [`lint-staged`](https://github.com/okonet/lint-staged), [`simple-git-hooks`](https://github.com/toplenboren/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.
## Install
```
npm install --save-dev clean-pkg-json
```
## Usage
Add `clean-pkg-json` to the [`prepack` hook](https://docs.npmjs.com/cli/v8/using-npm/scripts#:~:text=on%20npm%20publish.-,prepack,-Runs%20BEFORE%20a), which runs before `npm publish` and `npm pack`.
```json5
// package.json
{
"name": "my-package",
// ...
"scripts": {
// ...
"prepack": "clean-pkg-json"
}
}
```
### Flags
| Flag | Description |
| - | - |
| `-k, --keep ` | 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`:
#### [npm](https://docs.npmjs.com/cli/v8/configuring-npm/package-json)
- `name`
- `version`
- `private`
- `publishConfig`
- `scripts.preinstall`
- `scripts.install`
- `scripts.postinstall`
- `scripts.dependencies`
- `files`
- `bin`
- `browser`
- `main`
- `man`
- `dependencies`
- `peerDependencies`
- `peerDependenciesMeta`
- `bundledDependencies`
- `optionalDependencies`
- `engines`
- `os`
- `cpu`
- `description`
- `keywords`
- `author`
- `contributors`
- `license`
- `homepage`
- `repository`
- `bugs`
- `funding`
#### CDNs
- [`jsdelivr`](https://www.jsdelivr.com/features#publishing-packages)
- [`unpkg`](https://unpkg.com/)
#### [Node.js](https://nodejs.org/api/packages.html#nodejs-packagejson-field-definitions)
- `type`
- `exports`
- `imports`
#### [VSCode Extension Manifest](https://code.visualstudio.com/api/references/extension-manifest)
- `sponsor`
- `publisher`
- `displayName`
- `categories`
- `galleryBanner`
- `preview`
- `contributes`
- `activationEvents`
- `badges`
- `markdown`
- `qna`
- `sponsor`
- `extensionPack`
- `extensionDependencies`
- `extensionKind`
- `icon`
#### [Angular Package Format](https://angular.io/guide/angular-package-format#legacy-resolution-keys)
- `fesm2020`
- `fesm2015`
- `esm2020`
- `es2020`
#### [TypeScript](https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html)
- `types`
- `typings`
- `typesVersions`
#### Bundlers (Webpack, Rollup, esbuild)
- [`module`](https://stackoverflow.com/questions/42708484/what-is-the-module-package-json-field-for)
- [`sideEffects`](https://webpack.js.org/guides/tree-shaking/)