feat: generate exception if group does not exist

azat-io · Sep 1, 2024 · 0872bdd · 0872bdd
1 parent d9c72d2
commit 0872bdd
Show file tree

Hide file tree

Showing 21 changed files with 480 additions and 5 deletions.
diff --git a/rules/sort-astro-attributes.ts b/rules/sort-astro-attributes.ts
@@ -5,6 +5,7 @@ import path from 'node:path'
 
 import type { SortingNode } from '../typings'
 
+import { validateGroupsConfiguration } from '../utils/validate-groups-configuration'
 import { createEslintRule } from '../utils/create-eslint-rule'
 import { getGroupNumber } from '../utils/get-group-number'
 import { getSourceCode } from '../utils/get-source-code'
@@ -138,6 +139,12 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
             groups: [],
           } as const)
 
+          validateGroupsConfiguration(
+            options.groups,
+            ['astro-shorthand', 'multiline', 'shorthand', 'unknown'],
+            Object.keys(options.customGroups),
+          )
+
           let sourceCode = getSourceCode(context)
 
           let parts: SortingNode[][] = attributes.reduce(

diff --git a/rules/sort-imports.ts b/rules/sort-imports.ts
@@ -6,6 +6,7 @@ import { minimatch } from 'minimatch'
 
 import type { SortingNode } from '../typings'
 
+import { validateGroupsConfiguration } from '../utils/validate-groups-configuration'
 import { getCommentBefore } from '../utils/get-comment-before'
 import { createEslintRule } from '../utils/create-eslint-rule'
 import { getLinesBetween } from '../utils/get-lines-between'
@@ -256,6 +257,34 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
       options.groups = [...options.groups, 'unknown']
     }
 
+    validateGroupsConfiguration(
+      options.groups,
+      [
+        'side-effect-style',
+        'external-type',
+        'internal-type',
+        'builtin-type',
+        'sibling-type',
+        'parent-type',
+        'side-effect',
+        'index-type',
+        'internal',
+        'external',
+        'sibling',
+        'unknown',
+        'builtin',
+        'parent',
+        'object',
+        'index',
+        'style',
+        'type',
+      ],
+      [
+        ...Object.keys(options.customGroups.type ?? {}),
+        ...Object.keys(options.customGroups.value ?? {}),
+      ],
+    )
+
     let nodes: SortingNode[] = []
 
     let isSideEffectImport = (node: TSESTree.Node) =>

diff --git a/rules/sort-interfaces.ts b/rules/sort-interfaces.ts
@@ -2,6 +2,7 @@ import { minimatch } from 'minimatch'
 
 import type { SortingNode } from '../typings'
 
+import { validateGroupsConfiguration } from '../utils/validate-groups-configuration'
 import { createEslintRule } from '../utils/create-eslint-rule'
 import { isMemberOptional } from '../utils/is-member-optional'
 import { getLinesBetween } from '../utils/get-lines-between'
@@ -151,6 +152,12 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
           groups: [],
         } as const)
 
