prettier-plugin-packagejson

prettier-plugin-packagejson

A Prettier plugin to sort the keys of a package.json file using sort-package-json.

Installation

npm i -D prettier prettier-plugin-packagejson

For prettier v3+ you need to configure

module.exports = {
  // add this
  plugins: ['prettier-plugin-packagejson'],
}

Options

packageSortOrder

Custom ordering array for package.json fields. This option is passed to sort-package-json's sortOrder option.

Type: string[] Default: [] (uses default sort order from sort-package-json)

Example (.prettierrc):

{
  "packageSortOrder": ["name", "version", "description", "main"]
}

Similar packages

Other packages similar to prettier-plugin-packagejson

sort-package-json

The sort-package-json package sorts the keys in your package.json file. It provides similar functionality to prettier-plugin-packagejson by organizing the structure of the package.json file, but it is a standalone tool rather than a Prettier plugin.

fixpack

The fixpack package is another tool that formats and sorts the fields in your package.json file. It focuses on keeping the package.json file clean and consistent, similar to prettier-plugin-packagejson, but it also includes additional checks for common errors and best practices.