@netlify/build-info 5.1.1-rc.0 → 5.1.1-rc.2

package/lib/bin.js

@@ -11,8 +11,11 @@ yargs(hideBin(argv))
     // no build options
 }, async ({ projectDir }) => {
     const context = await getContext({ projectDir });
-    const { packages } = await getWorkspaceInfo(context);
-    console.log(packages.map((p) => relative(context.projectDir, p)).join(' '));
+    const workspaces = await getWorkspaceInfo(context);
+    if (!workspaces) {
+        return;
+    }
+    console.log(workspaces.packages.map((p) => relative(context.projectDir, p)).join(' '));
 })
     .command('* [projectDir]', '', (builder) => builder.options({
     rootDir: {

package/lib/context.d.ts

@@ -5,7 +5,7 @@ export declare type ContextOptions = {
 };
 export declare type Context = {
     projectDir: string;
-    rootDir: string;
+    rootDir?: string;
     rootPackageJson: PackageJson;
 };
 export declare const getContext: (config?: ContextOptions) => Promise<Context>;

package/lib/core.d.ts

@@ -1,11 +1,2 @@
 import type { Context } from './context.js';
-export declare const buildInfo: (context: Context) => Promise<{
-    frameworks: any;
-    jsWorkspaces: {
-        isRoot: boolean;
-        packages: any[];
-    };
-} | {
-    frameworks: any;
-    jsWorkspaces?: undefined;
-}>;
+export declare const buildInfo: (context: Context) => Promise<any>;

package/lib/core.js

@@ -1,8 +1,12 @@
 import { listFrameworks } from '@netlify/framework-info';
+import { detectPackageManager } from './detect-package-manager.js';
 import { getWorkspaceInfo } from './workspaces.js';
 export const buildInfo = async function (context) {
     const workspaceInfo = await getWorkspaceInfo(context);
     const jsWorkspaces = workspaceInfo ? { jsWorkspaces: workspaceInfo } : {};
     const frameworks = await listFrameworks({ projectDir: context.projectDir });
+    if (Object.keys(context.rootPackageJson).length > 0) {
+        jsWorkspaces.packageManager = detectPackageManager(context.projectDir);
+    }
     return { ...jsWorkspaces, frameworks };
 };

package/lib/detect-package-manager.d.ts

@@ -0,0 +1,23 @@
+declare type PkgManagerFields = {
+    /** The package managers name that is used for logging */
+    name: string;
+    /** The package managers install command */
+    installCommand: string;
+    /** The lock file a package manager is using */
+    lockFile: string;
+    /** Environment variable that can be used to force the usage of a package manager even though there is no lock file or a different lock file */
+    forceEnvironment?: string;
+    /** Flags that should be used for running the install command */
+    installFlags?: string[];
+    /** A list of all cache locations for the package manager */
+    cacheLocations?: string[];
+};
+/**
+ * Detects the used package manager based on
+ *  - a set environment variable that forces the usage
+ *  - a lock file that is present in this directory or up in the tree for workspaces
+ * @param cwd The current process working directory of the build
+ * @returns The package manager that was detected
+ */
+export declare const detectPackageManager: (cwd?: string) => Promise<PkgManagerFields>;
+export {};

package/lib/detect-package-manager.js

@@ -0,0 +1,67 @@
+import { readFileSync } from 'fs';
+import { basename } from 'path';
+import { findUp, findUpMultiple } from 'find-up';
+/** The definition of all available package managers */
+const AVAILABLE_PACKAGE_MANAGERS = {
+    ["yarn" /* PkgManager.Yarn */]: {
+        name: 'yarn',
+        installCommand: 'yarn install',
+        lockFile: 'yarn.lock',
+        forceEnvironment: 'NETLIFY_USE_YARN',
+    },
+    ["pnpm" /* PkgManager.PNPM */]: {
+        name: 'pnpm',
+        installCommand: 'pnpm install',
+        lockFile: 'pnpm-lock.yaml',
+        forceEnvironment: 'NETLIFY_USE_PNPM',
+    },
+    ["npm" /* PkgManager.NPM */]: {
+        name: 'npm',
+        installCommand: 'npm install',
+        lockFile: 'package-lock.json',
+    },
+};
+/**
+ * generate a map out of key is lock file and value the package manager
+ * this is to reduce the complexity in loops
+ */
+const lockFileMap = Object.values(AVAILABLE_PACKAGE_MANAGERS).reduce((cur, pkgManager) => ({ ...cur, [pkgManager.lockFile]: pkgManager }), {});
+/**
+ * Detects the used package manager based on
+ *  - a set environment variable that forces the usage
+ *  - a lock file that is present in this directory or up in the tree for workspaces
+ * @param cwd The current process working directory of the build
+ * @returns The package manager that was detected
+ */
+export const detectPackageManager = async (cwd) => {
+    // the package manager can be enforced via an environment variable as well
+    for (const pkgManager of Object.values(AVAILABLE_PACKAGE_MANAGERS)) {
+        if (pkgManager.forceEnvironment && process.env[pkgManager.forceEnvironment] === 'true') {
+            return pkgManager;
+        }
+    }
+    // find the correct lock file the tree up
+    const lockFilePath = await findUp(Object.keys(lockFileMap), { cwd });
+    // if we found a lock file and the usage is not prohibited through an environment variable
+    // return the found package manager
+    if (lockFilePath) {
+        const lockFile = basename(lockFilePath);
+        if (lockFileMap[lockFile].forceEnvironment !== 'false') {
+            return lockFileMap[lockFile];
+        }
+    }
+    const pkgPaths = await findUpMultiple('package.json', { cwd });
+    for (const pkgPath of pkgPaths) {
+        const { packageManager } = JSON.parse(readFileSync(pkgPath, 'utf-8'));
+        if (packageManager) {
+            //
+            const [parsed] = packageManager.split('@');
+            if (AVAILABLE_PACKAGE_MANAGERS[parsed]) {
+                return AVAILABLE_PACKAGE_MANAGERS[parsed];
+            }
+        }
+    }
+    // always default to npm
+    // TODO: add some reporting here to log that we fall backed
+    return AVAILABLE_PACKAGE_MANAGERS["npm" /* PkgManager.NPM */];
+};

package/lib/main.d.ts

@@ -1,11 +1,2 @@
 import { ContextOptions } from './context.js';
-export declare const getBuildInfo: (opts: ContextOptions) => Promise<{
-    frameworks: any;
-    jsWorkspaces: {
-        isRoot: boolean;
-        packages: any[];
-    };
-} | {
-    frameworks: any;
-    jsWorkspaces?: undefined;
-}>;
+export declare const getBuildInfo: (opts: ContextOptions) => Promise<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build-info",
-  "version": "5.1.1-rc.0",
+  "version": "5.1.1-rc.2",
   "description": "Build info utility",
   "type": "module",
   "exports": "./lib/main.js",
@@ -17,7 +17,7 @@
     "prebuild": "rm -rf lib",
     "build": "tsc",
     "test": "vitest run",
-    "test:dev": "vitest",
+    "test:dev": "vitest --ui",
     "test:ci": "vitest run --reporter=default"
   },
   "keywords": [],
@@ -30,14 +30,18 @@
   "dependencies": {
     "@netlify/framework-info": "^9.3.0",
     "@npmcli/map-workspaces": "^2.0.0",
+    "find-up": "^6.3.0",
     "read-pkg": "^7.1.0",
     "yargs": "^17.6.0"
   },
   "devDependencies": {
     "@types/node": "^14.18.31",
     "@vitest/coverage-c8": "^0.24.1",
+    "@vitest/ui": "^0.24.3",
     "execa": "^6.0.0",
+    "memfs": "^3.4.7",
     "typescript": "^4.8.4",
+    "unionfs": "^4.4.0",
     "vitest": "^0.24.1"
   },
   "engines": {