feat: adds fallbackSort option to all rules

[hugop95]

Resolves #429

Most of the code added are documentation and tests.

The two commits responsible for the implementation are:

• 204ef1e (#457)
• 6486253 (#457)

Description

This PR adds a fallbackSort option to all rules:

Typings

{
  fallbackSort: {
    type: 'alphabetical' | 'natural' | 'line-length' | 'custom'
    order: 'asc' | 'desc'
  }[]
}

This option is currently useful for the line-length sort type: this enables users to define an additional sorting algorithm when two elements have the same length.

The option allows an array in case additional sorting types which can result in elements being equals are added later (such as sorting by usage).

What is the purpose of this pull request?

• New Feature

[azat-io]

Do you think it should be an array? Why not object?

[hugop95]

@azat-io 👍 I changed it to an object here: 4d4b494 (#457)

At first, I wanted an array because we might need to define multiple fallback sorts later, if we implement #434 for example (users might want to sort by usage > sort by line-length > sort by alphabetical order, in which case we would need an array).

But today, we don't need it yet, so it makes sense to directly use an object. We can later allow fallbackSort: { type: string; order?: 'asc' | 'desc' } | { type: string; order?: 'asc' | 'desc' }[] if needed.

[azat-io]

The examples in the documentation use arrays ^

[hugop95]

@azat-io Oops! Thank you, fixed in 8f6d97a.

[azat-io]

I like it.

But I think the tests would be better if we also checked that sorting by line length works and is prioritized.

{
  code: dedent`
    [
      'c',
      'bbb',
      'a',
    ].includes(value)
  `,
  output: dedent`
    [
      'bbb',
      'a',
      'c',
    ].includes(value)
  `,
}

[hugop95]

@azat-io Updated in 5d102cc.

[azat-io]

Nice feature, thank you!