@netlify/build-info 3.0.0 → 4.0.2

package/README.md

@@ -7,6 +7,7 @@ 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)
 
@@ -14,51 +15,50 @@ But it's possible to extend it in the future to extract other bits of informatio
 [`build-image`](https://github.com/netlify/build-image/blob/xenial/run-build-functions.sh#L214).
 
 # Example (Node.js)
+
 ```js
-const { getBuildInfo } = require('./src/main')
+import { getBuildInfo } from '@netlify/build-info'
 
-(async () => {
-  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: '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: []
-  // }
-})();
+console.log(await getBuildInfo({ projectDir: '/project/root/dir' }))
+// {
+//   jsWorkspaces: {
+//     isRoot: true,
+//     packages: [
+//       'path/to/site',
+//       'path/to/component/library'
+//       'path/to/utility/library'
+//     ]
+//   },
+//   frameworks: []
+// }
 ```
 
 # Example (CLI)
@@ -106,7 +106,6 @@ $ build-info path/to/site --rootDir /project/root/dir
 }
 ```
 
-
 ## Contributors
 
 Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on how to set up and work on this repository. Thanks

package/package.json

@@ -1,7 +1,9 @@
 {
   "name": "@netlify/build-info",
-  "version": "3.0.0",
+  "version": "4.0.2",
   "description": "Build info utility",
+  "type": "module",
+  "exports": "./src/main.js",
   "main": "./src/main.js",
   "bin": {
     "build-info": "./src/bin.js"
@@ -27,8 +29,8 @@
     "test:ci:ava": "nyc -r lcovonly -r text -r json ava"
   },
   "config": {
-    "eslint": "--ignore-path .gitignore --cache --format=codeframe --max-warnings=0 \"{src,scripts,.github}/**/*.{js,md,html}\" \"*.{js,md,html}\" \".*.{js,md,html}\"",
-    "prettier": "--ignore-path .gitignore --loglevel=warn \"{src,scripts,.github}/**/*.{js,md,yml,json,html}\" \"*.{js,yml,json,html}\" \".*.{js,yml,json,html}\" \"!**/package-lock.json\" \"!package-lock.json\""
+    "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,
@@ -53,9 +55,9 @@
     "test": "test"
   },
   "devDependencies": {
-    "@commitlint/cli": "^14.0.0",
-    "@commitlint/config-conventional": "^14.0.0",
-    "@netlify/eslint-config-node": "^3.3.8",
+    "@commitlint/cli": "^15.0.0",
+    "@commitlint/config-conventional": "^15.0.0",
+    "@netlify/eslint-config-node": "^4.0.0",
     "ava": "^3.0.0",
     "execa": "^5.0.0",
     "get-bin-path": "^5.0.0",
@@ -66,9 +68,9 @@
     "node": "^12.20.0 || ^14.14.0 || >=16.0.0"
   },
   "dependencies": {
-    "@netlify/framework-info": "^5.11.0",
+    "@netlify/framework-info": "^7.0.0",
     "@npmcli/map-workspaces": "^1.0.3",
     "read-pkg": "^5.2.0",
-    "yargs": "^16.0.0"
+    "yargs": "^17.0.0"
   }
 }

package/src/bin.js

@@ -1,9 +1,10 @@
 #!/usr/bin/env node
-const { exit } = require('process')
+import { exit, argv } from 'process'
 
-const yargs = require('yargs')
+import yargs from 'yargs'
+import { hideBin } from 'yargs/helpers'
 
-const { getBuildInfo } = require('./main')
+import { getBuildInfo } from './main.js'
 
 // CLI entry point
 const runCli = async function () {
@@ -19,7 +20,7 @@ const runCli = async function () {
 }
 
 const parseArgs = function () {
-  return yargs.command('* [projectDir]').options(OPTIONS).usage(USAGE).strict().parse()
+  return yargs(hideBin(argv)).command('* [projectDir]').options(OPTIONS).usage(USAGE).strict().parse()
 }
 
 const OPTIONS = {

package/src/context.js

@@ -1,7 +1,7 @@
-const { resolve } = require('path')
-const { cwd } = require('process')
+import { resolve } from 'path'
+import { cwd } from 'process'
 
-const readPkg = require('read-pkg')
+import readPkg from 'read-pkg'
 
 const getPackageJson = async function (dir) {
   try {
@@ -16,7 +16,7 @@ const getPackageJson = async function (dir) {
   }
 }
 
-const getContext = async function ({ projectDir = cwd(), rootDir = '' } = {}) {
+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)
@@ -37,5 +37,3 @@ const getContext = async function ({ projectDir = cwd(), rootDir = '' } = {}) {
     rootPackageJson,
   }
 }
-
-module.exports = { getContext }

package/src/core.js

@@ -1,13 +1,11 @@
 'use strict'
 
-const { getFrameworks } = require('./frameworks')
-const { getWorkspaceInfo } = require('./workspaces')
+import { getFrameworks } from './frameworks.js'
+import { getWorkspaceInfo } from './workspaces.js'
 
-const buildInfo = async function (context) {
+export const buildInfo = async function (context) {
   const workspaceInfo = await getWorkspaceInfo(context)
   const jsWorkspaces = workspaceInfo ? { jsWorkspaces: workspaceInfo } : {}
   const frameworks = await getFrameworks(context)
   return { ...jsWorkspaces, frameworks }
 }
-
-module.exports = { buildInfo }

package/src/frameworks.js

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

package/src/main.js

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

package/src/workspaces.js

@@ -1,8 +1,8 @@
 'use strict'
 
-const mapWorkspaces = require('@npmcli/map-workspaces')
+import mapWorkspaces from '@npmcli/map-workspaces'
 
-const getWorkspaceInfo = async function ({ rootPackageJson, projectDir, rootDir }) {
+export const getWorkspaceInfo = async function ({ rootPackageJson, projectDir, rootDir }) {
   if (!rootPackageJson.workspaces) {
     return
   }
@@ -23,5 +23,3 @@ const getWorkspaceInfo = async function ({ rootPackageJson, projectDir, rootDir
     return { isRoot, packages }
   }
 }
-
-module.exports = { getWorkspaceInfo }