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

Netlify build module

import { dirname } from 'path';
import semver from 'semver';
import { addErrorInfo } from '../error/info.js';
import { installLocalPluginsDependencies } from '../install/local.js';
import { measureDuration } from '../time/main.js';
import { ROOT_PACKAGE_JSON } from '../utils/json.js';
import { getPackageJson } from '../utils/package.js';
import { useManifest } from './manifest/main.js';
import { resolvePluginsPath } from './resolve.js';
// Load core plugins and user plugins
const tGetPluginsOptions = async function ({ pluginsOptions, netlifyConfig: { plugins }, siteInfo, buildDir, packagePath, nodePath, packageJson, userNodeVersion, mode, api, logs, debug, sendStatus, testOpts, featureFlags, integrations, context, systemLog, pluginsEnv, }) {
    const pluginsOptionsA = await resolvePluginsPath({
        pluginsOptions,
        siteInfo,
        buildDir,
        nodePath,
        packagePath,
        packageJson,
        userNodeVersion,
        mode,
        api,
        logs,
        debug,
        sendStatus,
        testOpts,
        featureFlags,
        integrations,
        context,
        systemLog,
        pluginsEnv,
    });
    const pluginsOptionsB = await Promise.all(pluginsOptionsA.map((pluginOptions) => loadPluginFiles({ pluginOptions, debug })));
    const pluginsOptionsC = pluginsOptionsB.filter(isNotRedundantCorePlugin);
    await installLocalPluginsDependencies({ plugins, pluginsOptions: pluginsOptionsC, buildDir, mode, logs });
    return { pluginsOptions: pluginsOptionsC };
};
export const getPluginsOptions = measureDuration(tGetPluginsOptions, 'get_plugins_options');
// Retrieve plugin's main file path.
// Then load plugin's `package.json` and `manifest.yml`.
const loadPluginFiles = async function ({ pluginOptions, pluginOptions: { pluginPath, nodeVersion, packageName }, debug, }) {
    const pluginDir = dirname(pluginPath);
    const { packageDir, packageJson: pluginPackageJson } = await getPackageJson(pluginDir);
    // Ensure Node.js version is compatible with plugin's `engines.node`
    const pluginNodeVersionRange = pluginPackageJson?.engines?.node;
    if (pluginNodeVersionRange && !semver.satisfies(nodeVersion, pluginNodeVersionRange)) {
        throwUserError(`The Node.js version is ${nodeVersion} but the plugin "${packageName}" requires ${pluginNodeVersionRange}`);
    }
    const { manifest, inputs } = await useManifest(pluginOptions, { pluginDir, packageDir, pluginPackageJson, debug });
    return { ...pluginOptions, pluginDir, packageDir, pluginPackageJson, manifest, inputs };
};
// Core plugins can only be included once.
// For example, when testing core plugins, they might be included as local plugins,
// in which case they should not be included twice.
const isNotRedundantCorePlugin = function (pluginOptionsA, _index, pluginsOptions) {
    return (pluginOptionsA.loadedFrom !== 'core' ||
        pluginsOptions.every((pluginOptionsB) => pluginOptionsA.manifest.name !== pluginOptionsB.manifest.name || pluginOptionsA === pluginOptionsB));
};
/**
 * Retrieve information about @netlify/build when an error happens there and not
 * in a plugin
 */
export const getSpawnInfo = () => {
    // we know that this package.json has a name as it's ours
    const packageName = ROOT_PACKAGE_JSON.name;
    return {
        plugin: { packageName, pluginPackageJson: ROOT_PACKAGE_JSON },
        location: { event: 'load', packageName, loadedFrom: 'core', origin: 'core' },
    };
};
const throwUserError = function (message) {
    const error = new Error(message);
    addErrorInfo(error, { type: 'resolveConfig' });
    throw error;
};