[Prettier Plugin] Support sorting for cva array values

[davejsdev]

It would be nice to sort the array values inside cva().

This is a tough heuristic to get right because there are cases where you can't/don't want these to be sorted.

I think there's a reasonable middle ground though that would be useful.

Sorting these classes would be the main use case:

const buttonClasses = cva(
  [
    'inline-flex',
    'overflow-hidden',
    'items-center',
    'justify-center',
    'leading-[1.25]',
    'gap-[0.25em]',
    'px-[0.75em]',
    'py-[0.5em]',
    'rounded-md',
    'transition-colors',
    'duration-200',
    'ease-in-out',
    'border',
    'text-sm',
    '!border-transparent',
    'outline-none',
    'cursor-pointer',

    // icons
    '[&_svg]:pointer-events-none',
    '[&_svg:not([class*="size-"])]:size-[1em]',
    'focus-visible:ring-ring',
    '[&_svg]:shrink-0',

    // disabled
    'disabled:pointer-events-none',
    'disabled:opacity-50',
    'disabled:cursor-not-allowed',

    // focus-visible
    'focus-visible:border-ring',
    'focus-visible:ring-2',
    'focus-visible:ring-offset-1',

    // aria-invalid
    'aria-invalid:ring-destructive/20',
    'dark:aria-invalid:ring-destructive/40',
    'aria-invalid:border-destructive',
  ]
)

Where this gets tricky is when you have an array with items that each have multiple classes:

const buttonClasses = cva(
  [
    'inline-flex overflow-hidden items-center justify-center ...',

    // icons
    '[&_svg]:pointer-events-none [&_svg:not([class*="size-"])]:size-[1em] focus-visible:ring-ring [&_svg]:shrink-0',

    // disabled
    'disabled:pointer-events-none disabled:opacity-50 disabled:cursor-not-allowed',

    // focus-visible
    'focus-visible:border-ring focus-visible:ring-2 focus-visible:ring-offset-1',

    // aria-invalid
    'aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive',
  ]
)

I think in this case we wouldn't sort the array items because there could be inadvertent behavioral changes with that. So there might be edge cases that make this sorting not feasible. There's also deciding what to do when there's a mixture of single class strings and multi-class strings in the array.

I'm not well-versed enough with CVA to make that call though.