feat: add custom group newlines inside option

azat-io · Dec 23, 2024 · 3b3d2d5 · 3b3d2d5
1 parent b13976d
commit 3b3d2d5
Show file tree

Hide file tree

Showing 18 changed files with 793 additions and 144 deletions.
diff --git a/docs/content/rules/sort-classes.mdx b/docs/content/rules/sort-classes.mdx
@@ -599,6 +599,7 @@ interface CustomGroupDefinition {
   groupName: string
   type?: 'alphabetical' | 'natural' | 'line-length' | 'unsorted'
   order?: 'asc' | 'desc'
+  newlinesInside?: 'always' | 'never'
   selector?: string
   modifiers?: string[]
   elementNamePattern?: string
@@ -615,6 +616,7 @@ interface CustomGroupAnyOfDefinition {
   groupName: string
   type?: 'alphabetical' | 'natural' | 'line-length' | 'unsorted'
   order?: 'asc' | 'desc'
+  newlinesInside?: 'always' | 'never'
   anyOf: Array<{
       selector?: string
       modifiers?: string[]
@@ -637,6 +639,7 @@ A class member will match a `CustomGroupAnyOfDefinition` group if it matches all
 - `decoratorNamePattern`: If entered, will check that at least one `decorator` matches the pattern entered.
 - `type`: Overrides the sort type for that custom group. `unsorted` will not sort the group.
 - `order`: Overrides the sort order for that custom group
+- `newlinesInside`: Enforces a specific newline behavior between elements of the group.
 
 #### Match importance
 

diff --git a/docs/content/rules/sort-interfaces.mdx b/docs/content/rules/sort-interfaces.mdx
@@ -509,6 +509,7 @@ An interface member will match a `CustomGroupAnyOfDefinition` group if it matche
 - `elementNamePattern`: If entered, will check that the name of the element matches the pattern entered.
 - `type`: Overrides the sort type for that custom group. `unsorted` will not sort the group.
 - `order`: Overrides the sort order for that custom group
+- `newlinesInside`: Enforces a specific newline behavior between elements of the group.
 
 #### Match importance
 

diff --git a/docs/content/rules/sort-modules.mdx b/docs/content/rules/sort-modules.mdx
@@ -435,6 +435,7 @@ A module member will match a `CustomGroupAnyOfDefinition` group if it matches al
 - `decoratorNamePattern`: If entered, will check that at least one `decorator` matches the pattern entered.
 - `type`: Overrides the sort type for that custom group. `unsorted` will not sort the group.
 - `order`: Overrides the sort order for that custom group
+- `newlinesInside`: Enforces a specific newline behavior between elements of the group.
 
 #### Match importance
 

diff --git a/docs/content/rules/sort-object-types.mdx b/docs/content/rules/sort-object-types.mdx
@@ -474,6 +474,7 @@ An object type will match a `CustomGroupAnyOfDefinition` group if it matches all
 - `elementNamePattern`: If entered, will check that the name of the element matches the pattern entered.
 - `type`: Overrides the sort type for that custom group. `unsorted` will not sort the group.
 - `order`: Overrides the sort order for that custom group
+- `newlinesInside`: Enforces a specific newline behavior between elements of the group.
 
 #### Match importance
 

diff --git a/rules/sort-classes/types.ts b/rules/sort-classes/types.ts
@@ -36,6 +36,19 @@ export type SingleCustomGroup =
   | BaseSingleCustomGroup<ConstructorSelector>
   | AdvancedSingleCustomGroup<MethodSelector>
 
+export type CustomGroup = (
+  | {
+      order?: SortClassesOptions[0]['order']
+      type?: SortClassesOptions[0]['type']
+    }
+  | {
+      type?: 'unsorted'
+    }
+) & {
+  newlinesInside?: 'always' | 'never'
+  groupName: string
+} & (SingleCustomGroup | AnyOfCustomGroup)
+
 export type NonDeclarePropertyGroup = JoinWithDash<
   [
     PublicOrProtectedOrPrivateModifier,
@@ -202,19 +215,6 @@ type Group =
   | 'unknown'
   | string
 
-type CustomGroup = (
-  | {
-      order?: SortClassesOptions[0]['order']
-      type?: SortClassesOptions[0]['type']
-    }
-  | {
-      type?: 'unsorted'
-    }
-) &
-  (SingleCustomGroup | AnyOfCustomGroup) & {
-    groupName: string
-  }
-
 type AdvancedSingleCustomGroup<T extends Selector> = {
   decoratorNamePattern?: string
   elementValuePattern?: string

diff --git a/rules/sort-imports.ts b/rules/sort-imports.ts
@@ -537,12 +537,15 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
             messageIds = [
               ...messageIds,
               ...getNewlinesErrors({
+                options: {
+                  ...options,
+                  customGroups: [],
+                },
                 missedSpacingError: 'missedSpacingBetweenImports',
                 extraSpacingError: 'extraSpacingBetweenImports',
                 rightNum: rightNumber,
                 leftNum: leftNumber,
                 sourceCode,
-                options,
                 right,
                 left,
               }),
@@ -559,10 +562,13 @@ export default createEslintRule<Options<string[]>, MESSAGE_ID>({
                     fixer,
                   }),
                   ...makeNewlinesFixes({
+                    options: {
+                      ...options,
+                      customGroups: [],
+                    },
                     sortedNodes: sortedNodesExcludingEslintDisabled,
                     nodes: nodeList,
                     sourceCode,
-                    options,
                     fixer,
                   }),
                 ],

diff --git a/rules/sort-modules/types.ts b/rules/sort-modules/types.ts
@@ -75,10 +75,10 @@ type CustomGroup = (
   | {
       type?: 'unsorted'
     }
-) &
-  (SingleCustomGroup | AnyOfCustomGroup) & {
-    groupName: string
-  }
+) & {
+  newlinesInside?: 'always' | 'never'
+  groupName: string
+} & (SingleCustomGroup | AnyOfCustomGroup)
 /**
  * Only used in code, so I don't know if it's worth maintaining this.
  */

diff --git a/rules/sort-object-types/types.ts b/rules/sort-object-types/types.ts
@@ -75,10 +75,10 @@ type CustomGroup = (
   | {
       type?: 'unsorted'
     }
-) &
-  (SingleCustomGroup | AnyOfCustomGroup) & {
-    groupName: string
-  }
+) & {
+  newlinesInside?: 'always' | 'never'
+  groupName: string
+} & (SingleCustomGroup | AnyOfCustomGroup)
 
 type IndexSignatureGroup = JoinWithDash<
   [

diff --git a/test/rules/sort-classes.test.ts b/test/rules/sort-classes.test.ts
@@ -7787,6 +7787,114 @@ describe(ruleName, () => {
         invalid: [],
       },
     )
+
+    describe('newlinesInside', () => {
+      ruleTester.run(
+        `${ruleName}: allows to use newlinesInside: always`,
+        rule,
+        {
+          invalid: [
+            {
+              errors: [
+                {
+                  data: {
+                    right: 'c',
+                    left: 'b',
+                  },
+                  messageId: 'missedSpacingBetweenClassMembers',
+                },
+                {
+                  data: {
+                    right: 'd',
+                    left: 'c',
+                  },
+                  messageId: 'extraSpacingBetweenClassMembers',
+                },
+              ],
+              options: [
+                {
+                  customGroups: [
+                    {
+                      groupName: 'methodsWithNewlinesInside',
+                      newlinesInside: 'always',
+                      selector: 'method',
+                    },
+                  ],
+                  groups: ['unknown', 'methodsWithNewlinesInside'],
+                },
+              ],
+              code: dedent`
+                class Class {
+                  a
+                  b() {}
+                  c() {}
+
+
+                  d() {}
+                }
+              `,
+              output: dedent`
+                class Class {
+                  a
+                  b() {}
+
+                  c() {}
+
+                  d() {}
+                }
+            `,
+            },
+          ],
+          valid: [],
+        },
+      )
+
+      ruleTester.run(`${ruleName}: allows to use newlinesInside: never`, rule, {
+        invalid: [
+          {
+            options: [
+              {
+                customGroups: [
+                  {
+                    groupName: 'methodsWithoutNewlinesInside',
+                    newlinesInside: 'never',
+                    selector: 'method',
+                  },
+                ],
+                groups: ['unknown', 'methodsWithoutNewlinesInside'],
+              },
+            ],
+            errors: [
+              {
+                data: {
+                  right: 'd',
+                  left: 'c',
+                },
+                messageId: 'extraSpacingBetweenClassMembers',
+              },
+            ],
+            output: dedent`
+              class Class {
+                a
+
+                c() {}
+                d() {}
+              }
+            `,
+            code: dedent`
+              class Class {
+                a
+
+                c() {}
+
+                d() {}
+              }
+            `,
+          },
+        ],
+        valid: [],
+      })
+    })
   })
 
   describe(`${ruleName}: misc`, () => {

diff --git a/test/rules/sort-imports.test.ts b/test/rules/sort-imports.test.ts
@@ -290,13 +290,6 @@ describe(ruleName, () => {
               },
               messageId: 'unexpectedImportsGroupOrder',
             },
-            {
-              data: {
-                left: '~/c',
-                right: 't',
-              },
-              messageId: 'extraSpacingBetweenImports',
-            },
             {
               data: {
                 rightGroup: 'internal',
@@ -306,13 +299,6 @@ describe(ruleName, () => {
               },
               messageId: 'unexpectedImportsGroupOrder',
             },
-            {
-              data: {
-                left: '../../e',
-                right: '~/b',
-              },
-              messageId: 'extraSpacingBetweenImports',
-            },
           ],
           options: [
             {
@@ -899,13 +885,6 @@ describe(ruleName, () => {
               },
               messageId: 'unexpectedImportsGroupOrder',
             },
-            {
-              data: {
-                left: './b',
-                right: 'c',
-              },
-              messageId: 'extraSpacingBetweenImports',
-            },
           ],
           options: [
             {
@@ -2630,13 +2609,6 @@ describe(ruleName, () => {
               },
               messageId: 'unexpectedImportsGroupOrder',
             },
-            {
-              data: {
-                left: '~/c',
-                right: 't',
-              },
-              messageId: 'extraSpacingBetweenImports',
-            },
             {
               data: {
                 rightGroup: 'internal',
@@ -2646,13 +2618,6 @@ describe(ruleName, () => {
               },
               messageId: 'unexpectedImportsGroupOrder',
             },
-            {
-              data: {
-                left: '../../e',
-                right: '~/b',
-              },
-              messageId: 'extraSpacingBetweenImports',
-            },
           ],
           options: [
             {
@@ -3239,13 +3204,6 @@ describe(ruleName, () => {
               },
               messageId: 'unexpectedImportsGroupOrder',
             },
-            {
-              data: {
-                left: './b',
-                right: 'c',
-              },
-              messageId: 'extraSpacingBetweenImports',
-            },
           ],
           options: [
             {
@@ -4251,13 +4209,6 @@ describe(ruleName, () => {
               },
               messageId: 'unexpectedImportsGroupOrder',
             },
-            {
-              data: {
-                left: '~/c',
-                right: 't',
-              },
-              messageId: 'extraSpacingBetweenImports',
-            },
             {
               data: {
                 rightGroup: 'internal',
@@ -4267,13 +4218,6 @@ describe(ruleName, () => {
               },
               messageId: 'unexpectedImportsGroupOrder',
             },
-            {
-              data: {
-                left: '../../e',
-                right: '~/b',
-              },
-              messageId: 'extraSpacingBetweenImports',
-            },
           ],
           options: [
             {
@@ -4830,13 +4774,6 @@ describe(ruleName, () => {
               },
               messageId: 'unexpectedImportsGroupOrder',
             },
-            {
-              data: {
-                left: './b',
-                right: 'c',
-              },
-              messageId: 'extraSpacingBetweenImports',
-            },
           ],
           options: [
             {