@netlify/config 18.2.4 → 18.2.5

package/lib/log/options.js

@@ -1,43 +1,29 @@
-import { DEFAULT_FEATURE_FLAGS } from '../options/feature_flags.js'
-import { removeEmptyArray } from '../simplify.js'
-import { removeFalsy } from '../utils/remove_falsy.js'
-
+import { DEFAULT_FEATURE_FLAGS } from '../options/feature_flags.js';
+import { removeEmptyArray } from '../simplify.js';
+import { removeFalsy } from '../utils/remove_falsy.js';
 // Use an allowlist to prevent printing confidential values.
-export const cleanupConfigOpts = function ({
-  config,
-  cwd,
-  context,
-  branch,
-  mode,
-  repositoryRoot,
-  siteId,
-  baseRelDir,
-  env = {},
-  featureFlags = {},
-}) {
-  const envA = Object.keys(env)
-  return removeFalsy({
-    config,
-    cwd,
-    context,
-    branch,
-    mode,
-    repositoryRoot,
-    siteId,
-    baseRelDir,
-    ...removeEmptyArray(envA, 'env'),
-    featureFlags: cleanFeatureFlags(featureFlags),
-  })
-}
-
+export const cleanupConfigOpts = function ({ config, cwd, context, branch, mode, repositoryRoot, siteId, baseRelDir, env = {}, featureFlags = {}, }) {
+    const envA = Object.keys(env);
+    return removeFalsy({
+        config,
+        cwd,
+        context,
+        branch,
+        mode,
+        repositoryRoot,
+        siteId,
+        baseRelDir,
+        ...removeEmptyArray(envA, 'env'),
+        featureFlags: cleanFeatureFlags(featureFlags),
+    });
+};
 // We only show feature flags related to `@netlify/config`.
 // Also, we only print enabled feature flags.
 const cleanFeatureFlags = function (featureFlags) {
-  return Object.entries(featureFlags)
-    .filter(shouldPrintFeatureFlag)
-    .map(([featureFlagName]) => featureFlagName)
-}
-
+    return Object.entries(featureFlags)
+        .filter(shouldPrintFeatureFlag)
+        .map(([featureFlagName]) => featureFlagName);
+};
 const shouldPrintFeatureFlag = function ([featureFlagName, enabled]) {
-  return enabled && featureFlagName in DEFAULT_FEATURE_FLAGS
-}
+    return enabled && featureFlagName in DEFAULT_FEATURE_FLAGS;
+};

package/lib/log/serialize.js

@@ -1,5 +1,4 @@
-import { dump } from 'js-yaml'
-
+import { dump } from 'js-yaml';
 export const serializeObject = function (object) {
-  return dump(object, { noRefs: true, sortKeys: true, lineWidth: Number.POSITIVE_INFINITY }).trimEnd()
-}
+    return dump(object, { noRefs: true, sortKeys: true, lineWidth: Number.POSITIVE_INFINITY }).trimEnd();
+};

package/lib/log/theme.js

@@ -1,14 +1,13 @@
-import chalk from 'chalk'
-
+import chalk from 'chalk';
 // Color theme. Please use this instead of requiring chalk directly, to ensure
 // consistent colors.
 export const THEME = {
-  // Single lines used as subheaders
-  subHeader: chalk.cyan.bold,
-  // Single lines used as subheaders indicating an error
-  errorSubHeader: chalk.red.bold,
-  // Same for warnings
-  warningLine: chalk.yellowBright,
-  // One of several words that should be highlighted inside a line
-  highlightWords: chalk.cyan,
-}
+    // Single lines used as subheaders
+    subHeader: chalk.cyan.bold,
+    // Single lines used as subheaders indicating an error
+    errorSubHeader: chalk.red.bold,
+    // Same for warnings
+    warningLine: chalk.yellowBright,
+    // One of several words that should be highlighted inside a line
+    highlightWords: chalk.cyan,
+};

package/lib/main.js