+        validateGroupsConfiguration(
+          options.groups,
+          ['multiline', 'unknown'],
+          Object.keys(options.customGroups),
+        )
+
         let sourceCode = getSourceCode(context)
 
         if (

diff --git a/rules/sort-intersection-types.ts b/rules/sort-intersection-types.ts
@@ -1,5 +1,6 @@
 import type { SortingNode } from '../typings'
 
+import { validateGroupsConfiguration } from '../utils/validate-groups-configuration'
 import { createEslintRule } from '../utils/create-eslint-rule'
 import { getGroupNumber } from '../utils/get-group-number'
 import { getSourceCode } from '../utils/get-source-code'
@@ -113,6 +114,26 @@ export default createEslintRule<Options, MESSAGE_ID>({
         groups: [],
       } as const)
 
+      validateGroupsConfiguration(
+        options.groups,
+        [
+          'intersection',
+          'conditional',
+          'function',
+          'operator',
+          'keyword',
+          'literal',
+          'nullish',
+          'unknown',
+          'import',
+          'object',
+          'named',
+          'tuple',
+          'union',
+        ],
+        [],
+      )
+
       let sourceCode = getSourceCode(context)
 
       let nodes: SortingNode[] = node.types.map(type => {

diff --git a/rules/sort-jsx-props.ts b/rules/sort-jsx-props.ts
@@ -4,6 +4,7 @@ import { minimatch } from 'minimatch'
 
 import type { SortingNode } from '../typings'
 
+import { validateGroupsConfiguration } from '../utils/validate-groups-configuration'
 import { createEslintRule } from '../utils/create-eslint-rule'
 import { getGroupNumber } from '../utils/get-group-number'
 import { getSourceCode } from '../utils/get-source-code'
@@ -139,6 +140,12 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
           groups: [],
         } as const)
 
+        validateGroupsConfiguration(
+          options.groups,
+          ['multiline', 'shorthand', 'unknown'],
+          Object.keys(options.customGroups),
+        )
+
         let sourceCode = getSourceCode(context)
 
         let shouldIgnore = false

diff --git a/rules/sort-object-types.ts b/rules/sort-object-types.ts
@@ -2,6 +2,7 @@ import type { TSESTree } from '@typescript-eslint/types'
 
 import type { SortingNode } from '../typings'
 
+import { validateGroupsConfiguration } from '../utils/validate-groups-configuration'
 import { createEslintRule } from '../utils/create-eslint-rule'
 import { getLinesBetween } from '../utils/get-lines-between'
 import { getGroupNumber } from '../utils/get-group-number'
@@ -24,12 +25,12 @@ type Group<T extends string[]> = 'multiline' | 'unknown' | T[number]
 type Options<T extends string[]> = [
   Partial<{
     groupKind: 'required-first' | 'optional-first' | 'mixed'
+    customGroups: { [key in T[number]]: string[] | string }
     type: 'alphabetical' | 'line-length' | 'natural'
     groups: (Group<T>[] | Group<T>)[]
     partitionByNewLine: boolean
     order: 'desc' | 'asc'
     ignoreCase: boolean
-    customGroups: {}
   }>,
 ]
 
@@ -140,6 +141,12 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
           groups: [],
         } as const)
 
+        validateGroupsConfiguration(
+          options.groups,
+          ['multiline', 'unknown'],
+          Object.keys(options.customGroups),
+        )
+
         let sourceCode = getSourceCode(context)
 
         let formattedMembers: SortingNode<TSESTree.TypeElement>[][] =

diff --git a/rules/sort-objects.ts b/rules/sort-objects.ts
@@ -5,6 +5,7 @@ import { minimatch } from 'minimatch'
 
 import type { SortingNode } from '../typings'
 
+import { validateGroupsConfiguration } from '../utils/validate-groups-configuration'
 import { isPartitionComment } from '../utils/is-partition-comment'
 import { getCommentBefore } from '../utils/get-comment-before'
 import { createEslintRule } from '../utils/create-eslint-rule'
@@ -30,6 +31,8 @@ export enum Position {
   'ignore' = 'ignore',
 }
 
+type Group = 'unknown' | string
+
 type SortingNodeWithPosition = {
   position: Position
 } & SortingNode
@@ -39,7 +42,7 @@ type Options = [
     customGroups: { [key: string]: string[] | string }
     type: 'alphabetical' | 'line-length' | 'natural'
     partitionByComment: string[] | boolean | string
-    groups: (string[] | string)[]
+    groups: (Group[] | Group)[]
     partitionByNewLine: boolean
     styledComponents: boolean
     destructureOnly: boolean
@@ -191,6 +194,12 @@ export default createEslintRule<Options, MESSAGE_ID>({
         groups: [],
       } as const)
 
+      validateGroupsConfiguration(
+        options.groups,
+        ['unknown'],
+        Object.keys(options.customGroups),
+      )
+
       let shouldIgnore = false
 
       if (options.destructureOnly) {

diff --git a/rules/sort-svelte-attributes.ts b/rules/sort-svelte-attributes.ts
@@ -5,6 +5,7 @@ import path from 'node:path'
 
 import type { SortingNode } from '../typings'
 
+import { validateGroupsConfiguration } from '../utils/validate-groups-configuration'
 import { createEslintRule } from '../utils/create-eslint-rule'
 import { getGroupNumber } from '../utils/get-group-number'
 import { getSourceCode } from '../utils/get-source-code'
@@ -135,6 +136,12 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
             groups: [],
           } as const)
 
