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

package/lib/bin.d.ts

@@ -1,2 +1 @@
-#!/usr/bin/env node
 export {};

package/lib/bin.js

@@ -1,28 +1,14 @@
-#!/usr/bin/env node
-import { relative } from 'path';
 import { exit, argv } from 'process';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
-import { getContext } from './context.js';
-import { getBuildInfo } from './main.js';
-import { getWorkspaceInfo } from './workspaces.js';
+import { getBuildInfo } from './get-build-info.js';
 yargs(hideBin(argv))
-    .command('print-workspaces [rootDir]', 'This command is used inside buildbot to retrieve a space separated list of relative package paths', () => {
-    // no build options
-}, async ({ projectDir }) => {
-    const context = await getContext({ projectDir });
-    const workspaces = await getWorkspaceInfo(context);
-    if (!workspaces) {
-        return;
-    }
-    console.log(workspaces.packages.map((p) => relative(context.projectDir, p)).join(' '));
-})
-    .command('* [projectDir]', '', (builder) => builder.options({
+    .command('* [projectDir]', 'Print relevant build information from a project.', (builder) => builder.options({
     rootDir: {
         string: true,
         describe: `The root directory of the project if different from projectDir`,
     },
-}), async ({ rootDir, projectDir }) => {
+}), async ({ projectDir, rootDir }) => {
     try {
         const buildInfo = await getBuildInfo({ projectDir, rootDir });
         console.log(JSON.stringify(buildInfo, null, 2));

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

@@ -1,4 +1,4 @@
-declare type PkgManagerFields = {
+export declare type PkgManagerFields = {
     /** The package managers name that is used for logging */
     name: string;
     /** The package managers install command */
@@ -20,4 +20,3 @@ declare type PkgManagerFields = {
  * @returns The package manager that was detected
  */
 export declare const detectPackageManager: (cwd?: string) => Promise<PkgManagerFields>;
-export {};

package/lib/detect-package-manager.js

@@ -46,8 +46,10 @@ export const detectPackageManager = async (cwd) => {
     // return the found package manager
     if (lockFilePath) {
         const lockFile = basename(lockFilePath);
-        if (lockFileMap[lockFile].forceEnvironment !== 'false') {
-            return lockFileMap[lockFile];
+        const pkgM = lockFileMap[lockFile];
+        // check if it not got disabled
+        if (!(pkgM.forceEnvironment && process.env[pkgM.forceEnvironment] === 'false')) {
+            return pkgM;
         }
     }
     const pkgPaths = await findUpMultiple('package.json', { cwd });

package/lib/get-build-info.d.ts

@@ -0,0 +1,9 @@
+import { ContextOptions } from './context.js';
+import { PkgManagerFields } from './detect-package-manager.js';
+import { WorkspaceInfo } from './workspaces.js';
+export declare type Info = {
+    jsWorkspaces?: WorkspaceInfo;
+    packageManager?: PkgManagerFields;
+    frameworks: unknown[];
+};
+export declare const getBuildInfo: (opts: ContextOptions) => Promise<Info>;

package/lib/get-build-info.js

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

package/lib/index.d.ts

@@ -0,0 +1 @@
+export { getBuildInfo } from './get-build-info.js';

package/lib/index.js

@@ -0,0 +1 @@
+export { getBuildInfo } from './get-build-info.js';

package/lib/workspaces.d.ts

@@ -1,5 +1,14 @@
 import type { Context } from './context.js';
-export declare const getWorkspaceInfo: (context: Context) => Promise<{
+export declare type WorkspaceInfo = {
+    /** if we are in the current workspace root or not */
     isRoot: boolean;
-    packages: any[];
-}>;
+    /** the workspace root directory */
+    rootDir: string;
+    /** list of relative package paths inside the workspace */
+    packages: string[];
+};
+/**
+ * If it's a javascript workspace (npm, pnpm, yarn) it will retrieve a list of all
+ * relative package paths and will indicate if it's the root of the workspace
+ */
+export declare const getWorkspaceInfo: (context: Context) => Promise<undefined | WorkspaceInfo>;

package/lib/workspaces.js

@@ -1,18 +1,30 @@
+import { join, relative } from 'path';
 import mapWorkspaces from '@npmcli/map-workspaces';
+/**
+ * If it's a javascript workspace (npm, pnpm, yarn) it will retrieve a list of all
+ * relative package paths and will indicate if it's the root of the workspace
+ */
 export const getWorkspaceInfo = async (context) => {
     if (!context.rootPackageJson.workspaces) {
         return;
     }
+    const rootDir = context.rootDir || context.projectDir;
     const workspacesMap = await mapWorkspaces({
-        cwd: context.rootDir || context.projectDir,
+        cwd: rootDir,
         pkg: context.rootPackageJson,
     });
-    const packages = [...workspacesMap.values()];
-    // The provided project dir is a workspace package
-    const isWorkspace = packages.find((path) => context.projectDir === path);
+    // make paths relative
+    const packages = [...workspacesMap.values()].map((p) => relative(rootDir, p));
+    // The provided project dir is a workspace package and not a different directory
+    // in a mono repository that is not part inside the npm workspaces
+    const isWorkspace = packages.find((path) => context.projectDir === join(rootDir, path));
     // The project dir is a collection of workspaces itself
     const isRoot = !context.rootDir;
     if (isWorkspace || isRoot) {
-        return { isRoot, packages };
+        return {
+            isRoot,
+            packages,
+            rootDir,
+        };
     }
 };

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@netlify/build-info",
-  "version": "5.1.1-rc.2",
+  "version": "5.1.1-rc.4",
   "description": "Build info utility",
   "type": "module",
-  "exports": "./lib/main.js",
-  "main": "./lib/main.js",
-  "types": "./lib/main.d.ts",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "bin": {
     "build-info": "./bin.js"
   },

package/lib/core.d.ts

@@ -1,2 +0,0 @@
-import type { Context } from './context.js';
-export declare const buildInfo: (context: Context) => Promise<any>;

package/lib/core.js

@@ -1,12 +0,0 @@
-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/main.d.ts

@@ -1,2 +0,0 @@
-import { ContextOptions } from './context.js';
-export declare const getBuildInfo: (opts: ContextOptions) => Promise<any>;

package/lib/main.js

@@ -1,6 +0,0 @@
-import { getContext } from './context.js';
-import { buildInfo } from './core.js';
-export const getBuildInfo = async (opts) => {
-    const context = await getContext(opts);
-    return await buildInfo(context);
-};