feat: add ignore-case option to each rule

azat-io · Jun 2, 2023 · e331b9a · e331b9a
1 parent 2989539
commit e331b9a
Show file tree

Hide file tree

Showing 25 changed files with 125 additions and 3 deletions.
diff --git a/docs/rules/sort-array-includes.md b/docs/rules/sort-array-includes.md
@@ -81,6 +81,10 @@ This rule aims to promote code readability and maintainability by enforcing a co
   - `asc` - enforce properties to be in ascending order.
   - `desc` - enforce properties to be in descending order.
 
+### `ignore-case`
+
+- `boolean` (default: `false`) - only affects alphabetical and natural sorting. When `true` the rule ignores the case-sensitivity of the order.
+
 ### `spreadLast`
 
 - `boolean` (default: `false`) - enforce spread elements in array to be last

diff --git a/docs/rules/sort-enums.md b/docs/rules/sort-enums.md
@@ -75,6 +75,10 @@ enum Hinamizawa {
   - `asc` - enforce properties to be in ascending order.
   - `desc` - enforce properties to be in descending order.
 
+### `ignore-case`
+
+- `boolean` (default: `false`) - only affects alphabetical and natural sorting. When `true` the rule ignores the case-sensitivity of the order.
+
 ## ⚙️ Usage
 
 ### Legacy Config

diff --git a/docs/rules/sort-imports.md b/docs/rules/sort-imports.md
@@ -151,6 +151,10 @@ import './style.css'
   - `asc` - enforce properties to be in ascending order.
   - `desc` - enforce properties to be in descending order.
 
+### `ignore-case`
+
+- `boolean` (default: `false`) - only affects alphabetical and natural sorting. When `true` the rule ignores the case-sensitivity of the order.
+
 ### `groups`
 
 - `[array]`

diff --git a/docs/rules/sort-interfaces.md b/docs/rules/sort-interfaces.md
@@ -83,6 +83,10 @@ interface Hero {
   - `asc` - enforce properties to be in ascending order.
   - `desc` - enforce properties to be in descending order.
 
+### `ignore-case`
+
+- `boolean` (default: `false`) - only affects alphabetical and natural sorting. When `true` the rule ignores the case-sensitivity of the order.
+
 ### `ignore-pattern`
 
 - `[string]` (default: `[]`) - allows to ignore interface by pattern

diff --git a/docs/rules/sort-jsx-props.md b/docs/rules/sort-jsx-props.md
@@ -91,6 +91,10 @@ let Riko = () => (
   - `asc` - enforce properties to be in ascending order.
   - `desc` - enforce properties to be in descending order.
 
+### `ignore-case`
+
+- `boolean` (default: `false`) - only affects alphabetical and natural sorting. When `true` the rule ignores the case-sensitivity of the order.
+
 ## ⚙️ Usage
 
 ### Legacy Config

diff --git a/docs/rules/sort-map-elements.md b/docs/rules/sort-map-elements.md
@@ -79,6 +79,10 @@ let bebop = Map([
   - `asc` - enforce properties to be in ascending order.
   - `desc` - enforce properties to be in descending order.
 
+### `ignore-case`
+
+- `boolean` (default: `false`) - only affects alphabetical and natural sorting. When `true` the rule ignores the case-sensitivity of the order.
+
 ## ⚙️ Usage
 
 ### Legacy Config

diff --git a/docs/rules/sort-named-exports.md b/docs/rules/sort-named-exports.md
@@ -79,6 +79,10 @@ export {
   - `asc` - enforce properties to be in ascending order.
   - `desc` - enforce properties to be in descending order.
 
+### `ignore-case`
+
+- `boolean` (default: `false`) - only affects alphabetical and natural sorting. When `true` the rule ignores the case-sensitivity of the order.
+
 ## ⚙️ Usage
 
 ### Legacy Config

diff --git a/docs/rules/sort-named-imports.md b/docs/rules/sort-named-imports.md
@@ -83,6 +83,10 @@ export {
   - `asc` - enforce properties to be in ascending order.
   - `desc` - enforce properties to be in descending order.
 
+### `ignore-case`
+
+- `boolean` (default: `false`) - only affects alphabetical and natural sorting. When `true` the rule ignores the case-sensitivity of the order.
+
 ## ⚙️ Usage
 
 ### Legacy Config

diff --git a/docs/rules/sort-object-keys.md b/docs/rules/sort-object-keys.md
@@ -77,6 +77,10 @@ let family = {
   - `asc` - enforce properties to be in ascending order.
   - `desc` - enforce properties to be in descending order.
 
+### `ignore-case`
+
+- `boolean` (default: `false`) - only affects alphabetical and natural sorting. When `true` the rule ignores the case-sensitivity of the order.
+
 ## ⚙️ Usage
 
 ### Legacy Config

diff --git a/docs/rules/sort-union-types.md b/docs/rules/sort-union-types.md
@@ -79,6 +79,10 @@ type DevilHunter =
   - `asc` - enforce properties to be in ascending order.
   - `desc` - enforce properties to be in descending order.
 
+### `ignore-case`
+
+- `boolean` (default: `false`) - only affects alphabetical and natural sorting. When `true` the rule ignores the case-sensitivity of the order.
+
 ## ⚙️ Usage
 
 ### Legacy Config

diff --git a/index.ts b/index.ts
@@ -18,6 +18,7 @@ type RuleDeclaration = [RuleSeverity, { [key: string]: unknown }?]
 let createConfigWithOptions = (options: {
   type: SortType
   order: SortOrder
+  'ignore-case'?: boolean
 }): {
   plugins: ['perfectionist']
   rules: {
@@ -84,10 +85,12 @@ export default {
     'recommended-alphabetical': createConfigWithOptions({
       type: SortType.alphabetical,
       order: SortOrder.asc,
+      'ignore-case': false,
     }),
     'recommended-natural': createConfigWithOptions({
       type: SortType.natural,
       order: SortOrder.asc,
+      'ignore-case': false,
     }),
     'recommended-line-length': createConfigWithOptions({
       type: SortType['line-length'],

diff --git a/rules/sort-array-includes.ts b/rules/sort-array-includes.ts
@@ -16,9 +16,10 @@ type MESSAGE_ID = 'unexpectedArrayIncludesOrder'
 
 type Options = [
   Partial<{
+    spreadLast: boolean
+    'ignore-case': boolean
     order: SortOrder
     type: SortType
-    spreadLast: boolean
   }>,
 ]
 
@@ -49,6 +50,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
             enum: [SortOrder.asc, SortOrder.desc],
             default: SortOrder.asc,
           },
+          'ignore-case': {
+            type: 'boolean',
+            default: false,
+          },
           spreadLast: {
             type: 'boolean',
             default: false,
@@ -79,6 +84,7 @@ export default createEslintRule<Options, MESSAGE_ID>({
         let options = complete(context.options.at(0), {
           type: SortType.alphabetical,
           order: SortOrder.asc,
+          'ignore-case': false,
           spreadLast: false,
         })
 

diff --git a/rules/sort-enums.ts b/rules/sort-enums.ts
@@ -15,6 +15,7 @@ type MESSAGE_ID = 'unexpectedEnumsOrder'
 
 type Options = [
   Partial<{
+    'ignore-case': boolean
     order: SortOrder
     type: SortType
   }>,
@@ -43,6 +44,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
             ],
             default: SortType.natural,
           },
+          'ignore-case': {
+            type: 'boolean',
+            default: false,
+          },
           order: {
             enum: [SortOrder.asc, SortOrder.desc],
             default: SortOrder.asc,
@@ -66,6 +71,7 @@ export default createEslintRule<Options, MESSAGE_ID>({
       let options = complete(context.options.at(0), {
         type: SortType.alphabetical,
         order: SortOrder.asc,
+        'ignore-case': false,
       })
 
       if (node.members.length > 1) {

diff --git a/rules/sort-imports.ts b/rules/sort-imports.ts
@@ -50,6 +50,7 @@ type Options = [
     'internal-pattern': string[]
     groups: (Group[] | Group)[]
     'read-tsconfig': boolean
+    'ignore-case': boolean
   }>,
 ]
 
@@ -86,6 +87,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
             enum: [SortOrder.asc, SortOrder.desc],
             default: SortOrder.asc,
           },
+          'ignore-case': {
+            type: 'boolean',
+            default: false,
+          },
           groups: {
             type: 'array',
             default: [],
@@ -132,6 +137,7 @@ export default createEslintRule<Options, MESSAGE_ID>({
       type: SortType.alphabetical,
       'read-tsconfig': false,
       order: SortOrder.asc,
+      'ignore-case': false,
       groups: ['unknown'],
     })
 

diff --git a/rules/sort-interfaces.ts b/rules/sort-interfaces.ts
@@ -18,6 +18,7 @@ type Options = [
   Partial<{
     order: SortOrder
     type: SortType
+    'ignore-case': boolean
     'ignore-pattern': string[]
   }>,
 ]
@@ -49,6 +50,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
             enum: [SortOrder.asc, SortOrder.desc],
             default: SortOrder.asc,
           },
+          'ignore-case': {
+            type: 'boolean',
+            default: false,
+          },
           'ignore-pattern': {
             type: 'array',
             default: [],
@@ -72,6 +77,7 @@ export default createEslintRule<Options, MESSAGE_ID>({
     TSInterfaceDeclaration: node => {
       let options = complete(context.options.at(0), {
         type: SortType.alphabetical,
+        'ignore-case': false,
         order: SortOrder.asc,
         'ignore-pattern': [],
       })

diff --git a/rules/sort-jsx-props.ts b/rules/sort-jsx-props.ts
@@ -18,6 +18,7 @@ type Options = [
   Partial<{
     order: SortOrder
     type: SortType
+    'ignore-case': boolean
   }>,
 ]
 
@@ -48,6 +49,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
             enum: [SortOrder.asc, SortOrder.desc],
             default: SortOrder.asc,
           },
+          'ignore-case': {
+            type: 'boolean',
+            default: false,
+          },
         },
         additionalProperties: false,
       },
@@ -67,6 +72,7 @@ export default createEslintRule<Options, MESSAGE_ID>({
     JSXElement: node => {
       let options = complete(context.options.at(0), {
         type: SortType.alphabetical,
+        'ignore-case': false,
         order: SortOrder.asc,
       })
 

diff --git a/rules/sort-map-elements.ts b/rules/sort-map-elements.ts
@@ -16,6 +16,7 @@ type MESSAGE_ID = 'unexpectedMapElementsOrder'
 
 type Options = [
   Partial<{
+    'ignore-case': boolean
     order: SortOrder
     type: SortType
   }>,
@@ -48,6 +49,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
             enum: [SortOrder.asc, SortOrder.desc],
             default: SortOrder.asc,
           },
+          'ignore-case': {
+            type: 'boolean',
+            default: false,
+          },
         },
         additionalProperties: false,
       },
@@ -72,6 +77,7 @@ export default createEslintRule<Options, MESSAGE_ID>({
       ) {
         let options = complete(context.options.at(0), {
           type: SortType.alphabetical,
+          'ignore-case': false,
           order: SortOrder.asc,
         })
 

diff --git a/rules/sort-named-exports.ts b/rules/sort-named-exports.ts
@@ -13,6 +13,7 @@ type MESSAGE_ID = 'unexpectedNamedExportsOrder'
 
 type Options = [
   Partial<{
+    'ignore-case': boolean
     order: SortOrder
     type: SortType
   }>,
@@ -45,6 +46,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
             enum: [SortOrder.asc, SortOrder.desc],
             default: SortOrder.asc,
           },
+          'ignore-case': {
+            type: 'boolean',
+            default: false,
+          },
         },
         additionalProperties: false,
       },
@@ -64,6 +69,7 @@ export default createEslintRule<Options, MESSAGE_ID>({
     ExportNamedDeclaration: node => {
       let options = complete(context.options.at(0), {
         type: SortType.alphabetical,
+        'ignore-case': false,
         order: SortOrder.asc,
       })
 

diff --git a/rules/sort-named-imports.ts b/rules/sort-named-imports.ts
@@ -13,6 +13,7 @@ type MESSAGE_ID = 'unexpectedNamedImportsOrder'
 
 type Options = [
   Partial<{
+    'ignore-case': boolean
     order: SortOrder
     type: SortType
   }>,
@@ -45,6 +46,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
             enum: [SortOrder.asc, SortOrder.desc],
             default: SortOrder.asc,
           },
+          'ignore-case': {
+            type: 'boolean',
+            default: false,
+          },
         },
         additionalProperties: false,
       },
@@ -64,6 +69,7 @@ export default createEslintRule<Options, MESSAGE_ID>({
     ImportDeclaration: node => {
       let options = complete(context.options.at(0), {
         type: SortType.alphabetical,
+        'ignore-case': false,
         order: SortOrder.asc,
       })
 

diff --git a/rules/sort-object-keys.ts b/rules/sort-object-keys.ts
@@ -16,6 +16,7 @@ type MESSAGE_ID = 'unexpectedObjectKeysOrder'
 
 type Options = [
   Partial<{
+    'ignore-case': boolean
     order: SortOrder
     type: SortType
   }>,
@@ -48,6 +49,10 @@ export default createEslintRule<Options, MESSAGE_ID>({
             enum: [SortOrder.asc, SortOrder.desc],
             default: SortOrder.asc,
           },
+          'ignore-case': {
+            type: 'boolean',
+            default: false,
+          },
         },
         additionalProperties: false,
       },
@@ -68,6 +73,7 @@ export default createEslintRule<Options, MESSAGE_ID>({
       if (node.properties.length > 1) {
         let options = complete(context.options.at(0), {
           type: SortType.alphabetical,
+          'ignore-case': false,
           order: SortOrder.asc,
         })