[New] order: add caseInsensitive: 'invert' option

[forivall]

Adds the "invert" option to "caseInsensitive"

• caseInsensitive: use true to ignore case, false to consider case, and 'invert' to sort lowercase before uppercase (default: false).

bikeshed: I'd rename caseInsensitive to caseSensitive with default true. other naming options are viable.

[forivall]

My current workaround which works for ~80% of the instances in the target codebase is

const rules = {
  ...
  'import/order': [
    'warn',
    {
      groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
      alphabetize: {
        order: 'asc',
        caseInsensitive: true,
      },
      pathGroups: [
        { pattern: './[A-Z]*{,/**}', group: 'sibling', position: 'after' },
      ],
    },
  ],
  ...
}

[coveralls]

Coverage increased (+0.007%) to 97.746% when pulling 6013f1b on forivall:feat/case-sort-invert into 92caa35 on benmosher:master.

[coveralls]

Coverage increased (+0.007%) to 97.746% when pulling 6013f1b on forivall:feat/case-sort-invert into 92caa35 on benmosher:master.

[coveralls]

Coverage increased (+0.007%) to 97.746% when pulling 6013f1b on forivall:feat/case-sort-invert into 92caa35 on benmosher:master.

[coveralls]

Coverage increased (+2.01%) to 71.516% when pulling 3e1d204 on forivall:feat/case-sort-invert into e871a9a on benmosher:master.

[ljharb]

The code seems fine to me. Can you elaborate on the use case?

[forivall]

Sure: the use case is that in the frontend code at $job, data/core modules start with a lower case, and the Components start with UpperCase, and so, when i'm sorting imports, i want the business logic imports to be first, and then the imports of Presentation Logic.

(sorry for the late reply, got lost in my notifications)

[ljharb]

LGTM overall, just a few comments

[ljharb]

bikeshed: maybe in addition to true/false, we could support (and recommend) a three-option string enum? iow, this can be 'ignore' | 'upperFirst' | 'lowerFirst', with false being an alias for ignore and true being an alias for upperFirst?

[forivall]

Hmm, perhaps the "caseInsensitive" should be deprecated and make the 3 option string enum under an option called "caseSensitive" or "caseSensitivity"?

i wonder what other things call their options?

• GNU coreutils sort calls its option --ignore-case/-f (the f is for "fold lower case to upper case" - maybe too obscure of a term to use here)
  • although python has str.casefold(), algorithm defined in unicode spec)
• JS Intl.locale.caseFirst and sensitivity (under options)
• JS regExp.ignoreCase
• @typescript-eslint/eslint-plugin has sort-type-union-intersection-members (non-configurable)
• eslint core has sort-vars has ignoreCase
• eslint sort-vars and sort-imports have ignoreCase
• eslint sort-keys has caseSensitive and natural

With that all said, i'd like to suggest keeping caseInsensitive as a boolean, and for this option, introduce caseFirst: 'upper' | 'lower', based on the Intl.Collator options

[forivall]

It would probably also be a good idea to just use Intl.Collator like what typescript-eslint does instead of doing the case-munging manually

[forivall]

alternative diff, using caseFirst is here: master...forivall:feat/case-first

[ljharb]

seems like this should be handled inside getSorter rather than here?

[forivall]

Resolved with my new refactor commit.