Socket
Socket
Sign inDemoInstall

clean-pkg-json

Package Overview
Dependencies
0
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    clean-pkg-json

Clean package.json before publish by removing unnecessary properties


Version published
Weekly downloads
323
decreased by-16.54%
Maintainers
1
Install size
42.3 kB
Created
Weekly downloads
 

Readme

Source

clean-pkg-json

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! ❤️

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

FlagDescription
-k, --keep <property name>Property names to keep. Accepts multiple flags or a comma-delimited list.
-v, --verboseVerbose logs.
-d, --dryDry run mode. Instead of writing to disk, it will log it.
-h, --helpShow help
--versionShow version

Default preserved properties

By default, these properties are preserved in package.json:

npm
  • 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
Node.js
  • type
  • exports
  • imports
VSCode Extension Manifest
  • sponsor
  • publisher
  • displayName
  • categories
  • galleryBanner
  • preview
  • contributes
  • activationEvents
  • badges
  • markdown
  • qna
  • sponsor
  • extensionPack
  • extensionDependencies
  • extensionKind
  • icon
Angular Package Format
  • fesm2020
  • fesm2015
  • esm2020
  • es2020
TypeScript
  • types
  • typings
  • typesVersions
Bundlers (Webpack, Rollup, esbuild)

Keywords

FAQs

Last updated on 25 Aug 2022

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc