refactor: extract monorepo utils to shared pkg

hanna-skryl · hanna-skryl · commit a04d8fa2bb48 · 2026-03-06T17:42:40.000-05:00
diff --git a/packages/ci/package.json b/packages/ci/package.json
@@ -32,7 +32,6 @@
     "ansis": "^3.3.2",
     "glob": "^11.0.1",
     "simple-git": "^3.20.0",
-    "yaml": "^2.5.1",
     "zod": "^4.2.1"
   },
   "files": [
diff --git a/packages/ci/src/index.ts b/packages/ci/src/index.ts
@@ -1,10 +1,5 @@
 export type { SourceFileIssue } from './lib/issues.js';
 export type * from './lib/models.js';
-export {
-  isMonorepoTool,
-  MONOREPO_TOOLS,
-  type MonorepoTool,
-} from './lib/monorepo/index.js';
 export { runInCI } from './lib/run.js';
 export { configPatternsSchema } from './lib/schemas.js';
 export {
diff --git a/packages/ci/src/lib/models.ts b/packages/ci/src/lib/models.ts
@@ -1,6 +1,6 @@
 import type { Format, PersistConfig, UploadConfig } from '@code-pushup/models';
+import type { MonorepoTool } from '@code-pushup/utils';
 import type { SourceFileIssue } from './issues.js';
-import type { MonorepoTool } from './monorepo/index.js';
 
 /**
  * Customization options for {@link runInCI}
diff --git a/packages/ci/src/lib/monorepo/detect-tool.ts b/packages/ci/src/lib/monorepo/detect-tool.ts
diff --git a/packages/ci/src/lib/monorepo/handlers/index.ts b/packages/ci/src/lib/monorepo/handlers/index.ts
@@ -1,4 +1,5 @@
-import type { MonorepoTool, MonorepoToolHandler } from '../tools.js';
+import type { MonorepoTool } from '@code-pushup/utils';
+import type { MonorepoToolHandler } from '../tools.js';
 import { npmHandler } from './npm.js';
 import { nxHandler } from './nx.js';
 import { pnpmHandler } from './pnpm.js';
diff --git a/packages/ci/src/lib/monorepo/handlers/npm.ts b/packages/ci/src/lib/monorepo/handlers/npm.ts
@@ -1,21 +1,16 @@
-import path from 'node:path';
-import { fileExists } from '@code-pushup/utils';
 import {
+  MONOREPO_TOOL_DETECTORS,
   hasCodePushUpDependency,
   hasScript,
-  hasWorkspacesEnabled,
   listWorkspaces,
-} from '../packages.js';
+} from '@code-pushup/utils';
 import type { MonorepoToolHandler } from '../tools.js';
 
 export const npmHandler: MonorepoToolHandler = {
   tool: 'npm',
 
   async isConfigured(options) {
-    return (
-      (await fileExists(path.join(options.cwd, 'package-lock.json'))) &&
-      (await hasWorkspacesEnabled(options.cwd))
-    );
+    return MONOREPO_TOOL_DETECTORS.npm(options.cwd);
   },
 
   async listProjects(options) {
diff --git a/packages/ci/src/lib/monorepo/handlers/nx.ts b/packages/ci/src/lib/monorepo/handlers/nx.ts
@@ -1,7 +1,6 @@
-import path from 'node:path';
 import {
+  MONOREPO_TOOL_DETECTORS,
   executeProcess,
-  fileExists,
   interpolate,
   stringifyError,
   toArray,
@@ -13,7 +12,7 @@ export const nxHandler: MonorepoToolHandler = {
 
   async isConfigured(options) {
     return (
-      (await fileExists(path.join(options.cwd, 'nx.json'))) &&
+      (await MONOREPO_TOOL_DETECTORS.nx(options.cwd)) &&
       (
         await executeProcess({
           command: 'npx',
diff --git a/packages/ci/src/lib/monorepo/handlers/pnpm.ts b/packages/ci/src/lib/monorepo/handlers/pnpm.ts
@@ -1,30 +1,23 @@
-import path from 'node:path';
-import * as YAML from 'yaml';
-import { fileExists, readTextFile } from '@code-pushup/utils';
 import {
+  MONOREPO_TOOL_DETECTORS,
   hasCodePushUpDependency,
   hasScript,
   listPackages,
+  readPnpmWorkspacePatterns,
   readRootPackageJson,
-} from '../packages.js';
+} from '@code-pushup/utils';
 import type { MonorepoToolHandler } from '../tools.js';
 
-const WORKSPACE_FILE = 'pnpm-workspace.yaml';
-
 export const pnpmHandler: MonorepoToolHandler = {
   tool: 'pnpm',
 
   async isConfigured(options) {
-    return (
-      (await fileExists(path.join(options.cwd, WORKSPACE_FILE))) &&
-      (await fileExists(path.join(options.cwd, 'package.json')))
-    );
+    return MONOREPO_TOOL_DETECTORS.pnpm(options.cwd);
   },
 
   async listProjects(options) {
-    const yaml = await readTextFile(path.join(options.cwd, WORKSPACE_FILE));
-    const workspace = YAML.parse(yaml) as { packages?: string[] };
-    const packages = await listPackages(options.cwd, workspace.packages);
+    const patterns = await readPnpmWorkspacePatterns(options.cwd);
+    const packages = await listPackages(options.cwd, patterns);
     const rootPackageJson = await readRootPackageJson(options.cwd);
     return packages
       .filter(
diff --git a/packages/ci/src/lib/monorepo/handlers/turbo.ts b/packages/ci/src/lib/monorepo/handlers/turbo.ts
@@ -1,5 +1,5 @@
 import path from 'node:path';
-import { fileExists, readJsonFile } from '@code-pushup/utils';
+import { MONOREPO_TOOL_DETECTORS, readJsonFile } from '@code-pushup/utils';
 import type { MonorepoToolHandler } from '../tools.js';
 import { npmHandler } from './npm.js';
 import { pnpmHandler } from './pnpm.js';
@@ -17,7 +17,7 @@ export const turboHandler: MonorepoToolHandler = {
   async isConfigured(options) {
     const configPath = path.join(options.cwd, 'turbo.json');
     return (
-      (await fileExists(configPath)) &&
+      (await MONOREPO_TOOL_DETECTORS.turbo(options.cwd)) &&
       options.task in (await readJsonFile<TurboConfig>(configPath)).tasks
     );
   },
diff --git a/packages/ci/src/lib/monorepo/handlers/yarn.ts b/packages/ci/src/lib/monorepo/handlers/yarn.ts
@@ -1,21 +1,17 @@
-import path from 'node:path';
-import { executeProcess, fileExists } from '@code-pushup/utils';
 import {
+  MONOREPO_TOOL_DETECTORS,
+  executeProcess,
   hasCodePushUpDependency,
   hasScript,
-  hasWorkspacesEnabled,
   listWorkspaces,
-} from '../packages.js';
+} from '@code-pushup/utils';
 import type { MonorepoToolHandler } from '../tools.js';
 
 export const yarnHandler: MonorepoToolHandler = {
   tool: 'yarn',
 
   async isConfigured(options) {
-    return (
-      (await fileExists(path.join(options.cwd, 'yarn.lock'))) &&
-      (await hasWorkspacesEnabled(options.cwd))
-    );
+    return MONOREPO_TOOL_DETECTORS.yarn(options.cwd);
   },
 
   async listProjects(options) {
diff --git a/packages/ci/src/lib/monorepo/index.ts b/packages/ci/src/lib/monorepo/index.ts
@@ -1,7 +1,2 @@
 export { listMonorepoProjects, type RunManyCommand } from './list-projects.js';
-export {
-  isMonorepoTool,
-  MONOREPO_TOOLS,
-  type MonorepoTool,
-  type ProjectConfig,
-} from './tools.js';
+export type { ProjectConfig } from './tools.js';
diff --git a/packages/ci/src/lib/monorepo/list-projects.ts b/packages/ci/src/lib/monorepo/list-projects.ts
@@ -1,15 +1,14 @@
 import { glob } from 'glob';
 import path from 'node:path';
+import {
+  type MonorepoTool,
+  detectMonorepoTool,
+  listPackages,
+} from '@code-pushup/utils';
 import { logDebug, logInfo } from '../log.js';
 import type { Settings } from '../models.js';
-import { detectMonorepoTool } from './detect-tool.js';
 import { getToolHandler } from './handlers/index.js';
-import { listPackages } from './packages.js';
-import type {
-  MonorepoHandlerOptions,
-  MonorepoTool,
-  ProjectConfig,
-} from './tools.js';
+import type { MonorepoHandlerOptions, ProjectConfig } from './tools.js';
 
 export type MonorepoProjects = {
   tool: MonorepoTool | null;
@@ -74,7 +73,7 @@ async function resolveMonorepoTool(
     return settings.monorepo;
   }
 
-  const tool = await detectMonorepoTool(options);
+  const tool = await detectMonorepoTool(options.cwd);
   if (tool) {
     logInfo(`Auto-detected monorepo tool ${tool}`);
   } else {
diff --git a/packages/ci/src/lib/monorepo/tools.ts b/packages/ci/src/lib/monorepo/tools.ts
@@ -1,5 +1,4 @@
-export const MONOREPO_TOOLS = ['nx', 'turbo', 'yarn', 'pnpm', 'npm'] as const;
-export type MonorepoTool = (typeof MONOREPO_TOOLS)[number];
+import type { MonorepoTool } from '@code-pushup/utils';
 
 export type MonorepoToolHandler = {
   tool: MonorepoTool;
@@ -28,7 +27,3 @@ export type ProjectConfig = {
   bin: string;
   directory?: string;
 };
-
-export function isMonorepoTool(value: string): value is MonorepoTool {
-  return MONOREPO_TOOLS.includes(value as MonorepoTool);
-}
diff --git a/packages/ci/src/lib/run.int.test.ts b/packages/ci/src/lib/run.int.test.ts
@@ -28,7 +28,7 @@ import {
   teardownTestFolder,
 } from '@code-pushup/test-utils';
 import * as utils from '@code-pushup/utils';
-import { logger } from '@code-pushup/utils';
+import { type MonorepoTool, logger } from '@code-pushup/utils';
 import type {
   Comment,
   GitBranch,
@@ -37,7 +37,6 @@ import type {
   ProviderAPIClient,
   RunResult,
 } from './models.js';
-import type { MonorepoTool } from './monorepo/index.js';
 import { runInCI } from './run.js';
 
 vi.mock('@code-pushup/portal-client', async importOriginal => {
diff --git a/packages/utils/eslint.config.js b/packages/utils/eslint.config.js
@@ -30,7 +30,7 @@ export default tseslint.config(
     rules: {
       '@nx/dependency-checks': [
         'error',
-        { ignoredDependencies: ['esbuild'] }, // esbuild is a peer dependency of bundle-require
+        { ignoredDependencies: ['esbuild', 'type-fest'] }, // esbuild is a peer dependency of bundle-require
       ],
     },
   },
diff --git a/packages/utils/package.json b/packages/utils/package.json
@@ -32,11 +32,13 @@
     "build-md": "^0.4.2",
     "bundle-require": "^5.1.0",
     "esbuild": "^0.25.2",
+    "glob": "^11.0.1",
     "ora": "^9.0.0",
     "semver": "^7.6.0",
     "simple-git": "^3.20.0",
     "string-width": "^8.1.0",
     "wrap-ansi": "^9.0.2",
+    "yaml": "^2.5.1",
     "zod": "^4.2.1"
   },
   "peerDependencies": {
diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
@@ -185,3 +185,20 @@ export type {
   WithRequired,
 } from './lib/types.js';
 export * from './lib/import-module.js';
+export {
+  detectMonorepoTool,
+  isMonorepoTool,
+  MONOREPO_TOOL_DETECTORS,
+  MONOREPO_TOOLS,
+  type MonorepoTool,
+} from './lib/monorepo.js';
+export {
+  hasCodePushUpDependency,
+  hasScript,
+  hasWorkspacesEnabled,
+  listPackages,
+  listWorkspaces,
+  readPnpmWorkspacePatterns,
+  readRootPackageJson,
+  type WorkspacePackage,
+} from './lib/workspace-packages.js';
diff --git a/packages/utils/src/lib/monorepo.ts b/packages/utils/src/lib/monorepo.ts
@@ -0,0 +1,37 @@
+import path from 'node:path';
+import { fileExists } from './file-system.js';
+import { hasWorkspacesEnabled } from './workspace-packages.js';
+
+export const MONOREPO_TOOLS = ['nx', 'turbo', 'yarn', 'pnpm', 'npm'] as const;
+export type MonorepoTool = (typeof MONOREPO_TOOLS)[number];
+
+export const MONOREPO_TOOL_DETECTORS: Record<
+  MonorepoTool,
+  (cwd: string) => Promise<boolean>
+> = {
+  nx: cwd => fileExists(path.join(cwd, 'nx.json')),
+  turbo: cwd => fileExists(path.join(cwd, 'turbo.json')),
+  yarn: async cwd =>
+    (await fileExists(path.join(cwd, 'yarn.lock'))) &&
+    (await hasWorkspacesEnabled(cwd)),
+  pnpm: cwd => fileExists(path.join(cwd, 'pnpm-workspace.yaml')),
+  npm: async cwd =>
+    (await fileExists(path.join(cwd, 'package-lock.json'))) &&
+    (await hasWorkspacesEnabled(cwd)),
+};
+
+export async function detectMonorepoTool(
+  cwd: string,
+): Promise<MonorepoTool | null> {
+  // eslint-disable-next-line functional/no-loop-statements
+  for (const tool of MONOREPO_TOOLS) {
+    if (await MONOREPO_TOOL_DETECTORS[tool](cwd)) {
+      return tool;
+    }
+  }
+  return null;
+}
+
+export function isMonorepoTool(value: string): value is MonorepoTool {
+  return MONOREPO_TOOLS.includes(value as MonorepoTool);
+}
diff --git a/packages/utils/src/lib/monorepo.unit.test.ts b/packages/utils/src/lib/monorepo.unit.test.ts
diff --git a/packages/utils/src/lib/workspace-packages.ts b/packages/utils/src/lib/workspace-packages.ts
diff --git a/packages/utils/src/lib/workspace-packages.unit.test.ts b/packages/utils/src/lib/workspace-packages.unit.test.ts