@@ -1,254 +1,183 @@
-import { getApiClient } from './api/client.js'
-import { getSiteInfo } from './api/site_info.js'
-import { getInitialBase, getBase, addBase } from './base.js'
-import { getBuildDir } from './build_dir.js'
-import { getCachedConfig } from './cached_config.js'
-import { normalizeContextProps, mergeContext } from './context.js'
-import { parseDefaultConfig } from './default.js'
-import { getEnv } from './env/main.js'
-import { resolveConfigPaths } from './files.js'
-import { getHeadersPath, addHeaders } from './headers.js'
-import { getInlineConfig } from './inline_config.js'
-import { logResult } from './log/main.js'
-import { mergeConfigs } from './merge.js'
-import { normalizeBeforeConfigMerge, normalizeAfterConfigMerge } from './merge_normalize.js'
-import { addDefaultOpts, normalizeOpts } from './options/main.js'
-import { UI_ORIGIN, CONFIG_ORIGIN, INLINE_ORIGIN } from './origin.js'
-import { parseConfig } from './parse.js'
-import { getConfigPath } from './path.js'
-import { getRedirectsPath, addRedirects } from './redirects.js'
-
-export { DEV_EVENTS, EVENTS } from './events.js'
-export { cleanupConfig } from './log/cleanup.js'
-// eslint-disable-next-line import/max-dependencies
-export { updateConfig, restoreConfig } from './mutations/update.js'
-
+import { getApiClient } from './api/client.js';
+import { getSiteInfo } from './api/site_info.js';
+import { getInitialBase, getBase, addBase } from './base.js';
+import { getBuildDir } from './build_dir.js';
+import { getCachedConfig } from './cached_config.js';
+import { normalizeContextProps, mergeContext } from './context.js';
+import { parseDefaultConfig } from './default.js';
+import { getEnv } from './env/main.js';
+import { resolveConfigPaths } from './files.js';
+import { getHeadersPath, addHeaders } from './headers.js';
+import { getInlineConfig } from './inline_config.js';
+import { logResult } from './log/main.js';
+import { mergeConfigs } from './merge.js';
+import { normalizeBeforeConfigMerge, normalizeAfterConfigMerge } from './merge_normalize.js';
+import { addDefaultOpts, normalizeOpts } from './options/main.js';
+import { UI_ORIGIN, CONFIG_ORIGIN, INLINE_ORIGIN } from './origin.js';
+import { parseConfig } from './parse.js';
+import { getConfigPath } from './path.js';
+import { getRedirectsPath, addRedirects } from './redirects.js';
+export { DEV_EVENTS, EVENTS } from './events.js';
+export { cleanupConfig } from './log/cleanup.js';
+export { updateConfig, restoreConfig } from './mutations/update.js';
 // Load the configuration file.
 // Takes an optional configuration file path as input and return the resolved
 // `config` together with related properties such as the `configPath`.
 export const resolveConfig = async function (opts) {
-  const { cachedConfig, cachedConfigPath, host, scheme, pathPrefix, testOpts, token, offline, ...optsA } =
-    addDefaultOpts(opts)
-  // `api` is not JSON-serializable, so we cannot cache it inside `cachedConfig`
-  const api = getApiClient({ token, offline, host, scheme, pathPrefix, testOpts })
-
-  const parsedCachedConfig = await getCachedConfig({ cachedConfig, cachedConfigPath, token, api })
-  if (parsedCachedConfig !== undefined) {
-    return parsedCachedConfig
-  }
-
-  const {
-    config: configOpt,
-    defaultConfig,
-    inlineConfig,
-    configMutations,
-    cwd,
-    context,
-    repositoryRoot,
-    base,
-    branch,
-    siteId,
-    deployId,
-    buildId,
-    baseRelDir,
-    mode,
-    debug,
-    logs,
-    featureFlags,
-  } = await normalizeOpts(optsA)
-
-  const { siteInfo, accounts, addons } = await getSiteInfo({ api, siteId, mode, testOpts })
-
-  const { defaultConfig: defaultConfigA, baseRelDir: baseRelDirA } = parseDefaultConfig({
-    defaultConfig,
-    base,
-    baseRelDir,
-    siteInfo,
-    logs,
-    debug,
-  })
-  const inlineConfigA = getInlineConfig({ inlineConfig, configMutations, logs, debug })
-
-  const { configPath, config, buildDir, redirectsPath, headersPath } = await loadConfig({
-    configOpt,
-    cwd,
-    context,
-    repositoryRoot,
-    branch,
-    defaultConfig: defaultConfigA,
-    inlineConfig: inlineConfigA,
-    baseRelDir: baseRelDirA,
-    logs,
-    featureFlags,
-  })
-
-  const env = await getEnv({
-    api,
-    mode,
-    config,
-    siteInfo,
-    accounts,
-    addons,
-    buildDir,
-    branch,
-    deployId,
-    buildId,
-    context,
-  })
-
-  // @todo Remove in the next major version.
-  const configA = addLegacyFunctionsDirectory(config)
-
-  const result = {
-    siteInfo,
-    accounts,
-    addons,
-    env,
-    configPath,
-    redirectsPath,
-    headersPath,
-    buildDir,
-    repositoryRoot,
-    config: configA,
-    context,
-    branch,
-    token,
-    api,
-    logs,
-  }
-  logResult(result, { logs, debug })
-  return result
-}
-
+    const { cachedConfig, cachedConfigPath, host, scheme, pathPrefix, testOpts, token, offline, ...optsA } = addDefaultOpts(opts);
+    // `api` is not JSON-serializable, so we cannot cache it inside `cachedConfig`
+    const api = getApiClient({ token, offline, host, scheme, pathPrefix, testOpts });
+    const parsedCachedConfig = await getCachedConfig({ cachedConfig, cachedConfigPath, token, api });
+    if (parsedCachedConfig !== undefined) {
+        return parsedCachedConfig;
+    }
+    const { config: configOpt, defaultConfig, inlineConfig, configMutations, cwd, context, repositoryRoot, base, branch, siteId, deployId, buildId, baseRelDir, mode, debug, logs, featureFlags, } = await normalizeOpts(optsA);
+    const { siteInfo, accounts, addons } = await getSiteInfo({ api, siteId, mode, testOpts });
+    const { defaultConfig: defaultConfigA, baseRelDir: baseRelDirA } = parseDefaultConfig({
+        defaultConfig,
+        base,
+        baseRelDir,
+        siteInfo,
+        logs,
+        debug,
+    });
+    const inlineConfigA = getInlineConfig({ inlineConfig, configMutations, logs, debug });
+    const { configPath, config, buildDir, redirectsPath, headersPath } = await loadConfig({
+        configOpt,
+        cwd,
+        context,
+        repositoryRoot,
+        branch,
+        defaultConfig: defaultConfigA,
+        inlineConfig: inlineConfigA,
+        baseRelDir: baseRelDirA,
+        logs,
+        featureFlags,
+    });
+    const env = await getEnv({
+        api,
+        mode,
+        config,
+        siteInfo,
+        accounts,
+        addons,
+        buildDir,
+        branch,
+        deployId,
+        buildId,
+        context,
+    });
+    // @todo Remove in the next major version.
+    const configA = addLegacyFunctionsDirectory(config);
+    const result = {
+        siteInfo,
+        accounts,
+        addons,
+        env,
+        configPath,
+        redirectsPath,
+        headersPath,
+        buildDir,
+        repositoryRoot,
+        config: configA,
+        context,
+        branch,
+        token,
+        api,
+        logs,
+    };
+    logResult(result, { logs, debug });
+    return result;
+};
 // Adds a `build.functions` property that mirrors `functionsDirectory`, for
 // backward compatibility.
 const addLegacyFunctionsDirectory = (config) => {
-  if (!config.functionsDirectory) {
-    return config
-  }
-
-  return {
-    ...config,
-    build: {
-      ...config.build,
-      functions: config.functionsDirectory,
-    },
-  }
-}
-
+    if (!config.functionsDirectory) {
+        return config;
+    }
+    return {
+        ...config,
+        build: {
+            ...config.build,
+            functions: config.functionsDirectory,
+        },
+    };
+};
 // Try to load the configuration file in two passes.
 // The first pass uses the `defaultConfig`'s `build.base` (if defined).
 // The second pass uses the `build.base` from the first pass (if defined).
