feat(eslint-plugin): include re-exports

softarc-consulting · Oct 2, 2024 · 447b94b · 447b94b
1 parent a418b7d
commit 447b94b
Show file tree

Hide file tree

Showing 7 changed files with 68 additions and 27 deletions.
diff --git a/packages/core/src/lib/file-info/tests/traverse-filesystem.spec.ts b/packages/core/src/lib/file-info/tests/traverse-filesystem.spec.ts
@@ -11,6 +11,7 @@ import {
 } from '../traverse-filesystem';
 import { describe, it, expect } from 'vitest';
 import { buildFileInfo } from '../../test/build-file-info';
+import getFs from '../../fs/getFs';
 
 function setup(fileTree: FileTree): UnassignedFileInfo {
   createProject(fileTree);
@@ -211,7 +212,7 @@ describe('traverse filesystem', () => {
 
   it('should return undefined if TS resolving does not work', () => {
     const resolveFn: ResolveFn = () => ({
-      resolvedModule: undefined
+      resolvedModule: undefined,
     });
 
     expect(
@@ -360,4 +361,30 @@ describe('traverse filesystem', () => {
       expect(fileInfo).toEqual(buildFileInfo('/project/src/main.ts', []));
     });
   });
+
+  it('should recognize exports as imports', () => {
+    createProject({
+      'tsconfig.json': tsConfig(),
+      src: {
+        app: {
+          'app.component.ts': [],
+          customers: {
+            'customer.component.ts': [],
+          },
+        },
+      },
+    });
+
+    getFs().writeFile(
+      '/project/src/app/app.component.ts',
+      `export * from './customers/customer.component'`,
+    );
+
+    const tsData = generateTsData(toFsPath('/project/tsconfig.json'));
+    const mainPath = toFsPath('/project/src/app/app.component.ts');
+
+    const unassignedFileInfo = traverseFilesystem(mainPath, new Map<FsPath, UnassignedFileInfo>(), tsData);
+
+    expect(unassignedFileInfo.imports).toHaveLength(1)
+  });
 });
diff --git a/packages/core/src/lib/file-info/unassigned-file-info.ts b/packages/core/src/lib/file-info/unassigned-file-info.ts
@@ -2,7 +2,11 @@ import { FsPath } from './fs-path';
 import throwIfNull from '../util/throw-if-null';
 
 /**
- * Represents a TypeScript file with its dependencies.
+ * Represents a TypeScript file with its dependencies but does
+ * not yet have an assignment to a module.
+ *
+ * After module assignment is done, it becomes a type `FileInfo`.
+ *
  * If an import cannot be resolved, it doesn't throw an error
  * but is added to unresolvableImports.
  *

diff --git a/packages/eslint-plugin/src/lib/rules/create-rule.ts b/packages/eslint-plugin/src/lib/rules/create-rule.ts
@@ -1,6 +1,5 @@
 import { Rule } from 'eslint';
-import { ImportDeclaration, ImportExpression } from 'estree';
-import { Executor } from './executor';
+import {Executor, ExecutorNode} from './executor';
 import { UserError } from '@softarc/sheriff-core';
 
 /**
@@ -22,13 +21,19 @@ export const createRule: (
     let isFirstRun = true;
     let hasInternalError = false;
     const executeRuleWithContext = (
-      node: ImportExpression | ImportDeclaration,
+      node: ExecutorNode,
     ) => {
       const filename = context.filename ?? context.getFilename();
       const sourceCode =
         context.sourceCode?.text ?? context.getSourceCode().text;
+
       if (!hasInternalError) {
         try {
+          // don't process special export `export const value = {n: 1};`
+          if (!node.source) {
+            return;
+          }
+
           executor(context, node, isFirstRun, filename, sourceCode);
         } catch (error) {
           hasInternalError = true;
@@ -50,6 +55,8 @@ export const createRule: (
     return {
       ImportExpression: executeRuleWithContext,
       ImportDeclaration: executeRuleWithContext,
+      ExportAllDeclaration: executeRuleWithContext,
+      ExportNamedDeclaration: executeRuleWithContext,
     };
   },
 });
diff --git a/packages/eslint-plugin/src/lib/rules/deep-import.ts b/packages/eslint-plugin/src/lib/rules/deep-import.ts
@@ -1,18 +1,9 @@
-import { Rule } from 'eslint';
 import { hasDeepImport } from '@softarc/sheriff-core';
-import { ImportDeclaration, ImportExpression } from 'estree';
 import { createRule } from './create-rule';
 
 export const deepImport = createRule(
   'Deep Import',
-  (
-    context: Rule.RuleContext,
-    node: ImportExpression | ImportDeclaration,
-    isFirstRun: boolean,
-    filename: string,
-    sourceCode: string,
-  ) => {
-    // ESTree does not have source on `ImportExpression`.
+  (context, node, isFirstRun, filename, sourceCode) => {
     const importValue = (node.source as { value: string }).value;
     const message = hasDeepImport(
       filename,

diff --git a/packages/eslint-plugin/src/lib/rules/dependency-rule.ts b/packages/eslint-plugin/src/lib/rules/dependency-rule.ts
@@ -1,17 +1,9 @@
-import { Rule } from 'eslint';
 import { violatesDependencyRule } from '@softarc/sheriff-core';
-import { ImportDeclaration, ImportExpression } from 'estree';
 import { createRule } from './create-rule';
 
 export const dependencyRule = createRule(
   'Dependency Rule',
-  (
-    context: Rule.RuleContext,
-    node: ImportExpression | ImportDeclaration,
-    isFirstRun: boolean,
-    filename: string,
-    sourceCode: string,
-  ) => {
+  (context, node, isFirstRun, filename, sourceCode) => {
     const importValue = (node.source as { value: string }).value;
     const message = violatesDependencyRule(
       filename,

diff --git a/packages/eslint-plugin/src/lib/rules/executor.ts b/packages/eslint-plugin/src/lib/rules/executor.ts
@@ -1,9 +1,11 @@
 import { Rule } from 'eslint';
-import { ImportDeclaration, ImportExpression } from 'estree';
+import {ExportAllDeclaration, ExportNamedDeclaration, ImportDeclaration, ImportExpression} from 'estree';
+
+export type ExecutorNode = ImportExpression | ImportDeclaration | ExportNamedDeclaration | ExportAllDeclaration;
 
 export type Executor = (
   context: Rule.RuleContext,
-  node: ImportExpression | ImportDeclaration,
+  node: ExecutorNode,
   isFirstRun: boolean,
   filename: string,
   sourceCode: string,

diff --git a/packages/eslint-plugin/src/lib/rules/tests/create-rule.spec.ts b/packages/eslint-plugin/src/lib/rules/tests/create-rule.spec.ts
@@ -5,7 +5,7 @@ import { UserError } from '@softarc/sheriff-core';
 import { parser } from 'typescript-eslint';
 
 const tester = new RuleTester({
-  languageOptions: { parser, sourceType: 'module' }
+  languageOptions: { parser, sourceType: 'module' },
 });
 
 const ruleExecutor = { foo: () => void true };
@@ -71,4 +71,22 @@ describe('create rule', () => {
       expect(spy).toHaveBeenCalledTimes(1);
     });
   }
+
+  it('should also match export declarations', () => {
+    tester.run('test-rule', testRule, {
+      valid: [
+        {
+          code: `
+            export * from '../index';
+            export { Component } from './component';
+            export const value = {n: 1};
+            export default {a: 1};
+          `,
+        },
+      ],
+      invalid: []
+    });
+
+    expect(spy).toHaveBeenCalledTimes(2);
+  });
 });