refactor(plugin-js-packages): extract silent package manager detection

Author: hanna-skryl

packages/plugin-js-packages/src/lib/binding.ts

@@ -12,14 +12,13 @@ import {
   fileExists,
   singleQuote,
 } from '@code-pushup/utils';
-import type { PackageManagerId } from './config.js';
 import {
   DEFAULT_CHECKS,
   DEFAULT_DEPENDENCY_GROUPS,
   JS_PACKAGES_PLUGIN_SLUG,
   JS_PACKAGES_PLUGIN_TITLE,
 } from './constants.js';
-import { derivePackageManager } from './package-managers/derive-package-manager.js';
+import { detectPackageManager } from './package-managers/derive-package-manager.js';
 
 const { name: PACKAGE_NAME } = createRequire(import.meta.url)(
   '../../package.json',
@@ -73,7 +72,9 @@ export const jsPackagesSetupBinding = {
   packageName: PACKAGE_NAME,
   isRecommended,
   prompts: async (targetDir: string) => {
-    const packageManager = await detectPackageManager(targetDir);
+    const packageManager = await detectPackageManager(targetDir).catch(
+      () => DEFAULT_PACKAGE_MANAGER,
+    );
     return [
       {
         key: 'js-packages.packageManager',
@@ -175,13 +176,3 @@ function createCategories({
 async function isRecommended(targetDir: string): Promise<boolean> {
   return fileExists(path.join(targetDir, 'package.json'));
 }
-
-async function detectPackageManager(
-  targetDir: string,
-): Promise<PackageManagerId> {
-  try {
-    return await derivePackageManager(targetDir);
-  } catch {
-    return DEFAULT_PACKAGE_MANAGER;
-  }
-}

packages/plugin-js-packages/src/lib/package-managers/derive-package-manager.ts

@@ -31,34 +31,41 @@ export async function derivePackageManagerInPackageJson(
   return false;
 }
 
-export async function derivePackageManager(
-  currentDir = process.cwd(),
-): Promise<PackageManagerId> {
+type DetectionResult = {
+  id: PackageManagerId;
+  sourceDescription: string;
+};
+
+async function resolvePackageManager(
+  currentDir: string,
+): Promise<DetectionResult> {
   const pkgManagerFromPackageJson =
     await derivePackageManagerInPackageJson(currentDir);
   if (pkgManagerFromPackageJson) {
-    logDerivedPackageManager(
-      pkgManagerFromPackageJson,
-      'packageManager field in package.json',
-    );
-    return pkgManagerFromPackageJson;
+    return {
+      id: pkgManagerFromPackageJson,
+      sourceDescription: 'packageManager field in package.json',
+    };
   }
 
   // Check for lock files
   if (await fileExists(path.join(currentDir, 'package-lock.json'))) {
-    logDerivedPackageManager('npm', 'existence of package-lock.json file');
-    return 'npm';
+    return {
+      id: 'npm',
+      sourceDescription: 'existence of package-lock.json file',
+    };
   } else if (await fileExists(path.join(currentDir, 'pnpm-lock.yaml'))) {
-    logDerivedPackageManager('pnpm', 'existence of pnpm-lock.yaml file');
-    return 'pnpm';
+    return {
+      id: 'pnpm',
+      sourceDescription: 'existence of pnpm-lock.yaml file',
+    };
   } else if (await fileExists(path.join(currentDir, 'yarn.lock'))) {
     const yarnVersion = await deriveYarnVersion();
     if (yarnVersion) {
-      logDerivedPackageManager(
-        yarnVersion,
-        'existence of yarn.lock file and yarn -v command',
-      );
-      return yarnVersion;
+      return {
+        id: yarnVersion,
+        sourceDescription: 'existence of yarn.lock file and yarn -v command',
+      };
     }
   }
 
@@ -67,14 +74,22 @@ export async function derivePackageManager(
   );
 }
 
-function logDerivedPackageManager(
-  id: PackageManagerId,
-  sourceDescription: string,
-): void {
+export async function detectPackageManager(
+  currentDir = process.cwd(),
+): Promise<PackageManagerId> {
+  const { id } = await resolvePackageManager(currentDir);
+  return id;
+}
+
+export async function derivePackageManager(
+  currentDir = process.cwd(),
+): Promise<PackageManagerId> {
+  const { id, sourceDescription } = await resolvePackageManager(currentDir);
   const pm = packageManagers[id];
   logger.info(
     formatMetaLog(
       `Inferred ${pm.name} package manager from ${sourceDescription}`,
     ),
   );
+  return id;
 }