-const loadConfig = async function ({
-  configOpt,
-  cwd,
-  context,
-  repositoryRoot,
-  branch,
-  defaultConfig,
-  inlineConfig,
-  baseRelDir,
-  logs,
-  featureFlags,
-}) {
-  const initialBase = getInitialBase({ repositoryRoot, defaultConfig, inlineConfig })
-  const { configPath, config, buildDir, base, redirectsPath, headersPath } = await getFullConfig({
-    configOpt,
-    cwd,
-    context,
-    repositoryRoot,
-    branch,
-    defaultConfig,
-    inlineConfig,
-    baseRelDir,
-    configBase: initialBase,
-    logs,
-    featureFlags,
-  })
-
-  // No second pass needed if:
-  //  - there is no `build.base` (in which case both `base` and `initialBase`
-  //    are `undefined`)
-  //  - `build.base` is the same as the `Base directory` UI setting (already
-  //    used in the first round)
-  //  - `baseRelDir` feature flag is not used. This feature flag was introduced
-  //    to ensure backward compatibility.
-  if (!baseRelDir || base === initialBase) {
-    return { configPath, config, buildDir, redirectsPath, headersPath }
-  }
-
-  const {
-    configPath: configPathA,
-    config: configA,
-    buildDir: buildDirA,
-    redirectsPath: redirectsPathA,
-    headersPath: headersPathA,
-  } = await getFullConfig({
-    cwd,
-    context,
-    repositoryRoot,
-    branch,
-    defaultConfig,
-    inlineConfig,
-    baseRelDir,
-    configBase: base,
-    base,
-    logs,
-    featureFlags,
-  })
-  return {
-    configPath: configPathA,
-    config: configA,
-    buildDir: buildDirA,
-    redirectsPath: redirectsPathA,
-    headersPath: headersPathA,
-  }
-}
-
+const loadConfig = async function ({ configOpt, cwd, context, repositoryRoot, branch, defaultConfig, inlineConfig, baseRelDir, logs, featureFlags, }) {
+    const initialBase = getInitialBase({ repositoryRoot, defaultConfig, inlineConfig });
+    const { configPath, config, buildDir, base, redirectsPath, headersPath } = await getFullConfig({
+        configOpt,
+        cwd,
+        context,
+        repositoryRoot,
+        branch,
+        defaultConfig,
+        inlineConfig,
+        baseRelDir,
+        configBase: initialBase,
+        logs,
+        featureFlags,
+    });
+    // No second pass needed if:
+    //  - there is no `build.base` (in which case both `base` and `initialBase`
+    //    are `undefined`)
+    //  - `build.base` is the same as the `Base directory` UI setting (already
+    //    used in the first round)
+    //  - `baseRelDir` feature flag is not used. This feature flag was introduced
+    //    to ensure backward compatibility.
+    if (!baseRelDir || base === initialBase) {
+        return { configPath, config, buildDir, redirectsPath, headersPath };
+    }
+    const { configPath: configPathA, config: configA, buildDir: buildDirA, redirectsPath: redirectsPathA, headersPath: headersPathA, } = await getFullConfig({
+        cwd,
+        context,
+        repositoryRoot,
+        branch,
+        defaultConfig,
+        inlineConfig,
+        baseRelDir,
+        configBase: base,
+        base,
+        logs,
+        featureFlags,
+    });
+    return {
+        configPath: configPathA,
+        config: configA,
+        buildDir: buildDirA,
+        redirectsPath: redirectsPathA,
+        headersPath: headersPathA,
+    };
+};
 // Load configuration file and normalize it, merge contexts, etc.
