Clean Package

This clean-package tool is used for removing development configuration from 'package.json' before publishing the package to NPM.

Install

npm install clean-package --save-dev

Integrated Usage

The clean-package tool works directly on the 'package.json' file, to avoid breaking the NPM lifecycle. This allows you to add a script to the 'package.json' to clean the file during packing.

{
  "name": "my-package",
  "version": "1.0.0",
  "scripts": {
    "prepack": "clean-package",
    "postpack": "clean-package restore"
  }
}

See CLI Usage for independent usage instructions.

JSON Configuration Files

Options can be configured in clean-package.config.json at the root of your project (where the package.json is).

{
  "indent": 2,
  "remove": [
    "eslintConfig",
    "jest"
  ]
}

Alternatively, you can choose to specify your configuration from within package.json using the clean-package key like so:

{
  "name": "my-package",
  "version": "1.0.0",
  "clean-package": {
    "indent": 2,
    "remove": [
      "eslintConfig",
      "jest"
    ]
  }
}

JavaScript Configuration File

You can also create the configuration using JavaScript in the clean-package.config.js at the root of your project:

module.exports = {
  indent: '\t',
  replace: {
    'config.port': '8080'
  }
};

Options

backupPath

Default: './package.json.backup'

A String specifying the location and filename to which the package.json will be backed up.

indent

Default: 2

A String or Number defining the indentation that's used to format the cleaned package.json. See the space parameter of JSON.stringify for more information.

remove

Default: ['clean-package']

A String[] specifying the keys to be removed from the cleaned package.json; otherwise, null when nothing is to be removed.

Deeper keys can be accessed using a dot (e.g., 'key.keyInsideKey'). Likewise, arrays are accessible using brackets (e.g., 'key.arrKey[0]').

replace

Default: null

An Object specifying the keys to be replaced in the cleaned package.json; otherwise, null when nothing is to be replaced.

Deeper keys and arrays are accessible in the same manner. Additionally, the replaced keys may receive any valid JSON value, including objects.

Command Line Usage

clean-package [<backup-path>] [<option>...]

where <option> is one of:

  -i,  --indent <value>                 Specify the indentation, overriding existing configuration.

  -rm, --remove <key>...                Specify the keys to remove, overriding existing configuration.

       --removeAdd <key>...             Same as --remove without overriding existing configuration.

  -r,  --replace <key>=<value>...       Specify the keys to replace, overriding existing configuration.

       --replaceAdd <key>=<value>...    Same as --replace without overriding existing configuration.

clean-package restore [<backup-path>]

alias: r

How do I remove package scripts and use clean-package restore?

If you're integrating clean-package into the NPM lifecycle, removing all the package.json scripts with clean-package will also remove them from the current execution. This is just how NPM works.

For example, this configuration will remove the postpack script before it is every requested by npm pack or npm publish, thereby effectively removing the event from the executing lifecycle.

{
  "scripts": {
    "prepack": "clean-package",
    "postpack": "clean-package restore"
  },
  "clean-package": {
    "remove": [
      "clean-package",
      "scripts"
    ]
  }
}

There are multiple ways to work around this (more than are offered here). One solution might be to manual run the command with npx clean-package restore. Another might be to define a custom script that would call pack and clean-package in sequence:

{
  "scripts": {
    "prepack": "clean-package",
    "new:pack": "npm pack && clean-package restore",
    "new:publish": "npm publish && clean-package restore"
  }
}