New Rule: package-json-sorted-keys / package-json-key-order

[kachkaev]

Rule details

The rule would normalize package.json keys by following a convention in sort-package-json (or similar).

What type of rule is this?

Suggests an alternate way of doing something

Example code

{
  "dependencies": {
    "sort-package-json": "1.0.0",
    "sort-object-keys": "1.0.0"
  },
  "version": "1.0.0",
  "name": "my-awesome-project"
}

↓

{
  "name": "my-awesome-project",
  "version": "1.0.0",
  "dependencies": {
    "sort-object-keys": "1.0.0",
    "sort-package-json": "1.0.0"
  }
}

Participation

• I am willing to submit a pull request to implement this rule.

Additional comments

I am using sort-package-json via prettier-plugin-packagejson and it works well. Automatic key sorting is especially useful in monorepos with lots of package.json files and contributors. The problem with prettier-plugin-packagejson is that it goes outside the scope of Prettier:

What Prettier is not concerned about
Prettier only prints code. It does not transform it. This is to limit the scope of Prettier. Let’s focus on the printing and do it really well!
Here are a few examples of things that are out of scope for Prettier:

• ...
• Sorting/moving imports, object keys, class members, JSX keys, CSS properties or anything else. Apart from being a transform rather than just printing (as mentioned above), sorting is potentially unsafe because of side effects (for imports, as an example) and makes it difficult to verify the most important correctness goal.

Now that ESLint supports JSON parsing, it’d be great to achieve the value of sort-package-json via a rule. Conceptually it is similar to sorting imports in JS files, so I believe that it fits the scope. WDYT?

---

UPD Maybe this should be done elsewhere because the rule would be package.json specific. There is a discussion in keithamus/sort-package-json#322.

[kachkaev]

Prior art: https://github.com/kellyselden/eslint-plugin-json-files → json-files/sort-package-json (by @kellyselden)