-const getFullConfig = async function ({
-  configOpt,
-  cwd,
-  context,
-  repositoryRoot,
-  branch,
-  defaultConfig,
-  inlineConfig,
-  baseRelDir,
-  configBase,
-  base,
-  logs,
-  featureFlags,
-}) {
-  const configPath = await getConfigPath({ configOpt, cwd, repositoryRoot, configBase })
-
-  try {
-    const config = await parseConfig(configPath)
-    const configA = mergeAndNormalizeConfig({
-      config,
-      defaultConfig,
-      inlineConfig,
-      context,
-      branch,
-      logs,
-    })
-    const {
-      config: configB,
-      buildDir,
-      base: baseA,
-    } = await resolveFiles({ config: configA, repositoryRoot, base, baseRelDir })
-    const headersPath = getHeadersPath(configB)
-    const configC = await addHeaders({ config: configB, headersPath, logs, featureFlags })
-    const redirectsPath = getRedirectsPath(configC)
-    const configD = await addRedirects({ config: configC, redirectsPath, logs, featureFlags })
-    return { configPath, config: configD, buildDir, base: baseA, redirectsPath, headersPath }
-  } catch (error) {
-    const configName = configPath === undefined ? '' : ` file ${configPath}`
-    error.message = `When resolving config${configName}:\n${error.message}`
-    throw error
-  }
-}
-
+const getFullConfig = async function ({ configOpt, cwd, context, repositoryRoot, branch, defaultConfig, inlineConfig, baseRelDir, configBase, base, logs, featureFlags, }) {
+    const configPath = await getConfigPath({ configOpt, cwd, repositoryRoot, configBase });
+    try {
+        const config = await parseConfig(configPath);
+        const configA = mergeAndNormalizeConfig({
+            config,
+            defaultConfig,
+            inlineConfig,
+            context,
+            branch,
+            logs,
+        });
+        const { config: configB, buildDir, base: baseA, } = await resolveFiles({ config: configA, repositoryRoot, base, baseRelDir });
+        const headersPath = getHeadersPath(configB);
+        const configC = await addHeaders({ config: configB, headersPath, logs, featureFlags });
+        const redirectsPath = getRedirectsPath(configC);
+        const configD = await addRedirects({ config: configC, redirectsPath, logs, featureFlags });
+        return { configPath, config: configD, buildDir, base: baseA, redirectsPath, headersPath };
+    }
+    catch (error) {
+        const configName = configPath === undefined ? '' : ` file ${configPath}`;
+        error.message = `When resolving config${configName}:\n${error.message}`;
+        throw error;
+    }
+};
 // Merge:
 //  - `--defaultConfig`: UI build settings and UI-installed plugins
 //  - `inlineConfig`: Netlify CLI flags
