@netlify/build-info 7.4.0 → 7.4.2

package/README.md

@@ -1,106 +1,49 @@
 # Build Info
 
-Build information detection utility.
-
-The purpose of this lib is to, given a project and a configuration, return a set of useful data for our build system.
-Currently it's used to detect:
-
-- [`jsWorkspaces`](https://docs.npmjs.com/cli/v7/using-npm/workspaces)
-- [`frameworks`](https://github.com/netlify/framework-info)
-
-But it's possible to extend it in the future to extract other bits of information, such as the heuristics present in the
-[`build-image`](https://github.com/netlify/build-image/blob/xenial/run-build-functions.sh#L214).
-
-# Example (Node.js)
-
-```js
-import { getBuildInfo } from '@netlify/build-info'
-
-console.log(await getBuildInfo({ projectDir: 'path/to/site', rootDir: '/project/root/dir' }))
-// {
-//   jsWorkspaces: {
-//     isRoot: false,
-//     packages: [
-//       'path/to/site',
-//       'path/to/component/library'
-//       'path/to/utility/library'
-//     ]
-//   },
-//   frameworks: [
-//     {
-//        name: 'gatsby',
-//        category: 'static_site_generator',
-//        dev: {
-//          commands: ['gatsby develop'],
-//          port: 8000
-//        },
-//        build: {
-//          commands: ['gatsby build'],
-//          directory: 'public'
-//        },
-//        env: { GATSBY_LOGGER: 'yurnalist' },
-//        plugins: []
-//      }
-//    ]
-// }
-
-console.log(await getBuildInfo({ projectDir: '/project/root/dir' }))
-// {
-//   jsWorkspaces: {
-//     isRoot: true,
-//     packages: [
-//       'path/to/site',
-//       'path/to/component/library'
-//       'path/to/utility/library'
-//     ]
-//   },
-//   frameworks: []
-// }
+Build info is the core part of detecting settings and heuristics about the users code. The library is platform agnostic
+to be used in our React UI, Node.js CLI and build system.
+
+It provides a layered approach to detecting the following information:
+
+1. Package Manager
+2. Workspaces (pnpm, yarn, npm)
+3. Build Systems
+4. Frameworks
+5. Build Settings
+
+How to use it: First of all, you need to create a `FileSystem` that works for your platform. For Node.js we ship already
+one that can be used: For other platforms, a file system needs to implement the `FileSystem` interface:
+
+```typescript
+import { FileSystem } from '@netlify/build-info'
+
+export class WebFS extends FileSystem {
+  // ...
+}
 ```
 
+After that the core piece is the Project that needs to be initialized with a file system, the base directory and an
+optional repository root.
+
+It is important to note that setting a node version is important for some frameworks to load the correct plugins.
+
+```typescript
+const project = new Project(fs, baseDir, root).setEnvironment(process.env).setNodeVersion(process.version)
+```
+
+after that on the project, we can call multiple methods like `getBuildSettings` which is running all the other steps as
+well.
+
 # Example (CLI)
 
 ```bash
+# will use the current working directory as base directory
+$ build-info
+
 $ build-info /project/root/dir
-{
-  jsWorkspaces: {
-    isRoot: true,
-    packages: [
-      'path/to/site',
-      'path/to/component/library'
-      'path/to/utility/library'
-    ]
-  },
-  frameworks: []
-}
 
 $ build-info path/to/site --rootDir /project/root/dir
-{
-  jsWorkspaces: {
-    isRoot: false,
-    packages: [
-      'path/to/site',
-      'path/to/component/library'
-      'path/to/utility/library'
-    ]
-  },
-  frameworks: [
-    {
-       name: 'gatsby',
-       category: 'static_site_generator',
-       dev: {
-         commands: ['gatsby develop'],
-         port: 8000
-       },
-       build: {
-         commands: ['gatsby build'],
-         directory: 'public'
-       },
-       env: { GATSBY_LOGGER: 'yurnalist' },
-       plugins: []
-     }
-  ]
-}
+
 ```
 
 ## Contributors

package/lib/frameworks/index.d.ts

@@ -43,7 +43,7 @@ import { VuePress } from './vuepress.js';
 import { Wintersmith } from './wintersmith.js';
 import { WMR } from './wmr.js';
 import { Zola } from './zola.js';
-export declare const frameworks: (typeof Astro | typeof Docusaurus | typeof Eleventy | typeof Gatsby | typeof Gridsome | typeof Hexo | typeof Hugo | typeof Hydrogen | typeof Jekyll | typeof Middleman | typeof Next | typeof Blitz | typeof Nuxt | typeof Phenomic | typeof Qwik | typeof ReactStatic | typeof RedwoodJS | typeof Remix | typeof Solid | typeof SolidStart | typeof Stencil | typeof VuePress | typeof Assemble | typeof DocPad | typeof Harp | typeof Metalsmith | typeof Roots | typeof Wintersmith | typeof Cecil | typeof Zola | typeof Angular | typeof CreateReactApp | typeof Ember | typeof Expo | typeof Quasar | typeof Sapper | typeof Svelte | typeof SvelteKit | typeof Vue | typeof Brunch | typeof Parcel | typeof Gulp | typeof Grunt | typeof Vite | typeof WMR)[];
+export declare const frameworks: (typeof Angular | typeof Assemble | typeof Astro | typeof Blitz | typeof Brunch | typeof Cecil | typeof DocPad | typeof Docusaurus | typeof Eleventy | typeof Ember | typeof Expo | typeof Gatsby | typeof Gridsome | typeof Grunt | typeof Gulp | typeof Harp | typeof Hexo | typeof Hugo | typeof Hydrogen | typeof Jekyll | typeof Metalsmith | typeof Middleman | typeof Next | typeof Nuxt | typeof Parcel | typeof Phenomic | typeof Quasar | typeof Qwik | typeof ReactStatic | typeof CreateReactApp | typeof RedwoodJS | typeof Remix | typeof Roots | typeof Sapper | typeof SolidStart | typeof Solid | typeof Stencil | typeof SvelteKit | typeof Svelte | typeof Vite | typeof Vue | typeof VuePress | typeof Wintersmith | typeof WMR | typeof Zola)[];
 type Frameworks = typeof frameworks;
 export type FrameworkName = InstanceType<Frameworks[number]>['id'];
 export type { FrameworkInfo, PollingStrategy } from './framework.js';

package/lib/get-framework.d.ts

@@ -1,4 +1,5 @@
-import { FrameworkName, FrameworkInfo } from './frameworks/index.js';
+import { Framework } from './frameworks/framework.js';
+import { FrameworkName } from './frameworks/index.js';
 import { Project } from './project.js';
 /** Return some information about a framework used by a project. */
-export declare function getFramework(frameworkId: FrameworkName, project: Project): Promise<FrameworkInfo | undefined>;
+export declare function getFramework(frameworkId: FrameworkName, project: Project): Promise<Framework>;

package/lib/get-framework.js

@@ -4,8 +4,7 @@ export async function getFramework(frameworkId, project) {
     const frameworkList = frameworks.map((Framework) => new Framework(project));
     const framework = frameworkList.find(({ id }) => id === frameworkId);
     if (framework) {
-        const result = await framework.detect();
-        return result?.toJSON();
+        return framework;
     }
     const frameworkIds = frameworkList
         .map(({ id }) => id)

package/lib/get-framework.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-framework.js","sourceRoot":"","sources":["../src/get-framework.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,UAAU,EAAiB,MAAM,uBAAuB,CAAA;AAGhF,mEAAmE;AACnE,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,WAA0B,EAAE,OAAgB;IAC7E,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;IAC3E,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,WAAW,CAAC,CAAA;IAEpE,IAAI,SAAS,EAAE;QACb,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,CAAA;QACvC,OAAO,MAAM,EAAE,MAAM,EAAE,CAAA;KACxB;IAED,MAAM,YAAY,GAAG,aAAa;SAC/B,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC;SACnB,IAAI,EAAE;SACN,IAAI,CAAC,IAAI,CAAC,CAAA;IACb,MAAM,IAAI,KAAK,CAAC,sBAAsB,WAAW,2BAA2B,YAAY,EAAE,CAAC,CAAA;AAC7F,CAAC"}
+{"version":3,"file":"get-framework.js","sourceRoot":"","sources":["../src/get-framework.ts"],"names":[],"mappings":"AACA,OAAO,EAAiB,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAGjE,mEAAmE;AACnE,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,WAA0B,EAAE,OAAgB;IAC7E,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;IAC3E,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,WAAW,CAAC,CAAA;IAEpE,IAAI,SAAS,EAAE;QACb,OAAO,SAAS,CAAA;KACjB;IAED,MAAM,YAAY,GAAG,aAAa;SAC/B,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC;SACnB,IAAI,EAAE;SACN,IAAI,CAAC,IAAI,CAAC,CAAA;IACb,MAAM,IAAI,KAAK,CAAC,sBAAsB,WAAW,2BAA2B,YAAY,EAAE,CAAC,CAAA;AAC7F,CAAC"}

package/lib/node/get-build-info.js

@@ -1,5 +1,3 @@
-import { listFrameworks } from '@netlify/framework-info';
-import { report } from '../metrics.js';
 import { Project } from '../project.js';
 import { NodeFS } from './file-system.js';
 /** A noop logger that is used to not log anything (we use the stdout for parsing the json output) */
@@ -30,19 +28,8 @@ export async function getBuildInfo(config = { featureFlags: {} }) {
         .setEnvironment(process.env)
         .setNodeVersion(process.version);
     const info = {};
-    if (config.featureFlags?.build_info_new_framework_detection) {
-        info.frameworks = (await project.detectFrameworksInPath(project.baseDirectory)) || [];
-    }
-    else {
-        try {
-            // if the framework  detection is crashing we should not crash the build info and package-manager detection
-            info.frameworks = (await listFrameworks({ projectDir: project.baseDirectory }));
-        }
-        catch (error) {
-            report(error, { client: config.bugsnagClient });
-            info.frameworks = [];
-        }
-    }
+    // we are only interested in the frameworks of the base directory here (as they are for this site)
+    info.frameworks = (await project.detectFrameworksInPath(project.baseDirectory)) || [];
     info.settings = await project.getBuildSettings();
     info.langRuntimes = await project.detectRuntime();
     // some framework detection like NX can update the workspace in the project so assign it later on

package/lib/node/get-build-info.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-build-info.js","sourceRoot":"","sources":["../../src/node/get-build-info.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAIxD,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAEtC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAIvC,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAczC,qGAAqG;AACrG,MAAM,OAAO,UAAU;IACrB,KAAK;QACH,WAAW;IACb,CAAC;IACD,GAAG;QACD,WAAW;IACb,CAAC;IACD,KAAK;QACH,WAAW;IACb,CAAC;IACD,IAAI;QACF,WAAW;IACb,CAAC;IACD,IAAI;QACF,WAAW;IACb,CAAC;CACF;AAED,6DAA6D;AAC7D,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,SAKI,EAAE,YAAY,EAAE,EAAE,EAAE;IAExB,MAAM,EAAE,GAAG,IAAI,MAAM,EAAE,CAAA;IACvB,qEAAqE;IACrE,EAAE,CAAC,MAAM,GAAG,IAAI,UAAU,EAAE,CAAA;IAC5B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC;SAC/D,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC;SAChC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC;SAC3B,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAElC,MAAM,IAAI,GAAG,EAAU,CAAA;IAEvB,IAAI,MAAM,CAAC,YAAY,EAAE,kCAAkC,EAAE;QAC3D,IAAI,CAAC,UAAU,GAAG,CAAC,MAAM,OAAO,CAAC,sBAAsB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,IAAI,EAAE,CAAA;KACtF;SAAM;QACL,IAAI;YACF,2GAA2G;YAC3G,IAAI,CAAC,UAAU,GAAG,CAAC,MAAM,cAAc,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,aAAa,EAAE,CAAC,CAAmC,CAAA;SAClH;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE,CAAC,CAAA;YAC/C,IAAI,CAAC,UAAU,GAAG,EAAE,CAAA;SACrB;KACF;IAED,IAAI,CAAC,QAAQ,GAAG,MAAM,OAAO,CAAC,gBAAgB,EAAE,CAAA;IAChD,IAAI,CAAC,YAAY,GAAG,MAAM,OAAO,CAAC,aAAa,EAAE,CAAA;IAEjD,iGAAiG;IACjG,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,SAAS,CAAA;IACrC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAA;IACxC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;IAE5C,OAAO,IAAI,CAAA;AACb,CAAC"}
+{"version":3,"file":"get-build-info.js","sourceRoot":"","sources":["../../src/node/get-build-info.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAIvC,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAczC,qGAAqG;AACrG,MAAM,OAAO,UAAU;IACrB,KAAK;QACH,WAAW;IACb,CAAC;IACD,GAAG;QACD,WAAW;IACb,CAAC;IACD,KAAK;QACH,WAAW;IACb,CAAC;IACD,IAAI;QACF,WAAW;IACb,CAAC;IACD,IAAI;QACF,WAAW;IACb,CAAC;CACF;AAED,6DAA6D;AAC7D,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,SAKI,EAAE,YAAY,EAAE,EAAE,EAAE;IAExB,MAAM,EAAE,GAAG,IAAI,MAAM,EAAE,CAAA;IACvB,qEAAqE;IACrE,EAAE,CAAC,MAAM,GAAG,IAAI,UAAU,EAAE,CAAA;IAC5B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC;SAC/D,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC;SAChC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC;SAC3B,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAElC,MAAM,IAAI,GAAG,EAAU,CAAA;IAEvB,kGAAkG;IAClG,IAAI,CAAC,UAAU,GAAG,CAAC,MAAM,OAAO,CAAC,sBAAsB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,IAAI,EAAE,CAAA;IACrF,IAAI,CAAC,QAAQ,GAAG,MAAM,OAAO,CAAC,gBAAgB,EAAE,CAAA;IAChD,IAAI,CAAC,YAAY,GAAG,MAAM,OAAO,CAAC,aAAa,EAAE,CAAA;IAEjD,iGAAiG;IACjG,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,SAAS,CAAA;IACrC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAA;IACxC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;IAE5C,OAAO,IAAI,CAAA;AACb,CAAC"}

package/package.json

@@ -1,21 +1,21 @@
 {
   "name": "@netlify/build-info",
-  "version": "7.4.0",
+  "version": "7.4.2",
   "description": "Build info utility",
   "type": "module",
   "exports": {
     ".": {
+      "types": "./lib/index.d.ts",
       "import": "./lib/index.js",
-      "default": "./lib/index.js",
-      "types": "./lib/index.d.ts"
+      "browser": "./lib/index.js",
+      "default": "./lib/index.js"
     },
     "./node": {
+      "types": "./lib/node/index.d.ts",
       "import": "./lib/node/index.js",
-      "default": "./lib/node/index.js",
-      "types": "./lib/node/index.d.ts"
+      "default": "./lib/node/index.js"
     }
   },
-  "browser": "./lib/index.js",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "bin": {
@@ -46,8 +46,7 @@
   "author": "Netlify Inc.",
   "dependencies": {
     "@bugsnag/js": "^7.20.0",
-    "@netlify/framework-info": "^9.8.10",
-    "dot-prop": "^8.0.1",
+    "dot-prop": "^7.2.0",
     "find-up": "^6.3.0",
     "minimatch": "^9.0.0",
     "read-pkg": "^7.1.0",
@@ -59,7 +58,7 @@
   "devDependencies": {
     "@bugsnag/source-maps": "^2.3.1",
     "@playwright/test": "^1.30.0",
-    "@types/node": "^18.14.2",
+    "@types/node": "^14.18.53",
     "@types/semver": "^7.3.13",
     "@vitest/coverage-c8": "^0.30.1",
     "@vitest/ui": "^0.30.1",
@@ -74,5 +73,5 @@
   "engines": {
     "node": "^14.16.0 || >=16.0.0"
   },
-  "gitHead": "df378709ce06a7833edf1baa4acb4fac4f964622"
+  "gitHead": "487f1b282fed53beeb3ea17db151a741535ba8fc"
 }