feat: added tests

Hugo.PRUNAUX · hugop95 · commit 20092dc2fc8b · 2024-08-31T22:21:23.000+02:00
diff --git a/rules/sort-astro-attributes.ts b/rules/sort-astro-attributes.ts
@@ -139,7 +139,6 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
             groups: [],
           } as const)
 
-          // Validate groups config
           validateGroupsConfiguration(
             options.groups,
             ['astro-shorthand', 'multiline', 'shorthand', 'unknown'],
diff --git a/rules/sort-imports.ts b/rules/sort-imports.ts
@@ -257,7 +257,6 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
       options.groups = [...options.groups, 'unknown']
     }
 
-    // Validate groups config
     validateGroupsConfiguration(
       options.groups,
       [
diff --git a/rules/sort-interfaces.ts b/rules/sort-interfaces.ts
@@ -152,7 +152,6 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
           groups: [],
         } as const)
 
-        // Validate groups config
         validateGroupsConfiguration(
           options.groups,
           ['multiline', 'unknown'],
diff --git a/rules/sort-intersection-types.ts b/rules/sort-intersection-types.ts
@@ -114,7 +114,6 @@ export default createEslintRule<Options, MESSAGE_ID>({
         groups: [],
       } as const)
 
-      // Validate groups config
       validateGroupsConfiguration(
         options.groups,
         [
diff --git a/rules/sort-jsx-props.ts b/rules/sort-jsx-props.ts
@@ -140,7 +140,6 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
           groups: [],
         } as const)
 
-        // Validate groups config
         validateGroupsConfiguration(
           options.groups,
           ['multiline', 'shorthand', 'unknown'],
diff --git a/rules/sort-object-types.ts b/rules/sort-object-types.ts
@@ -141,7 +141,6 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
           groups: [],
         } as const)
 
-        // Validate groups config
         validateGroupsConfiguration(
           options.groups,
           ['multiline', 'unknown'],
diff --git a/rules/sort-objects.ts b/rules/sort-objects.ts
@@ -192,7 +192,6 @@ export default createEslintRule<Options, MESSAGE_ID>({
         groups: [],
       } as const)
 
-      // Validate groups config
       validateGroupsConfiguration(
         options.groups,
         [],
diff --git a/rules/sort-svelte-attributes.ts b/rules/sort-svelte-attributes.ts
@@ -136,7 +136,6 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
             groups: [],
           } as const)
 
