feat: Add option to disable newlines within group sorting

import-js · Mar 3, 2022 · b114b69 · b114b69
1 parent b0e6f7f
commit b114b69
Show file tree

Hide file tree

Showing 2 changed files with 80 additions and 5 deletions.
diff --git a/src/rules/order.js b/src/rules/order.js
@@ -299,7 +299,11 @@ function mutateRanksToAlphabetize(imported, alphabetizeOptions) {
 
 function computePathRank(ranks, pathGroups, path, maxPosition) {
   for (let i = 0, l = pathGroups.length; i < l; i++) {
-    const { pattern, patternOptions, group, position = 1 } = pathGroups[i];
+    const { pattern, patternOptions, group, position = 1, insertNewline } = pathGroups[i];
+    if (!insertNewline) {
+      return undefined;
+    }
+
     if (minimatch(path, pattern, patternOptions || { nocomment: true })) {
       return ranks[group] + (position / maxPosition);
     }
@@ -547,7 +551,12 @@ module.exports = {
                   type: 'string',
                   enum: ['after', 'before'],
                 },
+                insertNewline: {
+                  type: 'boolean',
+                  default: true,
+                },
               },
+              additionalProperties: false,
               required: ['pattern', 'group'],
             },
           },

diff --git a/tests/src/rules/order.js b/tests/src/rules/order.js
@@ -855,13 +855,13 @@ ruleTester.run('order', rule, {
         import express from 'express';
 
         import service from '@/api/service';
-        
+
         import fooParent from '../foo';
-        
+
         import fooSibling from './foo';
-        
+
         import index from './';
-        
+
         import internalDoesNotExistSoIsUnknown from '@/does-not-exist';
       `,
       options: [
@@ -884,6 +884,45 @@ ruleTester.run('order', rule, {
         },
       },
     }),
+    test({
+      code: `
+        import a from "a"
+
+        import A from "A"
+      `,
+      options: [{
+        alphabetize: { caseInsensitive: true },
+        pathGroups: [
+          {
+            pattern: '[a-z]*',
+            group: 'external',
+            position: 'before',
+            insertNewline: true,
+          },
+        ],
+        pathGroupsExcludedImportTypes: [],
+        'newlines-between': 'always',
+      }],
+    }),
+    test({
+      code: `
+        import a from "a"
+        import A from "A"
+      `,
+      options: [{
+        alphabetize: { caseInsensitive: true },
+        pathGroups: [
+          {
+            pattern: '[a-z]*',
+            group: 'external',
+            position: 'before',
+            insertNewline: false,
+          },
+        ],
+        pathGroupsExcludedImportTypes: [],
+        'newlines-between': 'always',
+      }],
+    }),
   ],
   invalid: [
     // builtin before external module (require)
@@ -2314,6 +2353,33 @@ ruleTester.run('order', rule, {
         }],
       }),
     ],
+    test({
+      code: `
+        import a from "a"
+        import A from "A"
+      `,
+      output: `
+        import a from "a"
+
+        import A from "A"
+      `,
+      options: [{
+        alphabetize: { caseInsensitive: true },
+        pathGroups: [
+          {
+            pattern: '[a-z]*',
+            group: 'external',
+            position: 'before',
+            insertNewline: true,
+          },
+        ],
+        pathGroupsExcludedImportTypes: [],
+        'newlines-between': 'always',
+      }],
+      errors: [{
+        message: 'There should be at least one empty line between import groups',
+      }],
+    }),
   ].filter((t) => !!t),
 });