Update order-properties to use sort-package-json

[kendallgassner]

closes: #31

What

• Replaced the order-properties sorting algorithm to use sort-package-json.
• Changed the type of options from an Array<string> to

{
    order?: "legacy" | "sort-package-json" | Array<string>
}

• defaulted the sort order to legacy
• Add additional testing to test options: "legacy" | "sort-package-json" .

Callouts

Option: order: Array<string>

Previously, any property that was not provided in the order: Array<string> collection was ignored by the sort algorithm. Now that we are using sort-package-json, a property that is not provided in the order: Array<string> will be sorted by the defaultSortOrder provided by the library.

Sort-package-json version

the latest version of sort-package-json is an esm module so I opted to use an earlier version to avoid heavy refactorign. This package can be bumped when #33 is merged.

[JoshuaKGoldberg]

D'oh! I don't know how this slipped by me - sorry for taking two weeks @kendallgassner!

Changes look great. Just a few small nits I can take care of. Will release soon. Thanks! 🚀

[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.