-          // Validate groups config
           validateGroupsConfiguration(
             options.groups,
             ['svelte-shorthand', 'multiline', 'shorthand', 'unknown'],
diff --git a/rules/sort-union-types.ts b/rules/sort-union-types.ts
@@ -114,7 +114,6 @@ export default createEslintRule<Options, MESSAGE_ID>({
         groups: [],
       } as const)
 
-      // Validate groups config
       validateGroupsConfiguration(
         options.groups,
         [
diff --git a/rules/sort-vue-attributes.ts b/rules/sort-vue-attributes.ts
@@ -148,7 +148,6 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
             groups: [],
           } as const)
 
-          // Validate groups config
           validateGroupsConfiguration(
             options.groups,
             ['multiline', 'shorthand', 'unknown'],
diff --git a/test/sort-astro-attributes.test.ts b/test/sort-astro-attributes.test.ts
@@ -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: [
diff --git a/test/sort-imports.test.ts b/test/sort-imports.test.ts
@@ -4179,6 +4179,56 @@ describe(ruleName, () => {
     )
   })
 
+  describe(`${ruleName}: validating group configuration`, () => {
+    ruleTester.run(
+      `${ruleName}: allows predefined groups and defined custom groups`,
+      rule,
+      {
+        valid: [
+          {
+            code: dedent`
+            import type { T } from 't'
+
+            // @ts-expect-error missing types
+            import { t } from 't'
+          `,
+            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',
+                  'myCustomGroup1',
+                ],
+                customGroups: {
+                  type: {
+                    myCustomGroup1: 'x',
+                  },
+                },
+              },
+            ],
+          },
+        ],
+        invalid: [],
+      },
+    )
+  })
+
   describe(`${ruleName}: misc`, () => {
     ruleTester.run(
       `${ruleName}: sets alphabetical asc sorting as default`,
diff --git a/test/sort-interfaces.test.ts b/test/sort-interfaces.test.ts
@@ -2203,6 +2203,35 @@ describe(ruleName, () => {
     )
   })
 
+  describe(`${ruleName}: validating group configuration`, () => {
+    ruleTester.run(
+      `${ruleName}: allows predefined groups and defined custom groups`,
+      rule,
+      {
+        valid: [
+          {
+            code: dedent`
+            interface Interface {
+              a: string
+              b: 'b1' | 'b2',
+              c: string
+            }
+          `,
+            options: [
+              {
+                groups: ['multiline', 'unknown', 'myCustomGroup'],
+                customGroups: {
+                  myCustomGroup: 'x',
+                },
+              },
+            ],
+          },
+        ],
+        invalid: [],
+      },
+    )
+  })
+
   describe(`${ruleName}: misc`, () => {
     ruleTester.run(
       `${ruleName}: sets alphabetical asc sorting as default`,
diff --git a/test/sort-intersection-types.test.ts b/test/sort-intersection-types.test.ts
@@ -1144,6 +1144,38 @@ describe(ruleName, () => {
     })
   })
 
+  describe(`${ruleName}: validating group configuration`, () => {
+    ruleTester.run(`${ruleName}: allows predefined groups`, rule, {
+      valid: [
+        {
+          code: dedent`
+            type Type = { label: 'aaa' } & { label: 'bb' } & { label: 'c' }
+          `,
+          options: [
+            {
+              groups: [
+                'intersection',
+                'conditional',
+                'function',
+                'operator',
+                'keyword',
+                'literal',
+                'nullish',
+                'unknown',
+                'import',
+                'object',
+                'named',
+                'tuple',
+                'union',
+              ],
+            },
+          ],
+        },
+      ],
+      invalid: [],
+    })
+  })
+
   describe(`${ruleName}: misc`, () => {
     ruleTester.run(
       `${ruleName}: sets alphabetical asc sorting as default`,
diff --git a/test/sort-jsx-props.test.ts b/test/sort-jsx-props.test.ts
@@ -1408,6 +1408,39 @@ describe(ruleName, () => {
     })
   })
 
+  describe(`${ruleName}: validating group configuration`, () => {
+    ruleTester.run(
+      `${ruleName}: allows predefined groups and defined custom groups`,
+      rule,
+      {
+        valid: [
+          {
+            code: dedent`
+            let Component = () => (
+              <Element
+                a="aaa"
+                b="bb"
+                c="c"
+              >
+                Value
+              </Element>
+            )
+          `,
+            options: [
+              {
+                groups: ['multiline', 'shorthand', 'unknown', 'myCustomGroup'],
+                customGroups: {
+                  myCustomGroup: 'x',
+                },
+              },
+            ],
+          },
+        ],
+        invalid: [],
+      },
+    )
+  })
+
   describe(`${ruleName}: misc`, () => {
     ruleTester.run(
       `${ruleName}: sets alphabetical asc sorting as default`,
diff --git a/test/sort-object-types.test.ts b/test/sort-object-types.test.ts
@@ -1740,6 +1740,35 @@ describe(ruleName, () => {
     )
   })
 
+  describe(`${ruleName}: validating group configuration`, () => {
+    ruleTester.run(
+      `${ruleName}: allows predefined groups and defined custom groups`,
+      rule,
+      {
+        valid: [
+          {
+            code: dedent`
+            type Type = {
+              a: 'aaa'
+              b: 'bb'
+              c: 'c'
+            }
+          `,
+            options: [
+              {
+                groups: ['multiline', 'unknown', 'myCustomGroup'],
+                customGroups: {
+                  myCustomGroup: 'x',
+                },
+              },
+            ],
+          },
+        ],
+        invalid: [],
+      },
+    )
+  })
+
   describe('misc', () => {
     ruleTester.run(`${ruleName}: ignores semi at the end of value`, rule, {
       valid: [
diff --git a/test/sort-svelte-attributes.test.ts b/test/sort-svelte-attributes.test.ts
@@ -1340,6 +1340,42 @@ describe(ruleName, () => {
     })
   })
 
+  describe(`${ruleName}: validating group configuration`, () => {
+    ruleTester.run(
+      `${ruleName}: allows predefined groups and defined custom groups`,
+      rule,
+      {
+        valid: [
+          {
+            filename: 'file.svelte',
+            code: dedent`
+              <script>
+                import Component from '../file2.svelte'
+              </script>
+
+              <Component a="aaa" b="bb" />
+            `,
+            options: [
+              {
+                groups: [
+                  'svelte-shorthand',
+                  'multiline',
+                  'shorthand',
+                  'unknown',
+                  'myCustomGroup',
+                ],
+                customGroups: {
+                  myCustomGroup: 'x',
+                },
+              },
+            ],
+          },
+        ],
+        invalid: [],
+      },
+    )
+  })
+
   describe(`${ruleName}: misc`, () => {
     ruleTester.run(`${ruleName}: works only with .svelte files`, rule, {
       valid: [
diff --git a/test/sort-union-types.test.ts b/test/sort-union-types.test.ts
diff --git a/test/sort-vue-attributes.test.ts b/test/sort-vue-attributes.test.ts
diff --git a/test/validate-groups-configuration.test.ts b/test/validate-groups-configuration.test.ts
diff --git a/utils/validate-groups-configuration.ts b/utils/validate-groups-configuration.ts

Original file line number	Diff line number	Diff line change
`@@ -257,7 +257,6 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({`
`257`	`257`	`options.groups = [...options.groups, 'unknown']`
`258`	`258`	`}`
`259`	`259`
`260`		`- // Validate groups config`
`261`	`260`	`validateGroupsConfiguration(`
`262`	`261`	`options.groups,`
`263`	`262`	`[`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,6 @@ export default createEslintRule<Options, MESSAGE_ID>({`
`114`	`114`	`groups: [],`
`115`	`115`	`} as const)`
`116`	`116`
`117`		`- // Validate groups config`
`118`	`117`	`validateGroupsConfiguration(`
`119`	`118`	`options.groups,`
`120`	`119`	`[`