useSortedPackageJson

JSON (and super languages)

Summary

Diagnostic Category: assist/source/useSortedPackageJson
Sources:
- Same as sort-package-json
- Inspired from package-json/sort-collections
- Inspired from package-json-dependencies/alphabetically-sorted-dependencies
- Inspired from unordered-dependencies

How to enable in your editor

1
{
2
  "editor.codeActionsOnSave": {
3
    "source.action.useSortedPackageJson.biome": "explicit",
4
    "source.fixAll.biome": "explicit"
5
  }
6
}

1
{
2
  "code_actions_on_format": {
3
    "source.action.useSortedPackageJson.biome": true,
4
    "source.fixAll.biome": true
5
  }
6
}

Use the source action code source.action.useSortedPackageJson.biome

How to configure

1
{
2
  "assist": {
3
    "actions": {
4
      "source": {
5
        "useSortedPackageJson": "on"
6
      }
7
    }
8
  }
9
}

Description

Organize package.json fields according to established conventions.

Sorts fields following the same conventions as the popular sort-package-json tool.

Sorting Rules

package.json fields are sorted by the order they are listed below. The default key sort order is alphabetical.

Note: when a specific key order is used, any other keys will be sorted in the end of the object

Key	Rules
$schema
name
displayName
version
private
description
categories	Unique items
keywords	Unique items
homepage
bugs	Key order: `url`, `email`
repository	Key order: `type`, `url`
funding	Key order: `type`, `url`
license	Key order: `type`, `url`
qna
author	Key order: `name`, `email`, `url`
maintainers	Key order (per item): `name`, `email`, `url`
contributors	Key order (per item): `name`, `email`, `url`
publisher
sideEffects
type
imports
exports
main
svelte
umd:main
jsdelivr
unpkg
module
source
jsnext:main
browser
react-native
types
typesVersions
typings
style
example
examplestyle
assets
bin	Key sort
man
directories	Key order: `lib`, `bin`, `man`, `doc`, `example`, `test`
files	Unique items
workspaces	Key order (when object): `packages`, `catalog`
binary,	Key order: `module_name`, `module_path`, `remote_path`, `package_name`, `host`
scripts	Script sort
betterScripts	Script sort
contributes	Key sort
activationEvents	Unique items
husky	Sorts the `hooks` field using git hook sort
simple-git-hooks	Key sort using git hook sort
pre-commit
commitlint	Key sort
lint-staged
nano-staged
config	Key sort
nodemonConfig	Key sort
browserify	Key sort
babel	Key sort
browserslist
xo	Key sort
prettier	Prettier sort
eslintConfig	ESLint sort
eslintIgnore
npmpackagejsonlint	Key sort (also recognizes: npmPackageJsonLintConfig, npmpkgjsonlint)
release	Key sort
remarkConfig	Key sort
stylelint
ava	Key sort
jest	Key sort
mocha	Key sort
nyc	Key sort
tap	Key sort
oclif	Key sort (deep)
resolutions	Key sort
dependencies	Key sort
devDependencies	Key sort
dependenciesMeta	Key sort (deep)
peerDependencies	Key sort
peerDependenciesMeta	Key sort (deep)
optionalDependencies	Key sort
bundledDependencies	Sort unique items
bundleDependencies	Sort unique items
extensionPack	Sort unique items
extensionDependencies	Sort unique items
flat
packageManager
engines	Key sort
engineStrict	Key sort
devEngines	Key order (packageManager): `name`, `version`, `onFail`
volta	Key order: `node`, `npm`, `yarn`
languageName
os
cpu
preferGlobal	Key sort
publishConfig	Key sort
icon
badges	Key order (per item): `description`, `url`, `href`
galleryBanner	Key sort
preview
markdown
pnpm	Base property order: `neverBuiltDependencies`, `onlyBuiltDependencies`, `onlyBuiltDependenciesFile`, `overrides`, `packageExtensions`, `patchedDependencies`, `peerDependencyRules`, `allowedDeprecatedVersions`, `allowNonAppliedPatches`, `auditConfig`, `ignoredOptionalDependencies`, `updateConfig`. Other properties sorted alphabetically. Deep sorting applied.

Special Rules

ESLint

Fields are sorted by the order they are listed below:

Key	Rules
env
parser
parserOptions
settings
plugins
extends
rules	Group built-in rules first, then plugin rules. Each group is sorted
overrides	Key order (per item): `files`, `excludedFiles`
globals
processor
noInlineConfig
reportUnusedDisableDirectives

Git Hooks

Item order:

applypatch-msg
pre-applypatch
post-applypatch
pre-commit
pre-merge-commit
prepare-commit-msg
commit-msg
post-commit
pre-rebase
post-checkout
post-merge
pre-push
pre-receive
update
proc-receive
post-receive
post-update
reference-transaction
push-to-checkout
pre-auto-gc
post-rewrite
sendemail-validate
fsmonitor-watchman
p4-changelist
p4-prepare-changelist
p4-post-changelist
p4-pre-submit
post-index-change

Prettier

Keys are sorted alphabetically except for overrides, which is placed last. Keys are also sorted in overrides and overrides.options items.

Scripts

Keys are sorted alphabetically except for pre/post scripts. Those are placed before and after their corresponding base npm script.

An example - notice how preinstall and postinstall are placed before and after install:

1
{
2
  "scripts": {
3
    "build": "",
4
    "preinstall": "",
5
    "install": "",
6
    "postinstall": "",
7
    "lint": ""
8
  }
9
}

Scripts for which the pre/post order is applied:

install
pack
prepare
publish
restart
shrinkwrap
start
stop
test
uninstall
version

Examples

Invalid

1
{
2
  "dependencies": {
3
    "lodash": "^4.0.0"
4
  },
5
  "name": "my-package",
6
  "version": "1.0.0"
7
}

/package.json:1:1 assist/source/useSortedPackageJson  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ package.json fields can be organized.
  
  > 1 │ {
      │ ^
  > 2 │   “dependencies”: {
  > 3 │     “lodash”: “^4.0.0”
  > 4 │   },
  > 5 │   “name”: “my-package”,
  > 6 │   “version”: “1.0.0”
  > 7 │ }
      │ ^
    8 │ 
  
  ℹ Safe fix: Organize package.json fields.
  
    1 1 │   {
    2   │ - ··“dependencies”:·{
    3   │ - ····“lodash”:·“^4.0.0”
    4   │ - ··},
    5   │ - ··“name”:·“my-package”,
    6   │ - ··“version”:·“1.0.0”
      2 │ + ··“name”:·“my-package”,
      3 │ + ··“version”:·“1.0.0”,
      4 │ + ··“dependencies”:·{
      5 │ + ····“lodash”:·“^4.0.0”
      6 │ + ··}
    7 7 │   }
    8 8 │

Valid

1
{
2
  "name": "my-package",
3
  "version": "1.0.0",
4
  "dependencies": {
5
    "lodash": "^4.0.0"
6
  }
7
}