Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nice-move/prettier-plugin-package-json
A `prettier` plugin to make `package.json` prettier
https://github.com/nice-move/prettier-plugin-package-json
nice-move npm package package-json prettier prettier-plugin sort
Last synced: 3 months ago
JSON representation
A `prettier` plugin to make `package.json` prettier
- Host: GitHub
- URL: https://github.com/nice-move/prettier-plugin-package-json
- Owner: nice-move
- License: mit
- Created: 2021-06-10T07:22:31.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-16T03:39:31.000Z (10 months ago)
- Last Synced: 2024-11-02T01:47:06.705Z (3 months ago)
- Topics: nice-move, npm, package, package-json, prettier, prettier-plugin, sort
- Language: JavaScript
- Homepage:
- Size: 457 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @nice-move/prettier-plugin-package-json
A [prettier] plugin to make `package.json` prettier.
[![npm][npm-badge]][npm-url]
[![github][github-badge]][github-url]
![node][node-badge]
[prettier]: https://prettier.io/
[npm-url]: https://www.npmjs.com/package/@nice-move/prettier-plugin-package-json
[npm-badge]: https://img.shields.io/npm/v/@nice-move/prettier-plugin-package-json.svg?style=flat-square&logo=npm
[github-url]: https://github.com/airkro/nice-move/tree/master/packages/prettier-plugin-package-json
[github-badge]: https://img.shields.io/npm/l/@nice-move/prettier-plugin-package-json.svg?style=flat-square&colorB=blue&logo=github
[node-badge]: https://img.shields.io/node/v/@nice-move/prettier-plugin-package-json.svg?style=flat-square&colorB=green&logo=node.js
Read about [npm-package.json](https://docs.npmjs.com/cli/v7/configuring-npm/package-json).
## Installation
```bash
npm install prettier @nice-move/prettier-plugin-package-json --save-dev
```
## Usage
```jsonc
// .prettierrc.json
{
"overrides": [
{
"files": "package.json",
"options": {
"parser": "package-json"
}
}
]
}
```
```bash
prettier --write **/package.json
```
## Feature
[normalize-package-data]: https://github.com/npm/normalize-package-data
[normalize-package-bin]: https://github.com/npm/npm-normalize-package-bin
- Normalize by [normalize-package-data] and [normalize-package-bin]
- Sort `package.json` fields in a preset order
- Expand `author` and `contributors` fields into objects
- Remove deprecated fields like `preferGlobal`, `engineStrict`
- Merge `bundleDependencies` into `bundledDependencies`
- Rename `esnext` / `jsnext` to `module`, rename `typings` to `types`
- Differentiate `UNLICENSED` and `Unlicense` license by `private`
- Remove leading `./` from `main` / `files[n]`
- Normalize `engines.*` versions
- Normalize `repository` fields
- Set `version` when needed
- More ...
## Related
- [@nice-move/prettier-config](https://github.com/nice-move/nice-move/tree/master/packages/prettier-config)