@netlify/build/lib/plugins/error.js

Netlify build module

import { addErrorInfo } from '../error/info.js';
import { logFailPluginWarning } from '../log/messages/plugins.js';
// Stop build.
// As opposed to throwing an error directly or to uncaught exceptions, this is
// displayed as a user error, not an implementation error.
export const failBuild = function (message, opts) {
    throw normalizeError('failBuild', failBuild, message, opts);
};
// Stop plugin. Same as `failBuild` but only stops plugin not whole build
export const failPlugin = function (message, opts) {
    throw normalizeError('failPlugin', failPlugin, message, opts);
};
// Cancel build. Same as `failBuild` except it marks the build as "canceled".
export const cancelBuild = function (message, opts) {
    throw normalizeError('cancelBuild', cancelBuild, message, opts);
};
// `onSuccess`, `onEnd` and `onError` cannot cancel the build since they are run
// or might be run after deployment. When calling `failBuild()` or
// `cancelBuild()`, `failPlugin()` is run instead and a warning is printed.
export const failPluginWithWarning = function (methodName, event, message, opts) {
    logFailPluginWarning(methodName, event);
    failPlugin(message, opts);
};
// An `error` option can be passed to keep the original error message and
// stack trace. An additional `message` string is always required.
const normalizeError = function (type, func, message, { error, errorMetadata } = {}) {
    const errorA = getError(error, message, func);
    addErrorInfo(errorA, { type, errorMetadata });
    return errorA;
};
const getError = function (error, message, func) {
    if (error instanceof Error) {
        // This might fail if `name` is a getter or is non-writable.
        try {
            error.message = `${message}\n${error.message}`;
        }
        catch {
            // continue regardless error
        }
        return error;
    }
    const errorA = new Error(message);
    // Do not include function itself in the stack trace
    Error.captureStackTrace(errorA, func);
    return errorA;
};