@netlify/build-info 5.0.0 → 5.1.0

package/README.md

@@ -1,6 +1,3 @@
-[![Build](https://github.com/netlify/build-info/workflows/Build/badge.svg)](https://github.com/netlify/build-info/actions)
-[![Node](https://img.shields.io/node/v/@netlify/build-info.svg?logo=node.js)](https://www.npmjs.com/package/@netlify/build-info)
-
 # Build Info
 
 Build information detection utility.

package/lib/bin.js

@@ -1,30 +1,26 @@
 #!/usr/bin/env node
 import { exit, argv } from 'process';
-import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
+import yargs from 'yargs/yargs';
 import { getBuildInfo } from './main.js';
-// CLI entry point
-const runCli = async function () {
-    const { projectDir, rootDir } = parseArgs();
-    try {
-        const buildInfo = await getBuildInfo({ projectDir, rootDir });
-        console.log(JSON.stringify(buildInfo, null, 2));
-    }
-    catch (error) {
-        console.error(error);
-        exit(1);
-    }
-};
-const parseArgs = function () {
-    return yargs(hideBin(argv)).command('* [projectDir]').options(OPTIONS).usage(USAGE).strict().parse();
-};
-const OPTIONS = {
+const { projectDir, rootDir } = yargs(hideBin(argv))
+    .command('* [projectDir]')
+    .options({
     rootDir: {
         string: true,
         describe: `The root directory of the project if different from projectDir`,
     },
-};
-const USAGE = `$0 [OPTIONS...] [PROJECT_DIRECTORY]
+})
+    .usage(`$0 [OPTIONS...] [PROJECT_DIRECTORY]
 
-Print relevant build information from a project.`;
-runCli();
+  Print relevant build information from a project.`)
+    .strict()
+    .parse();
+try {
+    const buildInfo = await getBuildInfo({ projectDir, rootDir });
+    console.log(JSON.stringify(buildInfo, null, 2));
+}
+catch (error) {
+    console.error(error);
+    exit(1);
+}

package/lib/context.d.ts

@@ -1,8 +1,11 @@
-export function getContext({ projectDir, rootDir }?: {
+import { PackageJson } from 'read-pkg';
+export declare type ContextOptions = {
     projectDir?: string;
     rootDir?: string;
-}): Promise<{
+};
+export declare type Context = {
     projectDir: string;
     rootDir: string;
-    rootPackageJson: import("type-fest").PackageJson;
-}>;
+    rootPackageJson: PackageJson;
+};
+export declare const getContext: (config?: ContextOptions) => Promise<Context>;

package/lib/context.js

@@ -1,19 +1,21 @@
 import { resolve } from 'path';
 import { cwd } from 'process';
 import { readPackage } from 'read-pkg';
-const getPackageJson = async function (dir) {
+/**
+ * Reads a package.json up the tree starting at the provided directory
+ * @param cwd The current working directory where it tries to find the package.json
+ * @returns A parsed object of the package.json
+ */
+const getPackageJson = async (cwd) => {
     try {
-        const packageJson = await readPackage({ cwd: dir, normalize: false });
-        if (packageJson === undefined) {
-            return {};
-        }
-        return packageJson;
+        return await readPackage({ cwd, normalize: false });
     }
     catch {
         return {};
     }
 };
-export const getContext = async function ({ projectDir = cwd(), rootDir = '' } = {}) {
+export const getContext = async (config = {}) => {
+    const { projectDir = cwd(), rootDir = '' } = config;
     // Get the absolute dirs for both project and root
     // We resolve the projectDir from the rootDir
     const absoluteProjectDir = resolve(rootDir, projectDir);

package/lib/core.d.ts

@@ -1,4 +1,5 @@
-export function buildInfo(context: any): Promise<{
+import type { Context } from './context.js';
+export declare const buildInfo: (context: Context) => Promise<{
     frameworks: any;
     jsWorkspaces: {
         isRoot: boolean;

package/lib/core.js

@@ -1,8 +1,8 @@
-import { getFrameworks } from './frameworks.js';
+import { listFrameworks } from '@netlify/framework-info';
 import { getWorkspaceInfo } from './workspaces.js';
 export const buildInfo = async function (context) {
     const workspaceInfo = await getWorkspaceInfo(context);
     const jsWorkspaces = workspaceInfo ? { jsWorkspaces: workspaceInfo } : {};
-    const frameworks = await getFrameworks(context);
+    const frameworks = await listFrameworks({ projectDir: context.projectDir });
     return { ...jsWorkspaces, frameworks };
 };

package/lib/main.d.ts

@@ -1,4 +1,5 @@
-export function getBuildInfo(opts: any): Promise<{
+import { ContextOptions } from './context.js';
+export declare const getBuildInfo: (opts: ContextOptions) => Promise<{
     frameworks: any;
     jsWorkspaces: {
         isRoot: boolean;

package/lib/main.js

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

package/lib/workspaces.d.ts

@@ -1,8 +1,5 @@
-export function getWorkspaceInfo({ rootPackageJson, projectDir, rootDir }: {
-    rootPackageJson: any;
-    projectDir: any;
-    rootDir: any;
-}): Promise<{
+import type { Context } from './context.js';
+export declare const getWorkspaceInfo: (context: Context) => Promise<{
     isRoot: boolean;
     packages: any[];
 }>;

package/lib/workspaces.js

@@ -1,17 +1,17 @@
 import mapWorkspaces from '@npmcli/map-workspaces';
-export const getWorkspaceInfo = async function ({ rootPackageJson, projectDir, rootDir }) {
-    if (!rootPackageJson.workspaces) {
+export const getWorkspaceInfo = async (context) => {
+    if (!context.rootPackageJson.workspaces) {
         return;
     }
     const workspacesMap = await mapWorkspaces({
-        cwd: rootDir || projectDir,
-        pkg: rootPackageJson,
+        cwd: context.rootDir || context.projectDir,
+        pkg: context.rootPackageJson,
     });
     const packages = [...workspacesMap.values()];
     // The provided project dir is a workspace package
-    const isWorkspace = packages.find((path) => projectDir === path);
+    const isWorkspace = packages.find((path) => context.projectDir === path);
     // The project dir is a collection of workspaces itself
-    const isRoot = !rootDir;
+    const isRoot = !context.rootDir;
     if (isWorkspace || isRoot) {
         return { isRoot, packages };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build-info",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "description": "Build info utility",
   "type": "module",
   "exports": "./lib/main.js",
@@ -16,8 +16,9 @@
   "scripts": {
     "prebuild": "rm -rf lib",
     "build": "tsc",
-    "test": "ava",
-    "test:ci": "c8 -r lcovonly -r text -r json ava"
+    "test": "vitest run",
+    "test:dev": "vitest",
+    "test:ci": "vitest run --reporter=default"
   },
   "keywords": [],
   "license": "MIT",
@@ -34,14 +35,13 @@
   },
   "devDependencies": {
     "@types/node": "^14.18.31",
-    "ava": "^4.0.0",
-    "c8": "^7.11.0",
+    "@vitest/coverage-c8": "^0.24.1",
     "execa": "^6.0.0",
-    "get-bin-path": "^6.0.0",
-    "typescript": "^4.8.4"
+    "typescript": "^4.8.4",
+    "vitest": "^0.24.1"
   },
   "engines": {
     "node": "^14.16.0 || >=16.0.0"
   },
-  "gitHead": "c4502f1c112e7f33d5e6fa053bfbe7dabdfe0160"
+  "gitHead": "701e883d4e19c048e8de9801e49e21de5c891a18"
 }

package/lib/frameworks.d.ts

@@ -1,3 +0,0 @@
-export function getFrameworks({ projectDir }: {
-    projectDir: any;
-}): Promise<any>;

package/lib/frameworks.js

@@ -1,4 +0,0 @@
-import { listFrameworks } from '@netlify/framework-info';
-export const getFrameworks = async function ({ projectDir }) {
-    return await listFrameworks({ projectDir });
-};