feat(core): export-data can now work against entryPoints

Author: michaelbe812

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

@@ -11,6 +11,7 @@ export type ProjectDataEntry = {
   imports: string[];
   externalLibraries?: string[];
   unresolvedImports: string[];
+  projectName: string;
 };
 
 /**
@@ -77,6 +78,7 @@ function calcOrGetTags(
  */
 export function getProjectData(
   entryFileAbsolute: string,
+  projectName: string,
   options?: Options,
 ): ProjectData;
 /**
@@ -112,28 +114,43 @@ export function getProjectData(
 export function getProjectData(
   entryFileRelative: string,
   cwd: string,
+  projectName: string,
   options?: Options,
 ): ProjectData;
 
 export function getProjectData(
   entryFile: string,
-  cwdOrOptions?: string | Options,
+  cwdOrProjectName: string,
+  projectNameOrOptions?: string | Options,
   optionalOptions?: Options,
 ): ProjectData {
   const fs = getFs();
-  const absoluteEntryFile =
-    cwdOrOptions === undefined
-      ? entryFile
-      : typeof cwdOrOptions === 'string'
-        ? fs.join(cwdOrOptions, entryFile)
-        : entryFile;
-
-  const cwd = typeof cwdOrOptions === 'string' ? cwdOrOptions : undefined;
-  const options = optionalOptions
-    ? optionalOptions
-    : typeof cwdOrOptions === 'object'
-      ? cwdOrOptions
-      : {};
+  let absoluteEntryFile: string;
+  let cwd: string | undefined;
+  let projectName: string;
+  let options: Options;
+
+  if (
+    typeof cwdOrProjectName === 'string' &&
+    typeof projectNameOrOptions === 'string'
+  ) {
+    // Called with: (entryFile, cwd, projectName, options?)
+    absoluteEntryFile = fs.join(entryFile);
+    cwd = cwdOrProjectName;
+    projectName = projectNameOrOptions;
+    options = optionalOptions || {};
+  } else if (
+    typeof cwdOrProjectName === 'string' &&
+    typeof projectNameOrOptions === 'object'
+  ) {
+    // Called with: (entryFile, projectName, options)
+    absoluteEntryFile = entryFile;
+    cwd = undefined;
+    projectName = cwdOrProjectName;
+    options = projectNameOrOptions || {};
+  } else {
+    throw new Error('Invalid arguments to getProjectData');
+  }
 
   const projectInfo = init(toFsPath(absoluteEntryFile));
 
@@ -147,6 +164,7 @@ export function getProjectData(
       tags: calcOrGetTags(fileInfo.moduleInfo.path, projectInfo, tagsCache),
       imports: fileInfo.imports.map((fileInfo) => fileInfo.path),
       unresolvedImports: fileInfo.unresolvableImports,
+      projectName: projectName,
     };
 
     if (options.includeExternalLibraries) {
@@ -183,6 +201,7 @@ function relativizeIfRequired(
         relative(toFsPath(importPath)),
       ),
       unresolvedImports: moduleData.unresolvedImports,
+      projectName: moduleData.projectName,
     };
 
     if (options.includeExternalLibraries) {

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

@@ -5,12 +5,17 @@ import getFs from '../fs/getFs';
 
 export function exportData(...args: string[]): void {
   const fs = getFs();
-  const projectEntries = getEntriesFromCliOrConfig(args[0], false);
+  const projectEntries = getEntriesFromCliOrConfig(args[0], true);
 
   for (const entry of projectEntries) {
-    const data = getProjectData(entry.entry, fs.cwd(), {
-      includeExternalLibraries: true,
-    });
+    const data = getProjectData(
+      entry.entry.fileInfo.path,
+      fs.cwd(),
+      entry.projectName,
+      {
+        includeExternalLibraries: true,
+      },
+    );
     cli.log(JSON.stringify(data, null, '  '));
   }
 }

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

@@ -1,5 +1,50 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
+exports[`export data > Multi project setup > should test a simple multi-project workspace with multiple entryPoints > multi-project-multiple-entrypoint 1`] = `
+"{
+  "projects/project-i/src/main.ts": {
+    "module": ".",
+    "moduleType": "barrel-less",
+    "tags": [
+      "root"
+    ],
+    "imports": [],
+    "unresolvedImports": [],
+    "projectName": "project-i",
+    "externalLibraries": []
+  }
+}
+{
+  "projects/project-ii/src/main.ts": {
+    "module": ".",
+    "moduleType": "barrel-less",
+    "tags": [
+      "root"
+    ],
+    "imports": [],
+    "unresolvedImports": [],
+    "projectName": "project-ii",
+    "externalLibraries": []
+  }
+}"
+`;
+
+exports[`export data > Multi project setup > should test a simple multi-project workspace with single entryPoint > multi-project-single-entrypoint 1`] = `
+"{
+  "projects/project-i/src/main.ts": {
+    "module": ".",
+    "moduleType": "barrel-less",
+    "tags": [
+      "root"
+    ],
+    "imports": [],
+    "unresolvedImports": [],
+    "projectName": "project-i",
+    "externalLibraries": []
+  }
+}"
+`;
+
 exports[`export data > should also work with a sheriff.config.ts > sheriff-config 1`] = `
 "{
   "src/main.ts": {
@@ -13,6 +58,7 @@ exports[`export data > should also work with a sheriff.config.ts > sheriff-confi
       "src/customers/index.ts"
     ],
     "unresolvedImports": [],
+    "projectName": "default",
     "externalLibraries": []
   },
   "src/holidays/index.ts": {
@@ -23,6 +69,7 @@ exports[`export data > should also work with a sheriff.config.ts > sheriff-confi
     ],
     "imports": [],
     "unresolvedImports": [],
+    "projectName": "default",
     "externalLibraries": []
   },
   "src/customers/index.ts": {
@@ -33,6 +80,7 @@ exports[`export data > should also work with a sheriff.config.ts > sheriff-confi
     ],
     "imports": [],
     "unresolvedImports": [],
+    "projectName": "default",
     "externalLibraries": []
   }
 }"
@@ -51,6 +99,7 @@ exports[`export data > should avoid circular dependencies > circular-dependencie
       "src/app2.service.ts"
     ],
     "unresolvedImports": [],
+    "projectName": "default",
     "externalLibraries": []
   },
   "src/app1.service.ts": {
@@ -63,6 +112,7 @@ exports[`export data > should avoid circular dependencies > circular-dependencie
       "src/app2.service.ts"
     ],
     "unresolvedImports": [],
+    "projectName": "default",
     "externalLibraries": []
   },
   "src/app2.service.ts": {
@@ -75,6 +125,7 @@ exports[`export data > should avoid circular dependencies > circular-dependencie
       "src/app1.service.ts"
     ],
     "unresolvedImports": [],
+    "projectName": "default",
     "externalLibraries": []
   }
 }"
@@ -92,6 +143,7 @@ exports[`export data > should show unresolved imports > unresolved-imports 1`] =
     "unresolvedImports": [
       "my-module"
     ],
+    "projectName": "default",
     "externalLibraries": []
   }
 }"
@@ -109,6 +161,7 @@ exports[`export data > should skip not reachable files > not-reachable-files 1`]
       "src/app1.service.ts"
     ],
     "unresolvedImports": [],
+    "projectName": "default",
     "externalLibraries": []
   },
   "src/app1.service.ts": {
@@ -119,6 +172,7 @@ exports[`export data > should skip not reachable files > not-reachable-files 1`]
     ],
     "imports": [],
     "unresolvedImports": [],
+    "projectName": "default",
     "externalLibraries": []
   }
 }"
@@ -136,6 +190,7 @@ exports[`export data > should test a simple application > simple-application 1`]
       "src/holidays/feature/index.ts"
     ],
     "unresolvedImports": [],
+    "projectName": "default",
     "externalLibraries": []
   },
   "src/holidays/feature/index.ts": {
@@ -149,6 +204,7 @@ exports[`export data > should test a simple application > simple-application 1`]
       "src/holidays/feature/holidays-container.component.ts"
     ],
     "unresolvedImports": [],
+    "projectName": "default",
     "externalLibraries": []
   },
   "src/holidays/feature/holidays-container.component.ts": {
@@ -164,6 +220,7 @@ exports[`export data > should test a simple application > simple-application 1`]
       "src/holidays/model/index.ts"
     ],
     "unresolvedImports": [],
+    "projectName": "default",
     "externalLibraries": [
       "@angular/common",
       "@angular/core",
@@ -181,6 +238,7 @@ exports[`export data > should test a simple application > simple-application 1`]
       "src/holidays/data/holidays-store.ts"
     ],
     "unresolvedImports": [],
+    "projectName": "default",
     "externalLibraries": []
   },
   "src/holidays/data/holidays-store.ts": {
@@ -194,6 +252,7 @@ exports[`export data > should test a simple application > simple-application 1`]
       "src/holidays/model/index.ts"
     ],
     "unresolvedImports": [],
+    "projectName": "default",
     "externalLibraries": [
       "@ngrx/signals"
     ]
@@ -209,6 +268,7 @@ exports[`export data > should test a simple application > simple-application 1`]
       "src/holidays/model/holiday.ts"
     ],
     "unresolvedImports": [],
+    "projectName": "default",
     "externalLibraries": []
   },
   "src/holidays/model/holiday.ts": {
@@ -220,6 +280,7 @@ exports[`export data > should test a simple application > simple-application 1`]
     ],
     "imports": [],
     "unresolvedImports": [],
+    "projectName": "default",
     "externalLibraries": []
   },
   "src/holidays/ui/index.ts": {
@@ -233,6 +294,7 @@ exports[`export data > should test a simple application > simple-application 1`]
       "src/holidays/ui/holidays.component.ts"
     ],
     "unresolvedImports": [],
+    "projectName": "default",
     "externalLibraries": []
   },
   "src/holidays/ui/holidays.component.ts": {
@@ -246,6 +308,7 @@ exports[`export data > should test a simple application > simple-application 1`]
       "src/holidays/model/index.ts"
     ],
     "unresolvedImports": [],
+    "projectName": "default",
     "externalLibraries": []
   }
 }"

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

@@ -7,7 +7,7 @@ import { exportData } from '../export-data';
 import { verifyCliWrappers } from './verify-cli-wrapper';
 
 describe('export data', () => {
-  verifyCliWrappers('export', 'src/main.ts', false);
+  verifyCliWrappers('export', 'src/main.ts', true);
 
   it('should test a simple application', () => {
     const { allLogs } = mockCli();
@@ -131,4 +131,70 @@ describe('export data', () => {
 
     expect(allLogs()).toMatchSnapshot('unresolved-imports');
   });
+
+  describe('Multi project setup', () => {
+    it('should test a simple multi-project workspace with single entryPoint', () => {
+      const { allLogs } = mockCli();
+      createProject({
+        'tsconfig.json': tsConfig(),
+        'sheriff.config.ts': sheriffConfig({
+          depRules: {},
+          entryPoints: {
+            'project-i': 'projects/project-i/src/main.ts',
+            'project-ii': 'projects/project-ii/src/main.ts',
+          },
+        }),
+        projects: {
+          'project-i': {
+            src: {
+              'main.ts': [],
+              'app.ts': [],
+            },
+          },
+          'project-ii': {
+            src: {
+              'main.ts': [],
+              'app.ts': [],
+            },
+          },
+        },
+      });
+
+      exportData('project-i');
+
+      expect(allLogs()).toMatchSnapshot('multi-project-single-entrypoint');
+    });
+
+    it('should test a simple multi-project workspace with multiple entryPoints', () => {
+      const { allLogs } = mockCli();
+      createProject({
+        'tsconfig.json': tsConfig(),
+        'sheriff.config.ts': sheriffConfig({
+          depRules: {},
+          entryPoints: {
+            'project-i': 'projects/project-i/src/main.ts',
+            'project-ii': 'projects/project-ii/src/main.ts',
+          },
+        }),
+        projects: {
+          'project-i': {
+            src: {
+              'main.ts': [],
+              'app.ts': [],
+            },
+          },
+          'project-ii': {
+            src: {
+              'main.ts': [],
+              'app.ts': [],
+            },
+          },
+        },
+      });
+
+      exportData('project-i,project-ii');
+
+      expect(allLogs()).toMatchSnapshot('multi-project-multiple-entrypoint');
+    });
+  });
 });