refactor(utils): extract shared Nx project graph utilities

Author: hanna-skryl

packages/plugin-coverage/src/lib/nx/coverage-paths.ts

@@ -12,29 +12,11 @@ import {
   logger,
   pluralize,
   pluralizeToken,
-  stringifyError,
+  resolveCachedProjectGraph,
 } from '@code-pushup/utils';
 import type { CoverageResult } from '../config.js';
 import { formatMetaLog } from '../format.js';
 
-/**
- * Resolves the cached project graph for the current Nx workspace.
- * First tries to read cache and if not possible, go for the async creation.
- */
-async function resolveCachedProjectGraph() {
-  const { readCachedProjectGraph, createProjectGraphAsync } = await import(
-    '@nx/devkit'
-  );
-  try {
-    return readCachedProjectGraph();
-  } catch (error) {
-    logger.warn(
-      `Could not read cached project graph, falling back to async creation - ${stringifyError(error)}`,
-    );
-    return await createProjectGraphAsync({ exitOnError: false });
-  }
-}
-
 /**
  * @param targets nx targets to be used for measuring coverage, test by default
  * @returns An array of coverage result information for the coverage plugin.

packages/plugin-eslint/src/lib/nx/find-all-projects.ts

@@ -1,27 +1,13 @@
-import { logger, pluralizeToken, stringifyError } from '@code-pushup/utils';
+import {
+  logger,
+  pluralizeToken,
+  resolveCachedProjectGraph,
+} from '@code-pushup/utils';
 import type { ESLintTarget } from '../config.js';
 import { formatMetaLog } from '../meta/format.js';
 import { filterProjectGraph } from './filter-project-graph.js';
 import { nxProjectsToConfig } from './projects-to-config.js';
 
-/**
- * Resolves the cached project graph for the current Nx workspace.
- * First tries to read cache and if not possible, go for the async creation.
- */
-async function resolveCachedProjectGraph() {
-  const { readCachedProjectGraph, createProjectGraphAsync } = await import(
-    '@nx/devkit'
-  );
-  try {
-    return readCachedProjectGraph();
-  } catch (error) {
-    logger.warn(
-      `Could not read cached project graph, falling back to async creation.\n${stringifyError(error)}`,
-    );
-    return await createProjectGraphAsync({ exitOnError: false });
-  }
-}
-
 /**
  * Finds all Nx projects in workspace and converts their lint configurations to Code PushUp ESLint plugin parameters.
  *

packages/plugin-eslint/src/lib/nx/find-project-with-deps.ts

@@ -1,4 +1,4 @@
-import { logger, pluralizeToken } from '@code-pushup/utils';
+import { createProjectGraph, logger, pluralizeToken } from '@code-pushup/utils';
 import type { ESLintTarget } from '../config.js';
 import { formatMetaLog } from '../meta/format.js';
 import { nxProjectsToConfig } from './projects-to-config.js';
@@ -32,8 +32,7 @@ import { findAllDependencies } from './traverse-graph.js';
 export async function eslintConfigFromNxProjectAndDeps(
   projectName: string,
 ): Promise<ESLintTarget[]> {
-  const { createProjectGraphAsync } = await import('@nx/devkit');
-  const projectGraph = await createProjectGraphAsync({ exitOnError: false });
+  const projectGraph = await createProjectGraph();
 
   const dependencies = findAllDependencies(projectName, projectGraph);
 

packages/plugin-eslint/src/lib/nx/find-project-without-deps.ts

@@ -1,4 +1,4 @@
-import { logger } from '@code-pushup/utils';
+import { createProjectGraph, logger } from '@code-pushup/utils';
 import type { ESLintTarget } from '../config.js';
 import { formatMetaLog } from '../meta/format.js';
 import { nxProjectsToConfig } from './projects-to-config.js';
@@ -31,8 +31,7 @@ import { nxProjectsToConfig } from './projects-to-config.js';
 export async function eslintConfigFromNxProject(
   projectName: string,
 ): Promise<ESLintTarget> {
-  const { createProjectGraphAsync } = await import('@nx/devkit');
-  const projectGraph = await createProjectGraphAsync({ exitOnError: false });
+  const projectGraph = await createProjectGraph();
 
   const [project] = await nxProjectsToConfig(
     projectGraph,

packages/plugin-typescript/src/lib/nx/tsconfig-paths.ts

@@ -2,7 +2,11 @@ import type { ProjectConfiguration } from '@nx/devkit';
 import { readdir } from 'node:fs/promises';
 import path from 'node:path';
 import { readConfigFile, sys } from 'typescript';
-import { logger, pluralizeToken, stringifyError } from '@code-pushup/utils';
+import {
+  logger,
+  pluralizeToken,
+  resolveCachedProjectGraph,
+} from '@code-pushup/utils';
 import { formatMetaLog } from '../format.js';
 
 /**
@@ -35,24 +39,6 @@ function hasFilesToCompile(tsconfigPath: string): boolean {
   return !(filesEmpty && includeEmpty);
 }
 
-/**
- * Resolves the cached project graph for the current Nx workspace.
- * Tries to read from cache first, falls back to async creation.
- */
-async function resolveCachedProjectGraph() {
-  const { readCachedProjectGraph, createProjectGraphAsync } = await import(
-    '@nx/devkit'
-  );
-  try {
-    return readCachedProjectGraph();
-  } catch (error) {
-    logger.warn(
-      `Could not read cached project graph, falling back to async creation.\n${stringifyError(error)}`,
-    );
-    return await createProjectGraphAsync({ exitOnError: false });
-  }
-}
-
 function isProjectIncluded(
   project: ProjectConfiguration,
   exclude?: string[],

packages/utils/package.json

@@ -39,6 +39,14 @@
     "wrap-ansi": "^9.0.2",
     "zod": "^4.2.1"
   },
+  "peerDependencies": {
+    "@nx/devkit": ">=17.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@nx/devkit": {
+      "optional": true
+    }
+  },
   "files": [
     "src",
     "!**/*.tsbuildinfo"

packages/utils/src/index.ts

@@ -94,6 +94,7 @@ export {
 export { interpolate } from './lib/interpolate.js';
 export { Logger, logger } from './lib/logger.js';
 export { mergeConfigs } from './lib/merge-configs.js';
+export { createProjectGraph, resolveCachedProjectGraph } from './lib/nx.js';
 export {
   addIndex,
   expandAuditsForUrls,

packages/utils/src/lib/nx.ts

@@ -0,0 +1,27 @@
+import type { ProjectGraph } from '@nx/devkit';
+import { stringifyError } from './errors.js';
+import { logger } from './logger.js';
+
+/**
+ * Creates the project graph for the current Nx workspace.
+ */
+export async function createProjectGraph(): Promise<ProjectGraph> {
+  const { createProjectGraphAsync } = await import('@nx/devkit');
+  return createProjectGraphAsync({ exitOnError: false });
+}
+
+/**
+ * Resolves the cached project graph for the current Nx workspace.
+ * Tries to read from cache first, falls back to async creation.
+ */
+export async function resolveCachedProjectGraph(): Promise<ProjectGraph> {
+  const { readCachedProjectGraph } = await import('@nx/devkit');
+  try {
+    return readCachedProjectGraph();
+  } catch (error) {
+    logger.warn(
+      `Could not read cached project graph, falling back to async creation.\n${stringifyError(error)}`,
+    );
+    return createProjectGraph();
+  }
+}