Feature: sorting enums should take into account if it's a numeric based enum

[niemyjski]

What rule do you want to change?

https://perfectionist.dev/rules/sort-enums

Describe the problem

Enums get extended over time and they are typically sorted by numeric if they are not string based. For string based, I always want to sort by name.

Code example

export enum SuspensionCode {
    Billing = 0,
    Overage = 1,
    Abuse = 2,
}

export enum SuspensionCode {
    Billing = 0,
    Overage,
    Abuse,
}

Additional comments

I think this might be solved like this:

 'error',
      {
        type: 'unsorted', // disables primary sorting
        sortByValue: true, // sorts using values (will be numeric if possible)
        forceNumericSort: false, // allows fallback when values aren't numeric
        fallbackSort: {
          type: 'alphabetical',
          order: 'asc',
        },
      },

Just kinda feels like this should be the default. I've never seen a numeric enum sorted alpha by default in any language or code project I've used.

Validations

• Read the docs.
• Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.

[hugop95]

Hi @niemyjski

If I understand correctly, you suggest that:

• Numeric only enums are sorted by numeric value.
• Non-numeric only enums are sorted in the alphabetical order.

So something like this ?

export enum SuspensionCode {
  Billing = 0,
  Overage = 1,
  Abuse = 2,
}

export enum SuspensionCode {
  Abuse = "Abuse",
  Billing = "Billing",
  Overage = "Overage",
}

If so, forceNumericSort: true is enough to get this order.
Having it enabled by default is interesting, but that should come within a major version update in order not to have breaking chances.

---

N.B:

export enum SuspensionCode {
    Billing = 0,
    Overage,
    Abuse,
}

will not be sorted (this is the expected behavior), as the non-defined enum values are given by the their order in the enum.

[niemyjski]

That is correct! I’ll try that setting and will keep an eye out for any major

[azat-io]

We are now planning a major release:

#566