@netlify/build-info 4.0.9 → 4.0.11

package/bin.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+// This is a workaround for npm issue: https://github.com/npm/cli/issues/2632
+
+import './lib/bin.js'

package/lib/bin.d.ts

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

package/lib/bin.js

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+import { exit, argv } from 'process';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+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 = {
+    rootDir: {
+        string: true,
+        describe: `The root directory of the project if different from projectDir`,
+    },
+};
+const USAGE = `$0 [OPTIONS...] [PROJECT_DIRECTORY]
+
+Print relevant build information from a project.`;
+runCli();

package/lib/context.d.ts

@@ -0,0 +1,8 @@
+export function getContext({ projectDir, rootDir }?: {
+    projectDir?: string;
+    rootDir?: string;
+}): Promise<{
+    projectDir: string;
+    rootDir: string;
+    rootPackageJson: import("type-fest").PackageJson;
+}>;

package/lib/context.js

@@ -0,0 +1,34 @@
+import { resolve } from 'path';
+import { cwd } from 'process';
+import { readPackage } from 'read-pkg';
+const getPackageJson = async function (dir) {
+    try {
+        const packageJson = await readPackage({ cwd: dir, normalize: false });
+        if (packageJson === undefined) {
+            return {};
+        }
+        return packageJson;
+    }
+    catch {
+        return {};
+    }
+};
+export const getContext = async function ({ projectDir = cwd(), rootDir = '' } = {}) {
+    // Get the absolute dirs for both project and root
+    // We resolve the projectDir from the rootDir
+    const absoluteProjectDir = resolve(rootDir, projectDir);
+    // If a relative absolute path is given we rely on cwd
+    const absoluteRootDir = rootDir ? resolve(cwd(), rootDir) : undefined;
+    // We only pass through the root dir if it was provided and is actually different
+    // from the project dir
+    const validRootDir = absoluteRootDir && absoluteRootDir !== absoluteProjectDir ? absoluteRootDir : undefined;
+    // If rootDir equals projectDir we'll be getting the projectDir package.json
+    // Later on if we also need the projectDir package.json we can check for it
+    // and only perform one resolution
+    const rootPackageJson = await getPackageJson(rootDir || projectDir);
+    return {
+        projectDir: absoluteProjectDir,
+        rootDir: validRootDir,
+        rootPackageJson,
+    };
+};

package/lib/core.d.ts

@@ -0,0 +1,10 @@
+export function buildInfo(context: any): Promise<{
+    frameworks: any;
+    jsWorkspaces: {
+        isRoot: boolean;
+        packages: any[];
+    };
+} | {
+    frameworks: any;
+    jsWorkspaces?: undefined;
+}>;

package/lib/core.js

@@ -0,0 +1,8 @@
+import { getFrameworks } from './frameworks.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 getFrameworks(context);
+    return { ...jsWorkspaces, frameworks };
+};

package/lib/frameworks.d.ts

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

package/lib/frameworks.js

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

package/lib/main.d.ts

@@ -0,0 +1,10 @@
+export function getBuildInfo(opts: any): Promise<{
+    frameworks: any;
+    jsWorkspaces: {
+        isRoot: boolean;
+        packages: any[];
+    };
+} | {
+    frameworks: any;
+    jsWorkspaces?: undefined;
+}>;

package/lib/main.js

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

package/lib/workspaces.d.ts

@@ -0,0 +1,8 @@
+export function getWorkspaceInfo({ rootPackageJson, projectDir, rootDir }: {
+    rootPackageJson: any;
+    projectDir: any;
+    rootDir: any;
+}): Promise<{
+    isRoot: boolean;
+    packages: any[];
+}>;

package/lib/workspaces.js

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

package/package.json

