@netlify/build 28.0.0 → 28.0.1

package/lib/core/main.js

@@ -10,25 +10,7 @@ export { runCoreSteps } from '../steps/run_core_steps.js';
  * Main entry point of Netlify Build.
  * Runs a builds and returns whether it succeeded or not.
  *
- * @param  {object} [flags] - build configuration CLI flags
- * @param  {string} [flags.config] - Path to the configuration file
- * @param  {string} [flags.cwd] - Current directory. Used to retrieve the configuration file
- * @param  {string} [flags.repositoryRoot] - Git repository root directory. Used to retrieve the configuration file.
- * @param  {string} [flags.apiHost] - Netlify API endpoint
- * @param  {string} [flags.token] - Netlify API token for authentication
- * @param  {string} [flags.siteId] - Netlify Site ID
- * @param  {string} [flags.deployId] - Netlify Deploy ID
- * @param  {string} [flags.context] - Build context
- * @param  {string} [flags.branch] - Repository branch
- * @param  {boolean} [flags.dry=false] - Run in dry mode, i.e. printing steps without executing them
- * @param  {string} [flags.nodePath] - Path to the Node.js binary to use in the build command and plugins
- * @param  {boolean} [flags.buffer=false] - Buffer output instead of printing it
- *
- * @returns {object} buildResult
- * @returns {boolean} buildResult.success - Whether build succeeded or failed
- * @returns {number} buildResult.severityCode - Build success/failure status among:
- * 0 (success), 1 (build cancelled), 2 (user error), 3 (plugin error), 4 (system error). Can be used as exit code.
- * @returns {string[]} buildResult.logs - When using the `buffer` option, all log messages
+ * @param flags - build configuration CLI flags
  */
 export default async function buildSite(flags = {}) {
     const { errorMonitor, framework, mode, logs, debug, systemLogFile, testOpts, statsdOpts, dry, telemetry, buildId, deployId, ...flagsA } = startBuild(flags);

package/lib/core/severity.js

@@ -1,11 +1,3 @@
-// Used to extract exit codes and respective status strings
-// 1|2|3 indicate whether this was a user|plugin|system error.
-export const getSeverity = function (severity = FALLBACK_SEVERITY) {
-    const severityEntry = severity in SEVERITY_MAP ? SEVERITY_MAP[severity] : FALLBACK_SEVERITY_ENTRY;
-    const success = severity === SUCCESS_SEVERITY;
-    return { success, ...severityEntry };
-};
-// Map error severities to exit codes and status (used for telemetry purposes)
 const SEVERITY_MAP = {
     success: { severityCode: 0, status: 'success' },
     none: { severityCode: 1, status: 'cancelled' },
@@ -13,8 +5,17 @@ const SEVERITY_MAP = {
     warning: { severityCode: 3, status: 'plugin-error' },
     error: { severityCode: 4, status: 'system-error' },
 };
-/* eslint-enable no-magic-numbers */
 const SUCCESS_SEVERITY = 'success';
-// Indicates a bug in our codebase
+/** Indicates a bug in our codebase */
 const FALLBACK_SEVERITY = 'error';
+/** Map error severities to exit codes and status (used for telemetry purposes) */
 export const FALLBACK_SEVERITY_ENTRY = SEVERITY_MAP[FALLBACK_SEVERITY];
+/**
+ * Used to extract exit codes and respective status strings
+ * 1|2|3 indicate whether this was a user|plugin|system error.
+ */
+export const getSeverity = (severity = FALLBACK_SEVERITY) => {
+    const severityEntry = severity in SEVERITY_MAP ? SEVERITY_MAP[severity] : FALLBACK_SEVERITY_ENTRY;
+    const success = severity === SUCCESS_SEVERITY;
+    return { success, ...severityEntry };
+};

package/lib/core/types.js

@@ -0,0 +1,8 @@
+export var SeverityCode;
+(function (SeverityCode) {
+    SeverityCode[SeverityCode["success"] = 1] = "success";
+    SeverityCode[SeverityCode["buildCancelled"] = 2] = "buildCancelled";
+    SeverityCode[SeverityCode["userError"] = 3] = "userError";
+    SeverityCode[SeverityCode["pluginError"] = 4] = "pluginError";
+    SeverityCode[SeverityCode["systemError"] = 5] = "systemError";
+})(SeverityCode = SeverityCode || (SeverityCode = {}));

package/lib/error/monitor/start.js

@@ -5,7 +5,8 @@ import { log } from '../../log/logger.js';
 import { ROOT_PACKAGE_JSON } from '../../utils/json.js';
 const projectRoot = fileURLToPath(new URL('../../..', import.meta.url));
 // Start a client to monitor errors
-export const startErrorMonitor = function ({ flags: { mode }, logs, bugsnagKey }) {
+export const startErrorMonitor = function (config) {
+    const { flags: { mode }, logs, bugsnagKey, } = config;
     if (!bugsnagKey) {
         return;
     }
@@ -39,6 +40,8 @@ const BUGSNAG_TEST_KEY = '00000000000000000000000000000000';
 // Bugsnag.start() caches a global instance and warns on duplicate calls.
 // This ensures the warning message is not shown when calling the main function
 // several times.
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
 const startBugsnag = memoizeOne(Bugsnag.start.bind(Bugsnag), () => true);
 // Based the release stage on the `mode`
 const getReleaseStage = function (mode = DEFAULT_RELEASE_STAGE) {

package/lib/log/logger.js

@@ -4,9 +4,19 @@ import indentString from 'indent-string';
 import { getHeader } from './header.js';
 import { serializeObject, serializeArray } from './serialize.js';
 import { THEME } from './theme.js';
-// When the `buffer` option is true, we return logs instead of printing them
-// on the console. The logs are accumulated in a `logs` array variable.
-export const getBufferLogs = function ({ buffer = false }) {
+const INDENT_SIZE = 2;
+/**
+ * We need to add a zero width space character in empty lines. Otherwise the
+ * buildbot removes those due to a bug: https://github.com/netlify/buildbot/issues/595
+ */
+const EMPTY_LINES_REGEXP = /^\s*$/gm;
+const EMPTY_LINE = '\u{200B}';
+/**
+ * When the `buffer` option is true, we return logs instead of printing them
+ * on the console. The logs are accumulated in a `logs` array variable.
+ */
+export const getBufferLogs = (config) => {
+    const { buffer = false } = config;
     if (!buffer) {
         return;
     }
@@ -15,7 +25,8 @@ export const getBufferLogs = function ({ buffer = false }) {
 // Core logging utility, used by the other methods.
 // This should be used instead of `console.log()` as it allows us to instrument
 // how any build logs is being printed.
-export const log = function (logs, string, { indent = false, color } = {}) {
+export const log = function (logs, string, config = {}) {
+    const { indent = false, color } = config;
     const stringA = indent ? indentString(string, INDENT_SIZE) : string;
     const stringB = String(stringA).replace(EMPTY_LINES_REGEXP, EMPTY_LINE);
     const stringC = color === undefined ? stringB : color(stringB);
@@ -26,25 +37,20 @@ export const log = function (logs, string, { indent = false, color } = {}) {
     }
     console.log(stringC);
 };
-const INDENT_SIZE = 2;
-// We need to add a zero width space character in empty lines. Otherwise the
-// buildbot removes those due to a bug: https://github.com/netlify/buildbot/issues/595
-const EMPTY_LINES_REGEXP = /^\s*$/gm;
-const EMPTY_LINE = '\u{200B}';
 const serializeIndentedArray = function (array) {
     return serializeArray(array.map(serializeIndentedItem));
 };
 const serializeIndentedItem = function (item) {
     return indentString(item, INDENT_SIZE + 1).trimStart();
 };
-export const logError = function (logs, string, opts) {
+export const logError = function (logs, string, opts = {}) {
     log(logs, string, { color: THEME.errorLine, ...opts });
 };
-export const logWarning = function (logs, string, opts) {
+export const logWarning = function (logs, string, opts = {}) {
     log(logs, string, { color: THEME.warningLine, ...opts });
 };
 // Print a message that is under a header/subheader, i.e. indented
-export const logMessage = function (logs, string, opts) {
+export const logMessage = function (logs, string, opts = {}) {
     log(logs, string, { indent: true, ...opts });
 };
 // Print an object
@@ -52,35 +58,35 @@ export const logObject = function (logs, object, opts) {
     logMessage(logs, serializeObject(object), opts);
 };
 // Print an array
-export const logArray = function (logs, array, opts) {
+export const logArray = function (logs, array, opts = {}) {
     logMessage(logs, serializeIndentedArray(array), { color: THEME.none, ...opts });
 };
 // Print an array of errors
-export const logErrorArray = function (logs, array, opts) {
+export const logErrorArray = function (logs, array, opts = {}) {
     logMessage(logs, serializeIndentedArray(array), { color: THEME.errorLine, ...opts });
 };
 // Print an array of warnings
-export const logWarningArray = function (logs, array, opts) {
+export const logWarningArray = function (logs, array, opts = {}) {
     logMessage(logs, serializeIndentedArray(array), { color: THEME.warningLine, ...opts });
 };
 // Print a main section header
-export const logHeader = function (logs, string, opts) {
+export const logHeader = function (logs, string, opts = {}) {
     log(logs, `\n${getHeader(string)}`, { color: THEME.header, ...opts });
 };
 // Print a main section header, when an error happened
-export const logErrorHeader = function (logs, string, opts) {
+export const logErrorHeader = function (logs, string, opts = {}) {
     logHeader(logs, string, { color: THEME.errorHeader, ...opts });
 };
 // Print a sub-section header
-export const logSubHeader = function (logs, string, opts) {
+export const logSubHeader = function (logs, string, opts = {}) {
     log(logs, `\n${figures.pointer} ${string}`, { color: THEME.subHeader, ...opts });
 };
 // Print a sub-section header, when an error happened
-export const logErrorSubHeader = function (logs, string, opts) {
+export const logErrorSubHeader = function (logs, string, opts = {}) {
     logSubHeader(logs, string, { color: THEME.errorSubHeader, ...opts });
 };
 // Print a sub-section header, when a warning happened
-export const logWarningSubHeader = function (logs, string, opts) {
+export const logWarningSubHeader = function (logs, string, opts = {}) {
     logSubHeader(logs, string, { color: THEME.warningSubHeader, ...opts });
 };
 // Combines an array of elements into a single string, separated by a space,
@@ -105,9 +111,13 @@ const reduceLogLines = function (lines) {
     })
         .join(' ');
 };
-// Builds a function for logging data to the system logger (i.e. hidden from
-// the user-facing build logs)
-export const getSystemLogger = function (logs, debug, systemLogFile) {
+/**
+ * Builds a function for logging data to the system logger (i.e. hidden from
+ * the user-facing build logs)
+ */
+export const getSystemLogger = function (logs, debug, 
+/** A system log file descriptor, if non is provided it will be a noop logger */
+systemLogFile) {
     // If the `debug` flag is used, we return a function that pipes system logs
     // to the regular logger, as the intention is for them to end up in stdout.
     if (debug) {

package/lib/steps/run_core_steps.js

@@ -12,27 +12,6 @@ import { getSteps } from './get.js';
 import { runSteps } from './run_steps.js';
 /**
  * Runs specific core steps for a build and returns whether it succeeded or not.
- *
- * @param  {string[]} [buildSteps] - a string array of build steps to run
- * @param  {object} [flags] - build configuration CLI flags
- * @param  {string} [flags.config] - Path to the configuration file
- * @param  {string} [flags.cwd] - Current directory. Used to retrieve the configuration file
- * @param  {string} [flags.repositoryRoot] - Git repository root directory. Used to retrieve the configuration file.
- * @param  {string} [flags.apiHost] - Netlify API endpoint
- * @param  {string} [flags.token] - Netlify API token for authentication
- * @param  {string} [flags.siteId] - Netlify Site ID
- * @param  {string} [flags.deployId] - Netlify Deploy ID
- * @param  {string} [flags.context] - Build context
- * @param  {string} [flags.branch] - Repository branch
- * @param  {boolean} [flags.dry=false] - Run in dry mode, i.e. printing steps without executing them
- * @param  {string} [flags.nodePath] - Path to the Node.js binary to use in the build command and plugins
- * @param  {boolean} [flags.buffer=false] - Buffer output instead of printing it
- *
- * @returns {object} buildResult
- * @returns {boolean} buildResult.success - Whether build succeeded or failed
- * @returns {number} buildResult.severityCode - Build success/failure status among:
- * 0 (success), 1 (build cancelled), 2 (user error), 3 (plugin error), 4 (system error). Can be used as exit code.
- * @returns {string[]} buildResult.logs - When using the `buffer` option, all log messages
  */
 export const runCoreSteps = async (buildSteps, flags = {}) => {
     const { errorMonitor, mode, logs, debug, ...flagsA } = startBuild(flags);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "28.0.0",
+  "version": "28.0.1",
   "description": "Netlify build module",
   "type": "module",
   "exports": "./lib/core/main.js",
@@ -26,6 +26,7 @@
     "build": "tsc",
     "pretest": "tsd .",
     "test": "ava",
+    "test:dev": "ava -w",
     "test:ci": "c8 -r lcovonly -r text -r json ava",
     "test:measure": "../../tools/tests-duration.js"
   },
@@ -63,13 +64,13 @@
   "license": "MIT",
   "dependencies": {
     "@bugsnag/js": "^7.0.0",
-    "@netlify/cache-utils": "^5.0.0",
-    "@netlify/config": "^19.0.0",
-    "@netlify/edge-bundler": "^2.7.0",
-    "@netlify/functions-utils": "^5.0.0",
-    "@netlify/git-utils": "^5.0.0",
-    "@netlify/plugins-list": "^6.49.1",
-    "@netlify/run-utils": "^5.0.0",
+    "@netlify/cache-utils": "^5.0.1",
+    "@netlify/config": "^19.0.1",
+    "@netlify/edge-bundler": "^2.8.0",
+    "@netlify/functions-utils": "^5.0.1",
+    "@netlify/git-utils": "^5.0.1",
+    "@netlify/plugins-list": "^6.50.0",
+    "@netlify/run-utils": "^5.0.1",
     "@netlify/zip-it-and-ship-it": "^7.1.2",
     "@sindresorhus/slugify": "^2.0.0",
     "ajv": "^8.11.0",
@@ -149,5 +150,5 @@
       "module": "commonjs"
     }
   },
-  "gitHead": "c4502f1c112e7f33d5e6fa053bfbe7dabdfe0160"
+  "gitHead": "701e883d4e19c048e8de9801e49e21de5c891a18"
 }