Organize Package JSON (organize-pkg)

A tool to assist in creating a package.json file optimized for production environments.

Installation

Install the package as a development dependency:

npm install organize-pkg --save-dev

Flags

• -version|-v {string} - Override the package version. (since v1.3.2)

  # Override name and version while producing a dist package.json
  orgpkg -n my-lib -v 1.3.2 -p -o ./dist

• -help|-h {boolean} - Show CLI help and exit. (since v1.3.2)

  orgpkg -h
  organize-pkg -help

• -name|-n {string} - Change the package name if needed. (since v1.3.1)

  # e.g., original package name: "some-package-dev"
  orgpkg -n "some-package" -p
  # or
  orgpkg -name "some-package" -p

• -prod|-p {boolean} - Apply production output. Can omit the -out|-o option. (output to ./dist)

• -keys|-k {string} - Keys to be removed.

• -out|-o {string} - Specify the output path if needed.

• -keepDevs|-kd {string} - Specify the key names to be retained in devDependencies. Valid with the -prod|-p flag. (since v1.3.0)

  # Keep `devDependencies/some-entryName` and `devDependencies/some-entryName2`
  orgpkg -kd "some-entryName,some-entryName2" -p
  # or
  # Keep `devDependencies/some-entryName`
  orgpkg -kd some-entryName -p

Usage

organize-pkg -keys "<key>,<key>,..." -out ./output.json
# or
orgpkg -k "<key>,<key>,..." -out ./output.json
# help
orgpkg -h

Examples

• Version 1.2.4: When specifying the -prod|-p option, the -out|-o option can be omitted.

  # Output to "./dist/package.json"
  orgpkg -k "dependencies/some-module,bin/organize-pkg" -p

• Version 1.3.2: Add -version|-v and -help|-h.

  # Show help
  orgpkg -h
  # Override name and version
  orgpkg -n some-pkg -v 1.3.2 -p -o ./dist

• Version 1.2.3: Support for commands like:

  orgpkg -k "dependencies/some-module" -p -o ./dist

• Version 1.2.2: Synonym command orgpkg

  orgpkg -p -o ./output.json [-k "<key>,<key>,..."]

• Since version 1.2.1, shorthand options are available.

# File name is output as "./dist/package.json"
organize-pkg -keys "defs,//" -out ./dist
organize-pkg -k "defs,//" -o ./dist

# File name is output as "./dist/output.json"
organize-pkg -keys "defs,//" -out ./dist/output.json
organize-pkg -k "defs,//" -o ./dist/output.json

Removing Development Dependencies

To delete the devDependencies property required during development:

organize-pkg -keys "devDependencies" -out ./dist

Removing Any Property

To remove any property:

organize-pkg -keys "defs,//" -out ./dist

Skipping Scripts Like "postinstall"

When installing the desired module with (yarn|npm) install, specify the "-prod" option to remove properties such as "scripts", "devDependencies", "//<any text>?".

The value of the "-keys" option will be optional, and if specified, it will be merged.

organize-pkg -prod -out ./dist [-keys "defs"]
organize-pkg -p -o ./dist [-k "defs"]

License

This project is licensed under the MIT License.