🚀 Feature: `sort-collections` also sorts the object properties within arrays

[ShayanTheNerd]

Feature Request Checklist

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

Overview

The current implementation could be extended to support sorting the objects within an array with wildcard patterns (e.g., <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"
    }
  ]
}

Additional Info

No response

[michaelfaith]

I like it. Thanks for the feature request. Marking it as accepting prs. Is this something you'd like to work on?

[michaelfaith]

@all-contributors please add @ShayanTheNerd for idea

[allcontributors]

@michaelfaith

@ShayanTheNerd already contributed before to ideas

[michaelfaith]

array with wildcard patterns

One thing i think would be good to hash out here before moving to implementation is what constraints are there for where wildcards can be used? Can it only be used for the last segment? And the parent always has to be an array, right? Or can it be used to wildcard property names of an object?

[ShayanTheNerd]

Is this something you'd like to work on?

Unfortunately, I can't currently work on this issue.

Can it only be used for the last segment? And the parent always has to be an array, right? Or can it be used to wildcard property names of an object?

I believe the pattern should be <parent-property>.*, where the parent property is an array, so the wildcard isn't going to be used for targeting all properties of an object.
This keeps the current behavior intact: the properties of an object are either sorted automatically (lexicographically, with the exception of scripts), or ordered manually in an explicit, user-provided array. The same principles are going to be applied, but the wildcard allows us to apply them to all objects in an array at once and reduce repetition.
The use cases would be contributors.*, devEngines.*, funding.*, licenses.*, maintainers.*, workspaces.*, etc.