fix: handle aliased re-exports

gajus · Jul 11, 2023 · 37ea66a · 37ea66a
1 parent bb2998b
commit 37ea66a
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 4 deletions.
diff --git a/.README/rules/no-barrel-import.md b/.README/rules/no-barrel-import.md
@@ -30,4 +30,22 @@ This rule handles
 * default imports
 * aliased imports
 
+You must configure `import/parsers` and `import/resolver` for this rule to work, e.g.
+
+```ts
+settings: {
+  'import/parsers': {
+    '@typescript-eslint/parser': ['.ts', '.tsx'],
+  },
+  'import/resolver': {
+    typescript: {
+      project: path.resolve(
+        __dirname,
+        'tsconfig.json',
+      ),
+    },
+  },
+},
+```
+
 <!-- assertions noBarrelImport -->
diff --git a/README.md b/README.md
@@ -326,6 +326,24 @@ This rule handles
 * default imports
 * aliased imports
 
+You must configure `import/parsers` and `import/resolver` for this rule to work, e.g.
+
+```ts
+settings: {
+  'import/parsers': {
+    '@typescript-eslint/parser': ['.ts', '.tsx'],
+  },
+  'import/resolver': {
+    typescript: {
+      project: path.resolve(
+        __dirname,
+        'tsconfig.json',
+      ),
+    },
+  },
+},
+```
+
 
 <a name="user-content-eslint-plugin-canonical-rules-no-restricted-strings"></a>
 <a name="eslint-plugin-canonical-rules-no-restricted-strings"></a>

diff --git a/tests/rules/noBarrelImport.ts b/tests/rules/noBarrelImport.ts
@@ -34,8 +34,6 @@ const invalidTest = (name: string, only: boolean = false) => {
       'utf8',
     ),
     settings: {
-      'import/extensions': ['.ts', '.tsx', '.js', '.jsx'],
-      'import/external-module-folders': ['node_modules', 'node_modules/@types'],
       'import/parsers': {
         '@typescript-eslint/parser': ['.ts', '.tsx'],
       },
@@ -64,8 +62,6 @@ const validTest = (name: string, only: boolean = false) => {
     name,
     only,
     settings: {
-      'import/extensions': ['.ts', '.tsx', '.js', '.jsx'],
-      'import/external-module-folders': ['node_modules', 'node_modules/@types'],
       'import/parsers': {
         '@typescript-eslint/parser': ['.ts', '.tsx'],
       },