🐛 Bug: package-json/order-properties changes scripts keys

[AndreasLindbergPAF]

Bug Report Checklist

• I have tried restarting my IDE and the issue persists.
• I have pulled the latest main branch of the repository.
• I have searched for related issues and found none that matched my issue.

Expected

It should only sort the top-level keys

Actual

It complains about key order in deeper paths as well

Additional Info

With this config

{
  "files": ["package.json"],
  "plugins": ["package-json"],
  "rules": {
    "package-json/order-properties": [
      "error",
      {
        "order": [
          "name",
          "scripts",
          "dependencies"
        ]
      }
    ],
    "package-json/sort-collections": [
      "error", 
      ["dependencies", "devDependencies", "peerDependencies"]
    ]
  }
}

I'm expecting this

{
  "scripts": {
    "start": "",
    "dev": ""
  }
  "name": "",
  "dependencies": []
}

To only reorder on top-level, like this

{
  "name": "",
  "scripts": {
    "start": "",
    "dev": ""
  },
  "dependencies": []
}

But it seems to change scripts order as well

{
  "name": "",
  "scripts": {
    "dev": "",
    "start": ""
  },
  "dependencies": []
}

I'm stuck on ^0.1.5 because of this 😞

[JoshuaKGoldberg]

👋 thanks for filing! Could you provide a little more detail please?

• What is your package.json before running with --fix?
• What is your package.json after running with --fix?
• Why don't you want the ordering to be changed the way it is?

[AndreasLindbergPAF]

👋 thanks for filing! Could you provide a little more detail please?

• What is your package.json before running with --fix?
• What is your package.json after running with --fix?

Sorry about that, kind of rushed the issue creation a bit 😉
I've updated the post.

• Why don't you want the ordering to be changed the way it is?

The rule package-json/order-properties is described as only re-ordering top-level keys.
But now is seem that it also acts as package-json/sort-collections even tho I'm not enabling it for scripts.

[JoshuaKGoldberg]

Got it! Thanks, that makes sense. Looks like this is an issue with the "order": "sort-package-json" logic added in #55. I'd defaulted it to 'standard-order' in #40 (#31 (comment)).

cc @kendallgassner as FYI 👋

[JoshuaKGoldberg]

@all-contributors please add @AndreasLindbergPAF for bug.

🤖 Beep boop! This comment was added automatically by all-contributors-auto-action.
Not all contributions can be detected from Git & GitHub alone. Please comment any missing contribution types this bot missed.
...and of course, thank you for contributing! 💙

[allcontributors]

@JoshuaKGoldberg

I've put up a pull request to add @AndreasLindbergPAF! 🎉

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

[hyoban]

@JoshuaKGoldberg sort-package-json chooses to make it less configurable, so what method do you recommend to fix this problem?

1. fork sort-package-json (I can help to maintain it and keep it synced with the source)
2. auto-fix manually by using sort-object-keys and detect-indent

[JoshuaKGoldberg]

Hmm, I think the more manual strategy (2) is probably more sustainable long-term. I haven't looked deeply at which packages are best for that these days.

[github-actions]

🎉 This is included in version v0.13.0 🎉

The release is available on:

• GitHub releases
• npm package (@latest dist-tag)

Cheers! 📦🚀