feat: adds pkg sort command

[reggi]

adds npm pkg sort command to sort package.json fields

• in init-package-json sorting was added
• from npm/package-json here

[ljharb]

whoa, this is a large feature. how is it sorting things? how can the order be customized? was there an RFC or public discussion anywhere?

[reggi]

@ljharb here's the sort function https://github.com/npm/package-json/blob/main/lib/sort.js

[ljharb]

ok, so it doesn't seem like this has any customization capability, but many hundreds of thousands of projects likely have orderings this would break:

• fake comment sections where precise placement is critical (eg "//": {})
• main-adjacent fields, like module, jsnext:main, sideEffects; any package using yargs.config to configure itself; etc
• why is engines not precisely next to devEngines by default? that makes no sense
• never heard of licenses but why isn't it right next to license? that also makes no sense
• isPrivate is the most important field in there imo, and should go at the top, above name/version

and i could go on for pages. iow, by shipping this, even opt-in, without customizability, npm will be opening the floodgates of custom ordering requests (i speak from experience maintaining multiple eslint plugins that handle orderings).

I strongly urge caution and slowness with a feature like this.

[wraithgar]

@ljharb this is in draft status. Many of these questions would be answered by the docs that we have yet to add to the PR.

[ljharb]

fair, it wasn't in draft until after my comments :-) nothing in the code suggests that it's customizable tho, which seems like a requirement to me