@@ -1,69 +1,45 @@
 {
   "name": "@netlify/build-info",
-  "version": "4.0.9",
+  "version": "4.0.11",
   "description": "Build info utility",
   "type": "module",
-  "exports": "./src/main.js",
-  "main": "./src/main.js",
+  "exports": "./lib/main.js",
+  "main": "./lib/main.js",
+  "types": "./lib/main.d.ts",
   "bin": {
-    "build-info": "./src/bin.js"
+    "build-info": "./bin.js"
   },
   "files": [
-    "src/**/*.js",
-    "!src/**/*.test.js"
+    "bin.js",
+    "lib/**/*"
   ],
   "scripts": {
-    "prepare": "husky install node_modules/@netlify/eslint-config-node/.husky/",
-    "prepublishOnly": "npm ci && npm test",
-    "test": "run-s format test:dev",
-    "format": "run-s format:check-fix:*",
-    "format:ci": "run-s format:check:*",
-    "format:check-fix:lint": "run-e format:check:lint format:fix:lint",
-    "format:check:lint": "cross-env-shell eslint $npm_package_config_eslint",
-    "format:fix:lint": "cross-env-shell eslint --fix $npm_package_config_eslint",
-    "format:check-fix:prettier": "run-e format:check:prettier format:fix:prettier",
-    "format:check:prettier": "cross-env-shell prettier --check $npm_package_config_prettier",
-    "format:fix:prettier": "cross-env-shell prettier --write $npm_package_config_prettier",
-    "test:dev": "run-s test:dev:*",
-    "test:ci": "run-s test:ci:*",
-    "test:dev:ava": "ava",
-    "test:ci:ava": "c8 -r lcovonly -r text -r json ava"
-  },
-  "config": {
-    "eslint": "--ignore-path .gitignore --cache --format=codeframe --max-warnings=0 \"{src,scripts,.github}/**/*.{cjs,mjs,js,md,html}\" \"*.{cjs,mjs,js,md,html}\" \".*.{cjs,mjs,js,md,html}\"",
-    "prettier": "--ignore-path .gitignore --loglevel=warn \"{src,scripts,.github}/**/*.{cjs,mjs,js,md,yml,json,html}\" \"*.{cjs,mjs,js,yml,json,html}\" \".*.{cjs,mjs,js,yml,json,html}\" \"!**/package-lock.json\" \"!package-lock.json\""
-  },
-  "ava": {
-    "verbose": true,
-    "files": [
-      "!test/fixtures/**/*"
-    ]
+    "prebuild": "rm -rf lib",
+    "build": "tsc",
+    "test": "ava",
+    "test:ci": "c8 -r lcovonly -r text -r json ava"
   },
   "keywords": [],
   "license": "MIT",
   "repository": "netlify/build-info",
   "bugs": {
-    "url": "https://github.com/netlify/build-info/issues"
+    "url": "https://github.com/netlify/build/issues"
   },
   "author": "Netlify Inc.",
-  "directories": {
-    "test": "test"
-  },
   "dependencies": {
-    "@netlify/framework-info": "^9.0.0",
+    "@netlify/framework-info": "^9.3.0",
     "@npmcli/map-workspaces": "^2.0.0",
     "read-pkg": "^7.0.0",
     "yargs": "^17.0.0"
   },
   "devDependencies": {
-    "@netlify/eslint-config-node": "^5.1.4",
     "ava": "^4.0.0",
     "c8": "^7.11.0",
     "execa": "^6.0.0",
-    "get-bin-path": "^6.0.0",
-    "husky": "^7.0.4"
+    "get-bin-path": "^6.0.0"
   },
   "engines": {
     "node": "^12.20.0 || ^14.14.0 || >=16.0.0"
-  }
+  },
+  "gitHead": "4a38bc66bc9897e37beaab9e51a48516b0d02b40"
 }

package/src/bin.js

@@ -1,37 +0,0 @@
-#!/usr/bin/env node
-import { exit, argv } from 'process'
-
-import yargs from 'yargs'
-import { hideBin } from 'yargs/helpers'
-
-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 = {
-  rootDir: {
-    string: true,
-    describe: `The root directory of the project if different from projectDir`,
-  },
-}
-
-const USAGE = `$0 [OPTIONS...] [PROJECT_DIRECTORY]
-
-Print relevant build information from a project.`
-
-runCli()

package/src/context.js

@@ -1,39 +0,0 @@
-import { resolve } from 'path'
-import { cwd } from 'process'
-
-import { readPackage } from 'read-pkg'
-
-const getPackageJson = async function (dir) {
-  try {
-    const packageJson = await readPackage({ cwd: dir, normalize: false })
-    if (packageJson === undefined) {
-      return {}
-    }
-
-    return packageJson
-  } catch {
-    return {}
-  }
-}
-
-export const getContext = async function ({ projectDir = cwd(), rootDir = '' } = {}) {
-  // Get the absolute dirs for both project and root
-  // We resolve the projectDir from the rootDir
-  const absoluteProjectDir = resolve(rootDir, projectDir)
-  // If a relative absolute path is given we rely on cwd
-  const absoluteRootDir = rootDir ? resolve(cwd(), rootDir) : undefined
-
-  // We only pass through the root dir if it was provided and is actually different
-  // from the project dir
-  const validRootDir = absoluteRootDir && absoluteRootDir !== absoluteProjectDir ? absoluteRootDir : undefined
-
-  // If rootDir equals projectDir we'll be getting the projectDir package.json
-  // Later on if we also need the projectDir package.json we can check for it
-  // and only perform one resolution
-  const rootPackageJson = await getPackageJson(rootDir || projectDir)
-  return {
-    projectDir: absoluteProjectDir,
-    rootDir: validRootDir,
-    rootPackageJson,
-  }
-}

package/src/core.js

@@ -1,11 +0,0 @@
-'use strict'
-
-import { getFrameworks } from './frameworks.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 getFrameworks(context)
-  return { ...jsWorkspaces, frameworks }
-}

package/src/frameworks.js

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

package/src/main.js

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

package/src/workspaces.js

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