Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keithamus/sort-package-json
Sort an Object or package.json based on the well-known package.json keys
https://github.com/keithamus/sort-package-json
Last synced: 2 days ago
JSON representation
Sort an Object or package.json based on the well-known package.json keys
- Host: GitHub
- URL: https://github.com/keithamus/sort-package-json
- Owner: keithamus
- License: mit
- Created: 2015-12-09T16:34:43.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T14:51:10.000Z (about 2 months ago)
- Last Synced: 2024-10-29T14:04:45.552Z (about 1 month ago)
- Language: JavaScript
- Size: 1.2 MB
- Stars: 800
- Watchers: 8
- Forks: 87
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-javascript - sort-package-json - known package.json keys (Packages)
- awesome-javascript - sort-package-json - known package.json keys (Packages)
README
# Sort Package.json
[![Build Status][github_actions_badge]][github_actions_link]
[![NPM Version][package_version_badge]][package_link]
[package_version_badge]: https://img.shields.io/npm/v/sort-package-json.svg
[package_link]: https://www.npmjs.com/package/sort-package-json
[github_actions_badge]: https://img.shields.io/github/actions/workflow/status/keithamus/sort-package-json/pr.yml
[github_actions_link]: https://github.com/keithamus/sort-package-json/actions?query=workflow%3ACI+branch%3Amain
## CLI
### Run via npx ([email protected]+ required)
```bash
npx sort-package-json
```
### Install
```bash
npm install --global sort-package-json
```
### Usage
```console
$ cd my-project
$ cat package.json
{
"dependencies": {
"sort-package-json": "1.0.0",
"sort-object-keys": "1.0.0"
},
"version": "1.0.0",
"name": "my-awesome-project"
}
$ npx sort-package-json
package.json is sorted!
Found 1 file.
1 file successfully sorted.
$ cat package.json
{
"name": "my-awesome-project",
"version": "1.0.0",
"dependencies": {
"sort-object-keys": "1.0.0",
"sort-package-json": "1.0.0"
}
}
```
CLI also supports multi file paths or [`glob`](https://github.com/sindresorhus/globby) - so you can give it a bunch of `package.json` file(s) to sort.
```bash
$ sort-package-json "my-package/package.json" "other-package/package.json"
$ sort-package-json "package.json" "packages/*/package.json"
$ sort-package-json "package.json" "packages/*/package.json" --ignore "packages/one-package"
```
#### `--check` flag
When you want to check if your files are sorted, you can run CLI with the `--check` flag (or `-c`). This will output a list of not sorted files, if any.
```console
$ sort-package-json "**/package.json" --check
Found 5 files.
5 files were already sorted.
$ sort-package-json "**/package.json" --check
foo/package.json
bar/package.json
Found 5 files.
3 files were not sorted.
2 files were already sorted.
```
#### `--quiet` flag
In order to silence any successful output, you can run CLI with the `--quiet` flag (or `-q`). This will stop the CLI from outputting if it runs successfully, but won't effect error messages and the exit code.
```bash
$ sort-package-json "**/package.json" --check --quiet
$ sort-package-json "**/package.json" --quiet
```
#### `--stdin` flag
To read from `stdin` and output the result to `stdout` use the `--stdin` flag.
```bash
$ cat package.json | sort-package-json --stdin
```
This can, for instance, be used to generate a diff before changing `package.json`.
```bash
$ ( PKG="./package.json" ; cat "${PKG?}" | sort-package-json --stdin | diff "${PKG?}" - ; )
```
## API
### Install
```bash
npm install --save-dev sort-package-json
```
### Usage
```js
sortPackageJson(packageJson, options?)
```
Pass a JSON string, return a new sorted JSON string.\
Pass a JSON object, return a new sorted JSON object.
```js
import sortPackageJson from 'sort-package-json'
const packageJsonString = `{
"dependencies": {
"sort-package-json": "1.0.0",
"sort-object-keys": "1.0.0"
},
"version": "1.0.0",
"name": "my-awesome-project"
}`
console.log(sortPackageJson(packageJsonString))
/* => string:
{
"name": "my-awesome-project",
"version": "1.0.0",
"dependencies": {
"sort-object-keys": "1.0.0",
"sort-package-json": "1.0.0"
}
}
*/
const packageJsonObject = JSON.parse(packageJsonString)
console.log(sortPackageJson(packageJsonObject))
/* => object:
{
name: 'my-awesome-project',
version: '1.0.0',
dependencies: {
'sort-object-keys': '1.0.0',
'sort-package-json': '1.0.0'
}
}
*/
```
#### options.sortOrder
Type: `string[] | Function`\
Default: `sortPackageJson.sortOrder`
Custom ordering array or comparator function.
If an array, sort keys in ordering of `options.sortOrder`.
**Notice**: fields not in this array, will still sort by `defaultSortOrder`
```js
const sorted = sortPackageJson(packageJsonObject, {
sortOrder: ['version'],
})
console.log(Object.keys(sorted))
// -> [ 'version', 'name', 'dependencies' ]
// ^^^^^^^^^^^^^^^^^^^^^^
// `name` and `dependencies` are sorted by defaultSortOrder
```
If a function, sort fields by [Array#sort(options.sortOrder)](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description)
```js
const sorted = sortPackageJson(packageJsonObject, {
sortOrder(left, right) {
return left.localeCompare(right)
},
})
console.log(Object.keys(sorted))
// -> [ 'dependencies', 'name', 'version' ]
```
## Related tools
- [ESLint Rule with Autofix](https://github.com/kellyselden/eslint-plugin-json-files#supported-rules)
- [Prettier Plugin](https://github.com/matzkoh/prettier-plugin-packagejson)
- [Visual Studio Code Extension](https://github.com/unional/vscode-sort-package-json)
## Supported Libraries
- [AVA](https://github.com/avajs/ava)
- [Babel](https://babeljs.io/)
- [Browserify](http://browserify.org/)
- [c8](https://github.com/bcoe/c8)
- [commitlint](https://commitlint.js.org/)
- [ESLint](https://eslint.org/)
- [Husky](https://github.com/typicode/husky)
- [Istanbul](https://istanbul.js.org/)
- [Jest](https://jestjs.io/)
- [lint-staged](https://github.com/okonet/lint-staged)
- [Mocha](https://mochajs.org/)
- [node-pre-gyp](https://github.com/mapbox/node-pre-gyp)
- [npm-package-json-lint](https://npmpackagejsonlint.org/)
- [oclif](https://oclif.io/)
- [pnpm](https://pnpm.io/)
- [Prettier](https://prettier.io/)
- [remark](https://remark.js.org/)
- [semantic-release](https://github.com/semantic-release/semantic-release)
- [stylelint](https://github.com/stylelint/stylelint)
- [Tap](https://node-tap.org/)
- [xojs](https://github.com/xojs/xo)
_Alphabetically ordered._
## Automatically Sort
The package.json file can be sorted automatically before committing.
```bash
npm install husky lint-staged --save-dev
npm pkg set scripts.prepare="husky install"
npm run prepare
npx husky add .husky/pre-commit "npx lint-staged"
```
Add the following to your `package.json` file
```json
{
"lint-staged": {
"package.json": "sort-package-json"
}
}
```
See [Husky](https://github.com/typicode/husky) and [lint-staged](https://github.com/okonet/lint-staged) for more information.
## PFAQ: Potential Frequently Asked Questions
### How does it sort?
It sorts using [`sort-object-keys`](http://github.com/keithamus/sort-object-keys). It sorts using the well-known keys of a package.json. For the full list check the [default rules](./defaultRules.md). It sorts sub-keys too - sometimes by a well-known order, other times alphabetically. The initial order was derived from the [package.json docs](https://docs.npmjs.com/files/package.json) with a few extras added for good measure.
### It doesn't sort X?
Cool. Send a PR! It might get denied if it is a specific vendor key of an unpopular project (e.g. `"my-super-unknown-project"`). We sort keys like "browserify" because it is a project with millions of users. If your project has, say, over 100 users, then we'll add it. Sound fair?
### Isn't this just like Project X?
Could be. I wanted this one because at the time of writing, nothing is:
- Zero config
- Able to be used in a library
- Quiet (i.e. not spitting out annoying log messages, when used in a library mode)
### I would like this tool to be configurable with a config file or command line arguments.
The lack of configuration here is a feature, not a bug. The intent of this tool is that a user can open a package json and always expect to see keys in a particular order. If we add a configuration for this tool, then that promise is broken, as users will first need to look at the configuration for each project to learn the ways in which this tool will change the `package.json`. The structure of the `package.json` should always be predictable & deterministic from project to project. I think the _reason_ why this project is well used is because it is not another "tool" you have to set up with yet another JSON file and more cruft in your project to support it. You run a command and it does what it says on the tin.
A lot of people who ask for configuration cite the use case that they simply don't like the given order that exists and want to make sweeping changes. To me this seems far better suited to simply making a fork of this project as then you can go far further than specifying configuration.
### What is the order this package defaults to?
The default order is exported as a `sortOrder` object.
Properties mentioned in the npm docs
1. `name`
1. `version`
1. `private`
1. `description`
1. `keywords`
1. `homepage`
1. `bugs`
1. `repository`
1. `funding`
1. `license`
1. `author`
1. `contributors`
1. `main`
1. `browser`
1. `bin`
1. `man`
1. `directories`
1. `files`
1. `workspaces`
1. `scripts`
1. `config`
1. `dependencies`
1. `engines`
1. `os`
1. `cpu`
Full list of recognized properties
1. `$schema`
1. `name`
1. `displayName`
1. `version`
1. `private`
1. `description`
1. `categories`
1. `keywords`
1. `homepage`
1. `bugs`
1. `repository`
1. `funding`
1. `license`
1. `qna`
1. `author`
1. `maintainers`
1. `contributors`
1. `publisher`
1. `sideEffects`
1. `type`
1. `imports`
1. `exports`
1. `main`
1. `svelte`
1. `umd:main`
1. `jsdelivr`
1. `unpkg`
1. `module`
1. `source`
1. `jsnext:main`
1. `browser`
1. `react-native`
1. `types`
1. `typesVersions`
1. `typings`
1. `style`
1. `example`
1. `examplestyle`
1. `assets`
1. `bin`
1. `man`
1. `directories`
1. `files`
1. `workspaces`
1. `binary`
1. `scripts`
1. `betterScripts`
1. `contributes`
1. `activationEvents`
1. `husky`
1. `simple-git-hooks`
1. `pre-commit`
1. `commitlint`
1. `lint-staged`
1. `nano-staged`
1. `config`
1. `nodemonConfig`
1. `browserify`
1. `babel`
1. `browserslist`
1. `xo`
1. `prettier`
1. `eslintConfig`
1. `eslintIgnore`
1. `npmpkgjsonlint`
1. `npmPackageJsonLintConfig`
1. `npmpackagejsonlint`
1. `release`
1. `remarkConfig`
1. `stylelint`
1. `ava`
1. `jest`
1. `jest-junit`
1. `jest-stare`
1. `mocha`
1. `nyc`
1. `c8`
1. `tap`
1. `resolutions`
1. `dependencies`
1. `devDependencies`
1. `dependenciesMeta`
1. `peerDependencies`
1. `peerDependenciesMeta`
1. `optionalDependencies`
1. `bundledDependencies`
1. `bundleDependencies`
1. `extensionPack`
1. `extensionDependencies`
1. `flat`
1. `packageManager`
1. `engines`
1. `engineStrict`
1. `volta`
1. `languageName`
1. `os`
1. `cpu`
1. `preferGlobal`
1. `publishConfig`
1. `icon`
1. `badges`
1. `galleryBanner`
1. `preview`
1. `markdown`
1. `pnpm`
### What?! Why would you want to do this?!
Well, it's nice to have the keys of a package.json in a well sorted order. Almost everyone would agree having "name" at the top of a package.json is sensible (rather than sorted alphabetically or somewhere silly like the bottom), so why not the rest of the package.json?