feat: add unresolvedImports to export

Author: rainerhahnekamp

packages/core/src/lib/api/get-project-data.ts

@@ -6,10 +6,11 @@ import getFs from '../fs/getFs';
 
 export type ProjectDataEntry = {
   module: string;
-  moduleType: 'barrel' | 'barrel-less',
+  moduleType: 'barrel' | 'barrel-less';
   tags: string[];
   imports: string[];
   externalLibraries?: string[];
+  unresolvedImports: string[];
 };
 
 /**
@@ -143,12 +144,9 @@ export function getProjectData(
     const entry: ProjectDataEntry = {
       module: fileInfo.moduleInfo.path || '.',
       moduleType: fileInfo.moduleInfo.hasBarrel ? 'barrel' : 'barrel-less',
-      tags: calcOrGetTags(
-        fileInfo.moduleInfo.path,
-        projectInfo,
-        tagsCache,
-      ),
+      tags: calcOrGetTags(fileInfo.moduleInfo.path, projectInfo, tagsCache),
       imports: fileInfo.imports.map((fileInfo) => fileInfo.path),
+      unresolvedImports: fileInfo.unresolvableImports,
     };
 
     if (options.includeExternalLibraries) {
@@ -184,6 +182,7 @@ function relativizeIfRequired(
       imports: moduleData.imports.map((importPath) =>
         relative(toFsPath(importPath)),
       ),
+      unresolvedImports: moduleData.unresolvedImports,
     };
 
     if (options.includeExternalLibraries) {

packages/core/src/lib/checks/tests/encapsulation-barrel-less.spec.ts

@@ -178,7 +178,7 @@ describe('barrel-less', () => {
           'customers.component.ts': ['../data/open.service.ts'],
         },
         data: {
-          'index.ts': ['open.service.ts'],
+          'index.ts': ['./open.service.ts'],
           'open.service.ts': [],
           internal: { 'hidden.service.ts': [] },
         },
@@ -192,7 +192,7 @@ describe('barrel-less', () => {
     assertProject()
       .withCustomerRoute({
         feature: {
-          'customer.component.ts': [''],
+          'customer.component.ts': [],
           'customers.component.ts': ['../data/sub1/internal/hidden.service.ts'],
         },
         data: {

packages/core/src/lib/cli/tests/__snapshots__/export-data.spec.ts.snap

@@ -12,6 +12,7 @@ exports[`export data > should also work with a sheriff.config.ts > sheriff-confi
       "src/holidays/index.ts",
       "src/customers/index.ts"
     ],
+    "unresolvedImports": [],
     "externalLibraries": []
   },
   "src/holidays/index.ts": {
@@ -21,6 +22,7 @@ exports[`export data > should also work with a sheriff.config.ts > sheriff-confi
       "scope:holidays"
     ],
     "imports": [],
+    "unresolvedImports": [],
     "externalLibraries": []
   },
   "src/customers/index.ts": {
@@ -30,6 +32,7 @@ exports[`export data > should also work with a sheriff.config.ts > sheriff-confi
       "scope:customers"
     ],
     "imports": [],
+    "unresolvedImports": [],
     "externalLibraries": []
   }
 }"
@@ -47,6 +50,7 @@ exports[`export data > should avoid circular dependencies > circular-dependencie
       "src/app1.service.ts",
       "src/app2.service.ts"
     ],
+    "unresolvedImports": [],
     "externalLibraries": []
   },
   "src/app1.service.ts": {
@@ -58,6 +62,7 @@ exports[`export data > should avoid circular dependencies > circular-dependencie
     "imports": [
       "src/app2.service.ts"
     ],
+    "unresolvedImports": [],
     "externalLibraries": []
   },
   "src/app2.service.ts": {
@@ -69,6 +74,24 @@ exports[`export data > should avoid circular dependencies > circular-dependencie
     "imports": [
       "src/app1.service.ts"
     ],
+    "unresolvedImports": [],
+    "externalLibraries": []
+  }
+}"
+`;
+
+exports[`export data > should show unresolved imports > unresolved-imports 1`] = `
+"{
+  "src/main.ts": {
+    "module": ".",
+    "moduleType": "barrel-less",
+    "tags": [
+      "root"
+    ],
+    "imports": [],
+    "unresolvedImports": [
+      "my-module"
+    ],
     "externalLibraries": []
   }
 }"
@@ -85,6 +108,7 @@ exports[`export data > should skip not reachable files > not-reachable-files 1`]
     "imports": [
       "src/app1.service.ts"
     ],
+    "unresolvedImports": [],
     "externalLibraries": []
   },
   "src/app1.service.ts": {
@@ -94,6 +118,7 @@ exports[`export data > should skip not reachable files > not-reachable-files 1`]
       "root"
     ],
     "imports": [],
+    "unresolvedImports": [],
     "externalLibraries": []
   }
 }"
@@ -110,6 +135,7 @@ exports[`export data > should test a simple application > simple-application 1`]
     "imports": [
       "src/holidays/feature/index.ts"
     ],
+    "unresolvedImports": [],
     "externalLibraries": []
   },
   "src/holidays/feature/index.ts": {
@@ -122,6 +148,7 @@ exports[`export data > should test a simple application > simple-application 1`]
     "imports": [
       "src/holidays/feature/holidays-container.component.ts"
     ],
+    "unresolvedImports": [],
     "externalLibraries": []
   },
   "src/holidays/feature/holidays-container.component.ts": {
@@ -136,6 +163,7 @@ exports[`export data > should test a simple application > simple-application 1`]
       "src/holidays/ui/index.ts",
       "src/holidays/model/index.ts"
     ],
+    "unresolvedImports": [],
     "externalLibraries": [
       "@angular/common",
       "@angular/core",
@@ -152,6 +180,7 @@ exports[`export data > should test a simple application > simple-application 1`]
     "imports": [
       "src/holidays/data/holidays-store.ts"
     ],
+    "unresolvedImports": [],
     "externalLibraries": []
   },
   "src/holidays/data/holidays-store.ts": {
@@ -164,6 +193,7 @@ exports[`export data > should test a simple application > simple-application 1`]
     "imports": [
       "src/holidays/model/index.ts"
     ],
+    "unresolvedImports": [],
     "externalLibraries": [
       "@ngrx/signals"
     ]
@@ -178,6 +208,7 @@ exports[`export data > should test a simple application > simple-application 1`]
     "imports": [
       "src/holidays/model/holiday.ts"
     ],
+    "unresolvedImports": [],
     "externalLibraries": []
   },
   "src/holidays/model/holiday.ts": {
@@ -188,6 +219,7 @@ exports[`export data > should test a simple application > simple-application 1`]
       "type:model"
     ],
     "imports": [],
+    "unresolvedImports": [],
     "externalLibraries": []
   },
   "src/holidays/ui/index.ts": {
@@ -200,6 +232,7 @@ exports[`export data > should test a simple application > simple-application 1`]
     "imports": [
       "src/holidays/ui/holidays.component.ts"
     ],
+    "unresolvedImports": [],
     "externalLibraries": []
   },
   "src/holidays/ui/holidays.component.ts": {
@@ -212,6 +245,7 @@ exports[`export data > should test a simple application > simple-application 1`]
     "imports": [
       "src/holidays/model/index.ts"
     ],
+    "unresolvedImports": [],
     "externalLibraries": []
   }
 }"

packages/core/src/lib/cli/tests/export-data.spec.ts

@@ -116,4 +116,19 @@ describe('export data', () => {
 
     expect(allLogs()).toMatchSnapshot('sheriff-config');
   });
+
+  it('should show unresolved imports', () => {
+    const { allLogs } = mockCli();
+
+    createProject({
+      'tsconfig.json': tsConfig(),
+      src: {
+        'main.ts': ['my-module'],
+      },
+    });
+
+    exportData('src/main.ts');
+
+    expect(allLogs()).toMatchSnapshot('unresolved-imports');
+  });
 });

packages/core/src/lib/file-info/traverse-filesystem.ts

@@ -84,7 +84,7 @@ export function traverseFilesystem(
     // might be an undetected dependency in node_modules
     // or an incomplete import (= developer is still typing),
     // if we read from an unsaved file via ESLint.
-    else if (fileName.startsWith('.')) {
+    else {
       fileInfo.addUnresolvableImport(fileName);
     }
 

packages/core/src/lib/file-info/unassigned-file-info.ts

@@ -27,6 +27,10 @@ export class UnassignedFileInfo {
     this.#unresolvableImports.push(importCommand);
   }
 
+  get unresolvableImports() {
+    return [...this.#unresolvableImports];
+  }
+
   isUnresolvableImport(importCommand: string) {
     return this.#unresolvableImports.includes(importCommand);
   }

packages/core/src/lib/modules/file.info.ts

@@ -39,6 +39,10 @@ export class FileInfo {
     return this.unassignedFileInfo.getRawImportForImportedFileInfo(path);
   }
 
+  get unresolvableImports() {
+    return this.unassignedFileInfo.unresolvableImports;
+  }
+
   isUnresolvableImport(importCommand: string) {
     return this.unassignedFileInfo.isUnresolvableImport(importCommand);
   }