+          validateGroupsConfiguration(
+            options.groups,
+            ['svelte-shorthand', 'multiline', 'shorthand', 'unknown'],
+            Object.keys(options.customGroups),
+          )
+
           let sourceCode = getSourceCode(context)
 
           let parts: SortingNode[][] = node.attributes.reduce(

diff --git a/rules/sort-union-types.ts b/rules/sort-union-types.ts
@@ -1,5 +1,6 @@
 import type { SortingNode } from '../typings'
 
+import { validateGroupsConfiguration } from '../utils/validate-groups-configuration'
 import { createEslintRule } from '../utils/create-eslint-rule'
 import { getGroupNumber } from '../utils/get-group-number'
 import { getSourceCode } from '../utils/get-source-code'
@@ -113,6 +114,26 @@ export default createEslintRule<Options, MESSAGE_ID>({
         groups: [],
       } as const)
 
+      validateGroupsConfiguration(
+        options.groups,
+        [
+          'intersection',
+          'conditional',
+          'function',
+          'operator',
+          'keyword',
+          'literal',
+          'nullish',
+          'unknown',
+          'import',
+          'object',
+          'named',
+          'tuple',
+          'union',
+        ],
+        [],
+      )
+
       let sourceCode = getSourceCode(context)
 
       let nodes: SortingNode[] = node.types.map(type => {

diff --git a/rules/sort-vue-attributes.ts b/rules/sort-vue-attributes.ts
@@ -5,6 +5,7 @@ import path from 'node:path'
 
 import type { SortingNode } from '../typings'
 
+import { validateGroupsConfiguration } from '../utils/validate-groups-configuration'
 import { createEslintRule } from '../utils/create-eslint-rule'
 import { getGroupNumber } from '../utils/get-group-number'
 import { getSourceCode } from '../utils/get-source-code'
@@ -147,6 +148,12 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
             groups: [],
           } as const)
 
+          validateGroupsConfiguration(
+            options.groups,
+            ['multiline', 'shorthand', 'unknown'],
+            Object.keys(options.customGroups),
+          )
+
           let parts: SortingNode[][] = node.attributes.reduce(
             (accumulator: SortingNode[][], attribute) => {
               if (

diff --git a/test/sort-astro-attributes.test.ts b/test/sort-astro-attributes.test.ts
@@ -270,7 +270,7 @@ describe(ruleName, () => {
             options: [
               {
                 ...options,
-                groups: ['unknown', ['svelte-shorthand', 'shorthand']],
+                groups: ['unknown', ['shorthand']],
               },
             ],
             errors: [
@@ -699,7 +699,7 @@ describe(ruleName, () => {
             options: [
               {
                 ...options,
-                groups: ['unknown', ['svelte-shorthand', 'shorthand']],
+                groups: ['unknown', ['shorthand']],
               },
             ],
             errors: [
@@ -1130,7 +1130,7 @@ describe(ruleName, () => {
             options: [
               {
                 ...options,
-                groups: ['unknown', ['svelte-shorthand', 'shorthand']],
+                groups: ['unknown', ['shorthand']],
               },
             ],
             errors: [
@@ -1333,6 +1333,41 @@ describe(ruleName, () => {
     })
   })
 
+  describe(`${ruleName}: validating group configuration`, () => {
+    ruleTester.run(
+      `${ruleName}: allows predefined groups and defined custom groups`,
+      rule,
+      {
+        valid: [
+          {
+            filename: 'file.astro',
+            code: dedent`
+          ---
+            import Component from '../file2.astro'
+          ---
+          <Component a="a" bb="b" />
+        `,
+            options: [
+              {
+                groups: [
+                  'astro-shorthand',
+                  'multiline',
+                  'shorthand',
+                  'unknown',
+                  'myCustomGroup',
+                ],
+                customGroups: {
+                  myCustomGroup: 'x',
+                },
+              },
+            ],
+          },
+        ],
+        invalid: [],
+      },
+    )
+  })
+
   describe(`${ruleName}: misc`, () => {
     ruleTester.run(`${ruleName}: works only for .astro files`, rule, {
       valid: [