fix: shortest import should prefer alias with ~ at the start

Resolves the following scenario; * `../Common/ShopSelect` * `~/Common/ShopSelect` These are considered “same length” but we want to prefer the `~` alias path as it’s easier to read than the relative path.
tablecheck · Nov 1, 2023 · 1d1ba82 · 1d1ba82
1 parent 912df07
commit 1d1ba82
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 4 deletions.
diff --git a/packages/eslint-plugin/__tests__/shortestImport.test.ts b/packages/eslint-plugin/__tests__/shortestImport.test.ts
@@ -172,6 +172,10 @@ typescriptSetups.forEach((config) => {
           path: '~/feature2/index',
           filename: './test_src/feature1/slice1/index.ts',
         },
+        {
+          path: '~/feature2/index',
+          filename: './test_src/feature1/index.ts',
+        },
         {
           path: '~/feature1/index',
           filename: './test_src/feature1/slice1/index.ts',

diff --git a/packages/eslint-plugin/src/shortestImport.ts b/packages/eslint-plugin/src/shortestImport.ts
@@ -291,10 +291,18 @@ class RuleChecker {
         return avoidRelativeParents.includes(relativeRoot);
       });
     const allPathsWithLength = (aliasPaths.length ? aliasPaths : baseUrlPaths)
-      .map((aliasPath) => ({
-        aliasPath,
-        length: aliasPath.split('/').length,
-      }))
+      .map((aliasPath) => {
+        const parts = aliasPath.split('/');
+        if (parts[0].match(/^[^a-z0-9]$/i))
+          return {
+            aliasPath,
+            length: parts.length - 1,
+          };
+        return {
+          aliasPath,
+          length: parts.length,
+        };
+      })
       .sort((a, b) => a.length - b.length);
 
     const shortestAliasPath = allPathsWithLength[0];