cleanup(core): move mapProjectGraphFiles to target project locator

nrwl · Nov 18, 2022 · 8de2449 · 8de2449
1 parent 8856865
commit 8de2449
Show file tree

Hide file tree

Showing 10 changed files with 60 additions and 98 deletions.
diff --git a/docs/generated/devkit/index.md b/docs/generated/devkit/index.md
@@ -104,7 +104,6 @@ It only uses language primitives and immutable objects
 ### Utils Type aliases
 
 - [AdditionalSharedConfig](../../devkit/index#additionalsharedconfig)
-- [MappedProjectGraph](../../devkit/index#mappedprojectgraph)
 - [ModuleFederationLibrary](../../devkit/index#modulefederationlibrary)
 - [Remotes](../../devkit/index#remotes)
 - [SharedFunction](../../devkit/index#sharedfunction)
@@ -162,7 +161,6 @@ It only uses language primitives and immutable objects
 - [installPackagesTask](../../devkit/index#installpackagestask)
 - [isStandaloneProject](../../devkit/index#isstandaloneproject)
 - [joinPathFragments](../../devkit/index#joinpathfragments)
-- [mapProjectGraphFiles](../../devkit/index#mapprojectgraphfiles)
 - [mapRemotes](../../devkit/index#mapremotes)
 - [mapRemotesForSSR](../../devkit/index#mapremotesforssr)
 - [moveFilesToNewDirectory](../../devkit/index#movefilestonewdirectory)
@@ -560,18 +558,6 @@ A plugin for Nx
 
 ---
 
-### MappedProjectGraph
-
-Ƭ **MappedProjectGraph**<`T`\>: [`ProjectGraph`](../../devkit/index#projectgraph)<`T`\> & { `allFiles`: `Record`<`string`, `string`\> }
-
-#### Type parameters
-
-| Name | Type  |
-| :--- | :---- |
-| `T`  | `any` |
-
----
-
 ### ModuleFederationLibrary
 
 Ƭ **ModuleFederationLibrary**: `Object`
@@ -1489,31 +1475,6 @@ Normalized path fragments and joins them
 
 ---
 
-### mapProjectGraphFiles
-
-▸ **mapProjectGraphFiles**<`T`\>(`projectGraph`): [`MappedProjectGraph`](../../devkit/index#mappedprojectgraph) \| `null`
-
-Maps the project graph to a format that makes it easier to find the project
-based on the file path.
-
-#### Type parameters
-
-| Name |
-| :--- |
-| `T`  |
-
-#### Parameters
-
-| Name           | Type                                                    |
-| :------------- | :------------------------------------------------------ |
-| `projectGraph` | [`ProjectGraph`](../../devkit/index#projectgraph)<`T`\> |
-
-#### Returns
-
-[`MappedProjectGraph`](../../devkit/index#mappedprojectgraph) \| `null`
-
----
-
 ### mapRemotes
 
 ▸ **mapRemotes**(`remotes`, `remoteEntryExt`, `determineRemoteUrl`): `Record`<`string`, `string`\>

diff --git a/docs/generated/packages/devkit.json b/docs/generated/packages/devkit.json
diff --git a/packages/angular/plugins/component-testing.ts b/packages/angular/plugins/component-testing.ts
@@ -12,7 +12,6 @@ import {
   ExecutorContext,
   joinPathFragments,
   logger,
-  mapProjectGraphFiles,
   offsetFromRoot,
   parseTargetString,
   ProjectConfiguration,
@@ -22,6 +21,7 @@ import {
   stripIndents,
   workspaceRoot,
 } from '@nrwl/devkit';
+import { mapProjectGraphFiles } from 'nx/src/utils/target-project-locator';
 import { lstatSync, mkdirSync, writeFileSync } from 'fs';
 import { dirname, join, relative } from 'path';
 import type { BrowserBuilderSchema } from '../src/builders/webpack-browser/webpack-browser.impl';

diff --git a/packages/cypress/plugins/cypress-preset.ts b/packages/cypress/plugins/cypress-preset.ts
@@ -1,6 +1,5 @@
 import {
   ExecutorContext,
-  mapProjectGraphFiles,
   normalizePath,
   ProjectConfiguration,
   ProjectGraph,
@@ -10,6 +9,7 @@ import {
   workspaceRoot,
 } from '@nrwl/devkit';
 import { readProjectsConfigurationFromProjectGraph } from 'nx/src/project-graph/project-graph';
+import { mapProjectGraphFiles } from 'nx/src/utils/target-project-locator';
 import { dirname, extname, join, relative } from 'path';
 import { lstatSync } from 'fs';
 

diff --git a/packages/devkit/index.ts b/packages/devkit/index.ts
@@ -360,11 +360,3 @@ export { Hash, Hasher } from 'nx/src/hasher/hasher';
  * @category Utils
  */
 export { cacheDir } from 'nx/src/utils/cache-directory';
-
-/**
- * @category Utils
- */
-export {
-  MappedProjectGraph,
-  mapProjectGraphFiles,
-} from './src/utils/mapped-graph';
diff --git a/packages/devkit/src/utils/mapped-graph.ts b/packages/devkit/src/utils/mapped-graph.ts
diff --git a/packages/eslint-plugin-nx/src/rules/enforce-module-boundaries.spec.ts b/packages/eslint-plugin-nx/src/rules/enforce-module-boundaries.spec.ts
@@ -1,9 +1,12 @@
 import type { FileData, ProjectGraph } from '@nrwl/devkit';
-import { DependencyType, mapProjectGraphFiles } from '@nrwl/devkit';
+import { DependencyType } from '@nrwl/devkit';
 import * as parser from '@typescript-eslint/parser';
 import { TSESLint } from '@typescript-eslint/utils';
 import { vol } from 'memfs';
-import { TargetProjectLocator } from 'nx/src/utils/target-project-locator';
+import {
+  TargetProjectLocator,
+  mapProjectGraphFiles,
+} from 'nx/src/utils/target-project-locator';
 import enforceModuleBoundaries, {
   RULE_NAME as enforceModuleBoundariesRuleName,
 } from './enforce-module-boundaries';

diff --git a/packages/eslint-plugin-nx/src/utils/project-graph-utils.ts b/packages/eslint-plugin-nx/src/utils/project-graph-utils.ts
@@ -1,9 +1,8 @@
+import { readCachedProjectGraph, readNxJson } from '@nrwl/devkit';
 import {
-  readCachedProjectGraph,
-  readNxJson,
-  MappedProjectGraph,
   mapProjectGraphFiles,
-} from '@nrwl/devkit';
+  MappedProjectGraph,
+} from 'nx/src/utils/target-project-locator';
 import { isTerminalRun } from './runtime-lint-utils';
 import * as chalk from 'chalk';
 

diff --git a/packages/eslint-plugin-nx/src/utils/runtime-lint-utils.ts b/packages/eslint-plugin-nx/src/utils/runtime-lint-utils.ts
@@ -14,11 +14,11 @@ import { join } from 'path';
 import { getPath, pathExists } from './graph-utils';
 import { existsSync } from 'fs';
 import { readFileIfExisting } from 'nx/src/project-graph/file-utils';
-import { TargetProjectLocator } from 'nx/src/utils/target-project-locator';
 import {
+  TargetProjectLocator,
   MappedProjectGraph,
   removeExt,
-} from '@nrwl/devkit/src/utils/mapped-graph';
+} from 'nx/src/utils/target-project-locator';
 
 export type Deps = { [projectName: string]: ProjectGraphDependency[] };
 export type DepConstraint = {

diff --git a/packages/nx/src/utils/target-project-locator.ts b/packages/nx/src/utils/target-project-locator.ts
@@ -3,6 +3,7 @@ import { isRelativePath, readJsonFile } from './fileutils';
 import { dirname, join, posix } from 'path';
 import { workspaceRoot } from './workspace-root';
 import {
+  ProjectGraph,
   ProjectGraphExternalNode,
   ProjectGraphProjectNode,
 } from '../config/project-graph';
@@ -198,6 +199,11 @@ function filterRootExternalDependencies(
   return nodes;
 }
 
+/**
+ * Mapps the project root paths to the project name
+ * @param nodes
+ * @returns
+ */
 export function createProjectRootMappings(
   nodes: Record<string, ProjectGraphProjectNode>
 ) {
@@ -212,6 +218,47 @@ export function createProjectRootMappings(
   return projectRootMappings;
 }
 
+export type MappedProjectGraph<T = any> = ProjectGraph<T> & {
+  allFiles: Record<string, string>;
+};
+
+/**
+ * Strips the file extension from the file path
+ * @param file
+ * @returns
+ */
+export function removeExt(file: string): string {
+  return file.replace(/(?<!(^|\/))\.[^/.]+$/, '');
+}
+
+/**
+ * Maps the project graph to a format that makes it easier to find the project
+ * based on the file path.
+ * @param projectGraph
+ * @returns
+ */
+export function mapProjectGraphFiles<T>(
+  projectGraph: ProjectGraph<T>
+): MappedProjectGraph | null {
+  if (!projectGraph) {
+    return null;
+  }
+  const allFiles: Record<string, string> = {};
+  Object.entries(
+    projectGraph.nodes as Record<string, ProjectGraphProjectNode>
+  ).forEach(([name, node]) => {
+    node.data.files.forEach(({ file }) => {
+      const fileName = removeExt(file);
+      allFiles[fileName] = name;
+    });
+  });
+
+  return {
+    ...projectGraph,
+    allFiles,
+  };
+}
+
 /**
  * Locates a project in projectRootMap based on a file within it
  * @param filePath path that is inside of projectName