order-properties: consider an option for sort-package-json's order

[JoshuaKGoldberg]

Right now, the package-json/order-properties rule uses its own "standard order":

eslint-plugin-package-json/lib/rules/order-properties.js

Line 16 in b6553ec

const standardOrder = [

I haven't seen this order in recent history. But, I have seen https://github.com/keithamus/sort-package-json be used in recent ecosystem projects such as https://github.com/matzkoh/prettier-plugin-packagejson. Perhaps order-properties could take in an option?

cc @zetlen - is there a good reference for the current order? I'm wondering what to name if it there is an option added...

cc @kellyselden from https://github.com/kellyselden/eslint-plugin-json-files/blob/3a24e6f36b7828210a56070af4487cb5831f7f24/docs/rules/sort-package-json.md - I do find it interesting that both of these ESLint plugins have package.json sorting implemented...

[Zamiell]

I think that most of the ecosystem uses the sort-package-json order.
Most notably, as Josh said above, prettier-plugin-packagejson uses this order too.
Thus, I would vote that this plugin matches the ordering of sort-package-json by default.

i.e. lets avoid this:

[zetlen]

I think I took the ordering from the order in which the documentation page describes them. It doesn't say anywhere that this is a required order. If there's another, more widespread convention, use that.

[JoshuaKGoldberg]

Awesome! Let's go with, say, order: "legacy" | "sort-package-json"``? With "legacy"as the default now, noted to switch to"sort-package-json"` in a potential future version?

Marking as accepting PRs. If nobody's sent a PR by the time I've overhauled this repo (#33 through #37) I'll go ahead and send one myself.

Note that adding sort-package-json as a dependency might clobber package-lock.json until #33 is in. I've found that using npx npm@6 to run an older version of npm is a workaround.

[kendallgassner]

@JoshuaKGoldberg can you assign this ticket to me. I am going to take a look today.

[JoshuaKGoldberg]

Published as [email protected].

Intentionally a different minor version than the previous 0.1.x line. I'll publish #40 and #58 in a new 0.3 line so folks can stick with this feature in case ESLint 8 support breaks them.

Thanks again @kendallgassner!