Clean Pkg JSON

clean-pkg-json

Publishes only consumer-relevant package.json properties using an allowlist.

Setup

{
    "scripts": {
        "prepack": "clean-pkg-json"
    }
}

When chaining with other prepack commands:

{
    "scripts": {
        "prepack": "pnpm build && clean-pkg-json"
    }
}

Flags

Both --keep and --remove accept multiple flags (-k foo -k bar) or comma-delimited lists (-k foo,bar).

Use --dry to preview changes before writing.

npm pack --dry-run and npm publish --dry-run are also auto-detected (via npm_config_dry_run) — no write happens when npm itself is in dry-run mode.

Behavior

The tool reads ./package.json in the current directory, keeps only allowlisted properties, and writes the result back in place.

Scripts Handling

Scripts use dot-notation in the allowlist. Only install hooks are preserved by default:

• scripts.preinstall
• scripts.install
• scripts.postinstall
• scripts.dependencies

To preserve additional scripts:

clean-pkg-json --keep scripts.prepare

If no scripts remain after filtering, the scripts key itself is omitted.

Default Allowlist