🚀 Feature: `sort-collections` can also sort arrays

[michaelfaith]

Feature Request Checklist

• I have searched for related issues and found none that matched my issue.

Overview

With a name like sort collections one would think that Arrays are also being sorted, but they currently aren't. Right now, the rule just sorts object properties. Let's add array sorting to the rule as well.

Any downsides to doing this?

Additional Info

Since this would be breaking, if accepted, it would be part of our next major release.

[JoshuaKGoldberg]

I can't think of any breakages that happen in built-in package.json properties 🤔

[ShayanTheNerd]

Not precisely what the original issue suggests, but the current rule could be extended to support sorting the objects within an array with wildcard patterns (<array-key>.*). For example, it could then sort the properties of each object in the contributors array. Using a pattern similar to the current key/order pattern to express this:

'package-json/sort-collections': ['warn', [
  {
    key: 'contributors.*',
    order: ['name', 'email', 'url'],
  },
]],

Input:

{
  "contributors": [
    {
      "url": "https://example.com/bob",
      "name": "Bob",
      "email": "bob@example.com"
    },
    {
      "email": "alice@example.com",
      "name": "Alice"
    }
  ]
}

Output:

{
  "contributors": [
    {
      "name": "Bob",
      "email": "bob@example.com",
      "url": "https://example.com/bob"
    },
    {
      "name": "Alice",
      "email": "alice@example.com"
    }
  ]
}

Note this is specifically about sorting the keys within each object that an array contains (and not the order of the array items).

[michaelfaith]

That's a different issue than what this feature request is for, though. It's a good idea, but I'd suggest opening this as a different feature request.

[ShayanTheNerd]

Sure!