prettier-plugin-pkg weekly downloads statistics

prettier-plugin-pkg

An opinionated package.json formatter plugin for Prettier, based on [prettier-plugin-package][].

Prettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing, taking various rules into account.

This plugin adds support for package.json files used within NPM modules, [npm][], [yarn][] and [VSCode][] is supported out of box.

Requirements

prettier-plugin-pkg is an evergreen module. 🌲 This module requires an LTS Node version (v12.0.0+).

Install

Usage

Once installed, Prettier plugins must be added to .prettierrc:

Then:

Rules

This plugin enforces its own set of opinionated rules:

Engines

Keys in engines are ordered alphabetically.

Files

Keys in files are ordered alphabetically (keeping the negations below), followed by README.md and LICENSE if they exist in the array.

Scripts

Keys in scripts are ordered alphabetically. Use prefixes wisely to properly order child scripts. e.g. lint, lint:ts.

Sorting

Top-level keys are sorted according to a style commonly seen in the packages of @JounQin, @1stG and @unts. Known keys, and their order are

Unknown keys, or keys not part of the list above, will be alphabetically sorted and added to the end of the file. Note that this list takes into account both npm and yarn keys.

You can also use the packageSortOrder option to specify a custom sort order, or use the packageSortOrderPreset option to use a preset sort order:

• npm: sorts by npm's document • npm-plus: sorts by sort-package-json and therefore is compatible to prettier-plugin-packagejson

Forthcoming

Forthcoming rules include:

• [ ] Author format • [ ] Repository format

Format Options

Acknowledgements

Thanks for @shellscape's original great work of [prettier-plugin-package][] again.

Sponsors and Backers

Sponsors

| 1stG | RxTS | UnTS |

| | | |

Backers

| 1stG | RxTS | UnTS |

| | | |

Meta

LICENSE (Mozilla Public License)