@@ -257,29 +186,25 @@ const getFullConfig = async function ({
 // Those need to be done at different stages depending on whether they should
 // happen before/after the merges mentioned above.
 const mergeAndNormalizeConfig = function ({ config, defaultConfig, inlineConfig, context, branch, logs }) {
-  const configA = normalizeConfigAndContext(config, CONFIG_ORIGIN)
-  const defaultConfigA = normalizeConfigAndContext(defaultConfig, UI_ORIGIN)
-  const inlineConfigA = normalizeConfigAndContext(inlineConfig, INLINE_ORIGIN)
-
-  const configB = mergeConfigs([defaultConfigA, configA])
-  const configC = mergeContext({ config: configB, context, branch, logs })
-  const configD = mergeConfigs([configC, inlineConfigA])
-
-  const configE = normalizeAfterConfigMerge(configD)
-  return configE
-}
-
+    const configA = normalizeConfigAndContext(config, CONFIG_ORIGIN);
+    const defaultConfigA = normalizeConfigAndContext(defaultConfig, UI_ORIGIN);
+    const inlineConfigA = normalizeConfigAndContext(inlineConfig, INLINE_ORIGIN);
+    const configB = mergeConfigs([defaultConfigA, configA]);
+    const configC = mergeContext({ config: configB, context, branch, logs });
+    const configD = mergeConfigs([configC, inlineConfigA]);
+    const configE = normalizeAfterConfigMerge(configD);
+    return configE;
+};
 const normalizeConfigAndContext = function (config, origin) {
-  const configA = normalizeBeforeConfigMerge(config, origin)
-  const configB = normalizeContextProps({ config: configA, origin })
-  return configB
-}
-
+    const configA = normalizeBeforeConfigMerge(config, origin);
+    const configB = normalizeContextProps({ config: configA, origin });
+    return configB;
+};
 // Find base directory, build directory and resolve all paths to absolute paths
 const resolveFiles = async function ({ config, repositoryRoot, base, baseRelDir }) {
-  const baseA = getBase(base, repositoryRoot, config)
-  const buildDir = await getBuildDir(repositoryRoot, baseA)
-  const configA = await resolveConfigPaths({ config, repositoryRoot, buildDir, baseRelDir })
-  const configB = addBase(configA, baseA)
-  return { config: configB, buildDir, base: baseA }
-}
+    const baseA = getBase(base, repositoryRoot, config);
+    const buildDir = await getBuildDir(repositoryRoot, baseA);
+    const configA = await resolveConfigPaths({ config, repositoryRoot, buildDir, baseRelDir });
+    const configB = addBase(configA, baseA);
+    return { config: configB, buildDir, base: baseA };
+};

