# prettier-package-json > Prettier formatter for package.json files Latest version **2.8.0** (published 2022-12-23) · MIT license · 0 weekly downloads ## Install ```sh npm install prettier-package-json pnpm add prettier-package-json yarn add prettier-package-json bun add prettier-package-json ``` Provides the command `prettier-package-json`. ## Health **Score 23/100 (F)** — status: abandoned. Positive: has types package; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.8.0 | | Published | 2022-12-23 | | First published | 2017-06-01 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | separate (@types/prettier-package-json) | | Module format | CommonJS | | Dependencies | 9 | | Unpacked size | 28.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Cameron Hunter | | Maintainers | cameronhunter | | Keywords | cleanup, formatter, json, keys, object, package, package.json, prettier, sort | ## Links - npm: https://www.npmjs.com/package/prettier-package-json - Repository: https://github.com/cameronhunter/prettier-package-json - Issues: https://github.com/cameronhunter/prettier-package-json/issues - npm.io page: https://npm.io/package/prettier-package-json ## Dependencies (9) - [glob](https://npm.io/package/glob.md) ^7.1.6 - [fs-extra](https://npm.io/package/fs-extra.md) ^10.0.0 - [commander](https://npm.io/package/commander.md) ^4.0.1 - [minimatch](https://npm.io/package/minimatch.md) ^3.0.4 - [sort-order](https://npm.io/package/sort-order.md) ^1.0.1 - [cosmiconfig](https://npm.io/package/cosmiconfig.md) ^7.0.0 - [parse-author](https://npm.io/package/parse-author.md) ^2.0.0 - [sort-object-keys](https://npm.io/package/sort-object-keys.md) ^1.1.3 - [@types/parse-author](https://npm.io/package/@types/parse-author.md) ^2.0.0 ## Alternatives - [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads - [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads - [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads - [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads - [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads ## Recent versions - 2.8.0 (latest) — 2022-12-23 - 2.7.0 — 2022-09-23 - 2.6.4 — 2022-06-22 - 2.6.3 — 2022-02-23 - 2.6.2 — 2022-02-23 - 2.6.1 — 2022-02-23 - 2.5.2 — 2022-02-23 - 2.5.1 — 2022-02-23 - 2.6.0 — 2021-05-21 - 2.5.0 — 2021-05-06 - 2.4.0 — 2021-05-06 - 2.3.0 — 2021-05-06 - 2.1.3 — 2019-12-08 - 2.1.2 — 2019-12-08 - 2.1.0 — 2019-02-18 - … 15 more at https://npm.io/package/prettier-package-json/versions ## README # Prettier `package.json` [![CI](https://github.com/cameronhunter/prettier-package-json/actions/workflows/ci.yml/badge.svg)](https://github.com/cameronhunter/prettier-package-json/actions/workflows/ci.yml) [![npm](https://img.shields.io/npm/v/prettier-package-json.svg)](https://www.npmjs.com/package/prettier-package-json) `prettier-package-json` is a JSON formatter inspired by `prettier`. It removes all original styling and ensures that the outputted `package.json` conforms to a consistent style. By default it uses opinionated defaults but can be configured to your individual needs. ## Features ### Consistent key order Keys in `package.json` will be sorted in an [opinionated order](src/defaultOptions.ts) but may be configured to your own preferences. Input: ```json { "description": "Prettier formatter for package.json files", "name": "prettier-package-json", "license": "MIT", "version": "1.0.1", "author": "Cameron Hunter " } ``` Output: ```json { "name": "prettier-package-json", "description": "Prettier formatter for package.json files", "author": "Cameron Hunter ", "license": "MIT", "version": "1.0.1" } ``` ### Sensibly sorted scripts The `scripts` field is sorted alphabetically but keeps `pre` and `post` scripts surrounding their named script. Input: ```json { "name": "prettier-package-json", "version": "1.0.1", "scripts": { "test": "test", "pretest": "pretest", "version": "version", "postversion": "postversion", "build": "build" } } ``` Output: ```json { "name": "prettier-package-json", "version": "1.0.1", "scripts": { "build": "build", "pretest": "pretest", "test": "test", "version": "version", "postversion": "postversion" } } ``` ### Expand/contract author, contributors, and maintainers The `author`, `contributors` and `maintainers` fields will be shortened to their string versions and sorted by name. Use the `--expand-users` option if you prefer user objects. Input: ```json { "name": "prettier-package-json", "version": "1.0.1", "author": { "name": "Cameron Hunter", "email": "hello@cameronhunter.co.uk", "url": "https://cameronhunter.co.uk" }, "contributors": ["Barry", "Adam "] } ``` Output: ```json { "name": "prettier-package-json", "version": "1.0.1", "author": "Cameron Hunter (https://cameronhunter.co.uk)", "contributors": ["Adam ", "Barry"] } ``` ### Filter and sort files field Some files are included or excluded automatically by `npm`, these are removed from the `files` field before sorting alphabetically. Input: ```json { "name": "prettier-package-json", "version": "1.0.1", "main": "src/index.js", "files": ["src/index.js", "src", "CHANGELOG.md", "readme.md", "package-lock.json"] } ``` Output: ```json { "name": "prettier-package-json", "version": "1.0.1", "main": "src/index.js", "files": ["src"] } ``` ## Usage Install: ```sh yarn add prettier-package-json --dev ``` You can install it globally if you like: ```sh yarn global add prettier-package-json ``` _We're defaulting to yarn but you can use npm if you like:_ ```sh npm install [-g] prettier-package-json ``` ### CLI Run `prettier-package-json` through the CLI with this script. Run it without any arguments to see the options. To format a file in-place, use `--write`. You may want to consider committing your file before doing that, just in case. ```sh prettier-package-json [opts] [filename] ``` In practice, this may look something like: ```sh prettier-package-json --write ./package.json ``` #### Pre-commit hook for changed files You can use this with a pre-commit tool. This can re-format your files that are marked as "staged" via git add before you commit. ##### 1. [lint-staged](https://github.com/okonet/lint-staged) Install it along with [husky](https://github.com/cameronhunter/husky): ```bash yarn add lint-staged husky --dev ``` and add this config to your `package.json`: ```json { "scripts": { "precommit": "lint-staged" }, "lint-staged": { "package.json": ["prettier-package-json --write", "git add"] } } ``` See https://github.com/okonet/lint-staged#configuration for more details about how you can configure lint-staged. ##### 2. bash script Alternately you can just save this script as `.git/hooks/pre-commit` and give it execute permission: ```bash #!/bin/sh packagejsonfiles=$(git diff --cached --name-only --diff-filter=ACM | grep 'package\.json$' | tr '\n' ' ') [ -z "$packagejsonfiles" ] && exit 0 diffs=$(node_modules/.bin/prettier-package-json -l $packagejsonfiles) [ -z "$diffs" ] && exit 0 echo "here" echo >&2 "package.json files must be formatted with prettier-package-json. Please run:" echo >&2 "node_modules/.bin/prettier-package-json --write "$diffs"" exit 1 ``` ### API The API has two functions, exported as `format` and `check`. Usage is as follows: ```js import { format, check } from 'prettier-package-json'; const options = {}; // optional format(json, options); check(json, options); ``` `check` checks to see if the file has been formatted with `prettier-package-json` given those options and returns a Boolean. This is similar to the `--list-different` parameter in the CLI and is useful for running in CI scenarios. ### CI For usage in CI scenarios, you can use the `--list-different` CLI flag. The command will list all invalid files and return with a proper default error code, so that in case of an error or invalid file the build pipeline automatically fails. These are the status codes: - `0`: all files valid, no error occured. - `1`: an error ocurred, for example a JSON parse error. See message on `stderr` for details. - `2`: not all files are valid. These exit codes are only set when in `--list-different` mode. ### Options `prettier-package-json` ships with a handful of customizable format options, usable in both the CLI, API, and configuration file. | Option | Default | CLI override | API override | | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------- | ----------------------------- | | **Tab Width** - Specify the number of spaces per indentation-level. | `2` | `--tab-width ` | `tabWidth: ` | | **Tabs** - Indent lines with tabs instead of spaces. | `false` | `--use-tabs` | `useTabs: ` | | **Expand Users** - Expand author and contributors into objects. | `false` | `--expand-users` | `expandUsers: ` | | **Key Order** - Specify the order of keys. | See [default options](src/defaultOptions.ts) | `--key-order ` | `keyOrder: ` | A configuration file will be searched for using [`cosmiconfig`](https://www.npmjs.com/package/cosmiconfig) rules: - `prettier-package-json` field in `package.json`. - `prettier-package-json` file (JSON or YAML), extentionless "rc" file. - `prettier-package-json` file with the extensions `.json`, `.yaml`, `.yml`, `.js`, or `.cjs`. - `prettier-package-json.config.js` or `prettier-package-json.config.cjs` CommonJS module. Configuration file may also be passed using the `--config` CLI parameter. ## Contributing See [CONTRIBUTING.md](CONTRIBUTING.md). --- _Source: https://npm.io/package/prettier-package-json · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._