package/lib/merge.js

@@ -1,53 +1,43 @@
-import deepmerge from 'deepmerge'
-import isPlainObj from 'is-plain-obj'
-
-import { groupBy } from './utils/group.js'
-import { removeUndefined } from './utils/remove_falsy.js'
-
+import deepmerge from 'deepmerge';
+import isPlainObj from 'is-plain-obj';
+import { groupBy } from './utils/group.js';
+import { removeUndefined } from './utils/remove_falsy.js';
 // Merge an array of configuration objects.
 // Last items have higher priority.
 // Configuration objects are deeply merged.
 //   - Arrays are overridden, not concatenated.
 export const mergeConfigs = function (configs) {
-  const cleanedConfigs = configs.map(removeUndefinedProps)
-  return deepmerge.all(cleanedConfigs, { arrayMerge })
-}
-
+    const cleanedConfigs = configs.map(removeUndefinedProps);
+    return deepmerge.all(cleanedConfigs, { arrayMerge });
+};
 const removeUndefinedProps = function ({ build = {}, ...config }) {
-  return removeUndefined({ ...config, build: removeUndefined(build) })
-}
-
+    return removeUndefined({ ...config, build: removeUndefined(build) });
+};
 // By default `deepmerge` concatenates arrays. We use the `arrayMerge` option
 // to remove this behavior. Also, we merge some array properties differently,
 // such as `plugins`.
 const arrayMerge = function (arrayA, arrayB) {
-  if (isPluginsProperty(arrayA) && isPluginsProperty(arrayB)) {
-    return mergePlugins(arrayA, arrayB)
-  }
-
-  return arrayB
-}
-
+    if (isPluginsProperty(arrayA) && isPluginsProperty(arrayB)) {
+        return mergePlugins(arrayA, arrayB);
+    }
+    return arrayB;
+};
 // `deepmerge` does not allow retrieving the name of the array property being
 // merged, so we need to do some heuristics.
 const isPluginsProperty = function (array) {
-  return Array.isArray(array) && array.every(isPluginObject)
-}
-
+    return Array.isArray(array) && array.every(isPluginObject);
+};
 const isPluginObject = function (object) {
-  return isPlainObj(object) && typeof object.package === 'string'
-}
-
+    return isPlainObj(object) && typeof object.package === 'string';
+};
 // Merge two `config.plugins`. Merge plugins with the same `plugin.package`.
 const mergePlugins = function (pluginsA, pluginsB) {
-  const plugins = [...pluginsA, ...pluginsB]
-  return groupBy(plugins, 'package').map(mergePluginConfigs)
-}
-
+    const plugins = [...pluginsA, ...pluginsB];
+    return groupBy(plugins, 'package').map(mergePluginConfigs);
+};
 const mergePluginConfigs = function (plugins) {
-  return plugins.reduce(mergePluginsPair, {})
-}
-
+    return plugins.reduce(mergePluginsPair, {});
+};
 const mergePluginsPair = function (pluginA, pluginB) {
-  return deepmerge(pluginA, pluginB, { arrayMerge })
-}
+    return deepmerge(pluginA, pluginB, { arrayMerge });
+};