@netlify/config 18.2.4 → 18.2.5

package/lib/functions_config.js

@@ -1,23 +1,16 @@
-import isPlainObj from 'is-plain-obj'
-
-import { isDefined } from './utils/remove_falsy.js'
-
-export const bundlers = ['esbuild', 'nft', 'zisi']
-export const WILDCARD_ALL = '*'
-
+import isPlainObj from 'is-plain-obj';
+import { isDefined } from './utils/remove_falsy.js';
+export const bundlers = ['esbuild', 'nft', 'zisi'];
+export const WILDCARD_ALL = '*';
 // Removing the legacy `functions` from the `build` block.
 // Looking for a default directory in the `functions` block, separating it
 // from the rest of the configuration if it exists.
-export const normalizeFunctionsProps = function (
-  { functions: v1FunctionsDirectory, ...build },
-  { [WILDCARD_ALL]: wildcardProps, ...functions },
-) {
-  const functionsA = Object.entries(functions).reduce(normalizeFunctionsProp, { [WILDCARD_ALL]: wildcardProps })
-  const { directory: functionsDirectory, functions: functionsB } = extractFunctionsDirectory(functionsA)
-  const functionsDirectoryProps = getFunctionsDirectoryProps({ functionsDirectory, v1FunctionsDirectory })
-  return { build, functions: functionsB, functionsDirectoryProps }
-}
-
+export const normalizeFunctionsProps = function ({ functions: v1FunctionsDirectory, ...build }, { [WILDCARD_ALL]: wildcardProps, ...functions }) {
+    const functionsA = Object.entries(functions).reduce(normalizeFunctionsProp, { [WILDCARD_ALL]: wildcardProps });
+    const { directory: functionsDirectory, functions: functionsB } = extractFunctionsDirectory(functionsA);
+    const functionsDirectoryProps = getFunctionsDirectoryProps({ functionsDirectory, v1FunctionsDirectory });
+    return { build, functions: functionsB, functionsDirectoryProps };
+};
 // Normalizes a functions configuration object, so that the first level of keys
 // represents function expressions mapped to a configuration object.
 //
@@ -37,47 +30,38 @@ export const normalizeFunctionsProps = function (
 // that to be the case if the value is an object where all keys are also
 // config properties. If not, it's simply a function with the same name
 // as one of the config properties.
-const normalizeFunctionsProp = (functions, [propName, propValue]) =>
-  isConfigProperty(propName) && !isConfigLeaf(propValue)
+const normalizeFunctionsProp = (functions, [propName, propValue]) => isConfigProperty(propName) && !isConfigLeaf(propValue)
     ? { ...functions, [WILDCARD_ALL]: { [propName]: propValue, ...functions[WILDCARD_ALL] } }
-    : { ...functions, [propName]: propValue }
-
-const isConfigLeaf = (functionConfig) =>
-  isPlainObj(functionConfig) && Object.keys(functionConfig).every(isConfigProperty)
-
-const isConfigProperty = (propName) => FUNCTION_CONFIG_PROPERTIES.has(propName)
-
+    : { ...functions, [propName]: propValue };
+const isConfigLeaf = (functionConfig) => isPlainObj(functionConfig) && Object.keys(functionConfig).every(isConfigProperty);
+const isConfigProperty = (propName) => FUNCTION_CONFIG_PROPERTIES.has(propName);
 export const FUNCTION_CONFIG_PROPERTIES = new Set([
-  'directory',
-  'external_node_modules',
-  'ignored_node_modules',
-  'included_files',
-  'node_bundler',
-  'schedule',
-])
-
+    'directory',
+    'external_node_modules',
+    'ignored_node_modules',
+    'included_files',
+    'node_bundler',
+    'schedule',
+]);
 // Takes a functions configuration object and looks for the functions directory
 // definition, returning it under the `directory` key. The rest of the config
 // object is returned under the `functions` key.
 const extractFunctionsDirectory = ({ [WILDCARD_ALL]: { directory, ...wildcardFunctionsConfig }, ...functions }) => ({
-  directory,
-  functions: { ...functions, [WILDCARD_ALL]: wildcardFunctionsConfig },
-})
-
+    directory,
+    functions: { ...functions, [WILDCARD_ALL]: wildcardFunctionsConfig },
+});
 const getFunctionsDirectoryProps = ({ functionsDirectory, v1FunctionsDirectory }) => {
-  if (isDefined(functionsDirectory)) {
-    return {
-      functionsDirectory,
-      functionsDirectoryOrigin: 'config',
+    if (isDefined(functionsDirectory)) {
+        return {
+            functionsDirectory,
+            functionsDirectoryOrigin: 'config',
+        };
     }
-  }
-
-  if (isDefined(v1FunctionsDirectory)) {
-    return {
-      functionsDirectory: v1FunctionsDirectory,
-      functionsDirectoryOrigin: 'config-v1',
+    if (isDefined(v1FunctionsDirectory)) {
+        return {
+            functionsDirectory: v1FunctionsDirectory,
+            functionsDirectoryOrigin: 'config-v1',
+        };
     }
-  }
-
-  return {}
-}
+    return {};
+};

package/lib/headers.js

@@ -1,30 +1,20 @@
-import { resolve } from 'path'
-
-import { parseAllHeaders } from 'netlify-headers-parser'
-
-import { warnHeadersParsing, warnHeadersCaseSensitivity } from './log/messages.js'
-
+import { resolve } from 'path';
+import { parseAllHeaders } from 'netlify-headers-parser';
+import { warnHeadersParsing, warnHeadersCaseSensitivity } from './log/messages.js';
 // Retrieve path to `_headers` file (even if it does not exist yet)
 export const getHeadersPath = function ({ build: { publish } }) {
-  return resolve(publish, HEADERS_FILENAME)
-}
-
-const HEADERS_FILENAME = '_headers'
-
+    return resolve(publish, HEADERS_FILENAME);
+};
+const HEADERS_FILENAME = '_headers';
 // Add `config.headers`
-export const addHeaders = async function ({
-  config: { headers: configHeaders, ...config },
-  headersPath,
-  logs,
-  featureFlags,
-}) {
-  const { headers, errors } = await parseAllHeaders({
-    headersFiles: [headersPath],
-    configHeaders,
-    minimal: true,
-    featureFlags,
-  })
-  warnHeadersParsing(logs, errors)
-  warnHeadersCaseSensitivity(logs, headers)
-  return { ...config, headers }
-}
+export const addHeaders = async function ({ config: { headers: configHeaders, ...config }, headersPath, logs, featureFlags, }) {
+    const { headers, errors } = await parseAllHeaders({
+        headersFiles: [headersPath],
+        configHeaders,
+        minimal: true,
+        featureFlags,
+    });
+    warnHeadersParsing(logs, errors);
+    warnHeadersCaseSensitivity(logs, headers);
+    return { ...config, headers };
+};

package/lib/inline_config.js

@@ -1,9 +1,8 @@
-import { logInlineConfig } from './log/main.js'
-import { applyMutations } from './mutations/apply.js'
-
+import { logInlineConfig } from './log/main.js';
+import { applyMutations } from './mutations/apply.js';
 // Retrieve the `--inlineConfig` CLI flag
 export const getInlineConfig = function ({ inlineConfig, configMutations, logs, debug }) {
-  const mutatedInlineConfig = applyMutations(inlineConfig, configMutations)
-  logInlineConfig(mutatedInlineConfig, { logs, debug })
-  return mutatedInlineConfig
-}
+    const mutatedInlineConfig = applyMutations(inlineConfig, configMutations);
+    logInlineConfig(mutatedInlineConfig, { logs, debug });
+    return mutatedInlineConfig;
+};

package/lib/log/cleanup.js

@@ -1,92 +1,64 @@
-import filterObj from 'filter-obj'
-
-import { simplifyConfig } from '../simplify.js'
-
+import filterObj from 'filter-obj';
+import { simplifyConfig } from '../simplify.js';
 // Make sure we are not printing secret values. Use an allow list.
-export const cleanupConfig = function ({
-  build: {
-    base,
-    command,
-    commandOrigin,
-    environment = {},
-    edge_functions: edgeFunctions,
-    ignore,
-    processing,
-    publish,
-    publishOrigin,
-  } = {},
-  headers,
-  headersOrigin,
-  plugins = [],
-  redirects,
-  redirectsOrigin,
-  baseRelDir,
-  functions,
-  functionsDirectory,
-}) {
-  const environmentA = cleanupEnvironment(environment)
-  const build = {
-    base,
-    command,
-    commandOrigin,
-    environment: environmentA,
-    edge_functions: edgeFunctions,
-    ignore,
-    processing,
-    publish,
-    publishOrigin,
-  }
-  const pluginsA = plugins.map(cleanupPlugin)
-  const netlifyConfig = simplifyConfig({
-    build,
-    plugins: pluginsA,
-    headers,
-    headersOrigin,
-    redirects,
-    redirectsOrigin,
-    baseRelDir,
-    functions,
-    functionsDirectory,
-  })
-  const netlifyConfigA = truncateArray(netlifyConfig, 'headers')
-  const netlifyConfigB = truncateArray(netlifyConfigA, 'redirects')
-  return netlifyConfigB
-}
-
+export const cleanupConfig = function ({ build: { base, command, commandOrigin, environment = {}, edge_functions: edgeFunctions, ignore, processing, publish, publishOrigin, } = {}, headers, headersOrigin, plugins = [], redirects, redirectsOrigin, baseRelDir, functions, functionsDirectory, }) {
+    const environmentA = cleanupEnvironment(environment);
+    const build = {
+        base,
+        command,
+        commandOrigin,
+        environment: environmentA,
+        edge_functions: edgeFunctions,
+        ignore,
+        processing,
+        publish,
+        publishOrigin,
+    };
+    const pluginsA = plugins.map(cleanupPlugin);
+    const netlifyConfig = simplifyConfig({
+        build,
+        plugins: pluginsA,
+        headers,
+        headersOrigin,
+        redirects,
+        redirectsOrigin,
+        baseRelDir,
+        functions,
+        functionsDirectory,
+    });
+    const netlifyConfigA = truncateArray(netlifyConfig, 'headers');
+    const netlifyConfigB = truncateArray(netlifyConfigA, 'redirects');
+    return netlifyConfigB;
+};
 export const cleanupEnvironment = function (environment) {
-  return Object.keys(environment).filter((key) => !BUILDBOT_ENVIRONMENT.has(key))
-}
-
+    return Object.keys(environment).filter((key) => !BUILDBOT_ENVIRONMENT.has(key));
+};
 // Added by the buildbot. We only want to print environment variables specified
 // by the user.
 const BUILDBOT_ENVIRONMENT = new Set([
-  'BRANCH',
-  'CONTEXT',
-  'DEPLOY_PRIME_URL',
-  'DEPLOY_URL',
-  'GO_VERSION',
-  'NETLIFY_IMAGES_CDN_DOMAIN',
-  'SITE_ID',
-  'SITE_NAME',
-  'URL',
-])
-
+    'BRANCH',
+    'CONTEXT',
+    'DEPLOY_PRIME_URL',
+    'DEPLOY_URL',
+    'GO_VERSION',
+    'NETLIFY_IMAGES_CDN_DOMAIN',
+    'SITE_ID',
+    'SITE_NAME',
+    'URL',
+]);
 const cleanupPlugin = function ({ package: packageName, origin, inputs = {} }) {
-  const inputsA = filterObj(inputs, isPublicInput)
-  return { package: packageName, origin, inputs: inputsA }
-}
-
+    const inputsA = filterObj(inputs, isPublicInput);
+    return { package: packageName, origin, inputs: inputsA };
+};
 const isPublicInput = function (key, input) {
-  return typeof input === 'boolean'
-}
-
+    return typeof input === 'boolean';
+};
 // `headers` and `redirects` can be very long, which can take several minutes
 // to print in the build logs. We truncate them before logging.
 const truncateArray = function (netlifyConfig, propName) {
-  const array = netlifyConfig[propName]
-  return Array.isArray(array) && array.length > MAX_ARRAY_LENGTH
-    ? { ...netlifyConfig, [propName]: array.slice(0, MAX_ARRAY_LENGTH) }
-    : netlifyConfig
-}
-
-const MAX_ARRAY_LENGTH = 100
+    const array = netlifyConfig[propName];
+    return Array.isArray(array) && array.length > MAX_ARRAY_LENGTH
+        ? { ...netlifyConfig, [propName]: array.slice(0, MAX_ARRAY_LENGTH) }
+        : netlifyConfig;
+};
+const MAX_ARRAY_LENGTH = 100;

package/lib/log/logger.js

@@ -1,47 +1,36 @@
-import figures from 'figures'
-
-import { serializeObject } from './serialize.js'
-import { THEME } from './theme.js'
-
+import figures from 'figures';
+import { serializeObject } 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 }) {
-  if (!buffer) {
-    return
-  }
-
-  return { stdout: [], stderr: [] }
-}
-
+    if (!buffer) {
+        return;
+    }
+    return { stdout: [], stderr: [] };
+};
 // This should be used instead of `console.log()`
 // Printed on stderr because stdout is reserved for the JSON output
 export const log = function (logs, string, { color } = {}) {
-  const stringA = String(string).replace(EMPTY_LINES_REGEXP, EMPTY_LINE)
-  const stringB = color === undefined ? stringA : color(stringA)
-
-  if (logs !== undefined) {
-    // `logs` is a stateful variable
-    // eslint-disable-next-line fp/no-mutating-methods
-    logs.stderr.push(stringB)
-    return
-  }
-
-  console.warn(stringB)
-}
-
+    const stringA = String(string).replace(EMPTY_LINES_REGEXP, EMPTY_LINE);
+    const stringB = color === undefined ? stringA : color(stringA);
+    if (logs !== undefined) {
+        // `logs` is a stateful variable
+        logs.stderr.push(stringB);
+        return;
+    }
+    console.warn(stringB);
+};
 // 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 EMPTY_LINES_REGEXP = /^\s*$/gm;
+const EMPTY_LINE = '\u{200B}';
 export const logWarning = function (logs, string, opts) {
-  log(logs, string, { color: THEME.warningLine, ...opts })
-}
-
+    log(logs, string, { color: THEME.warningLine, ...opts });
+};
 export const logObject = function (logs, object, opts) {
-  log(logs, serializeObject(object), opts)
-}
-
+    log(logs, serializeObject(object), opts);
+};
 export const logSubHeader = function (logs, string, opts) {
-  log(logs, `\n${figures.pointer} ${string}`, { color: THEME.subHeader, ...opts })
-}
+    log(logs, `\n${figures.pointer} ${string}`, { color: THEME.subHeader, ...opts });
+};

package/lib/log/main.js

@@ -1,48 +1,39 @@
-import { cleanupConfig, cleanupEnvironment } from './cleanup.js'
-import { logObject, logSubHeader } from './logger.js'
-import { cleanupConfigOpts } from './options.js'
-
+import { cleanupConfig, cleanupEnvironment } from './cleanup.js';
+import { logObject, logSubHeader } from './logger.js';
+import { cleanupConfigOpts } from './options.js';
 // Log options in debug mode.
 export const logOpts = function (opts, { logs, debug, cachedConfig, cachedConfigPath }) {
-  // In production, print those in the first call to `@netlify/config`, not the
-  // second one done inside `@netlify/build`
-  if (!debug || cachedConfig !== undefined || cachedConfigPath !== undefined) {
-    return
-  }
-
-  logSubHeader(logs, 'Initial build environment')
-  logObject(logs, cleanupConfigOpts(opts))
-}
-
+    // In production, print those in the first call to `@netlify/config`, not the
+    // second one done inside `@netlify/build`
+    if (!debug || cachedConfig !== undefined || cachedConfigPath !== undefined) {
+        return;
+    }
+    logSubHeader(logs, 'Initial build environment');
+    logObject(logs, cleanupConfigOpts(opts));
+};
 // Log `defaultConfig` option in debug mode
 export const logDefaultConfig = function (defaultConfig, { logs, debug, baseRelDir }) {
-  if (!debug || defaultConfig === undefined) {
-    return
-  }
-
-  logSubHeader(logs, 'UI build settings')
-  logObject(logs, cleanupConfig({ ...defaultConfig, baseRelDir }))
-}
-
+    if (!debug || defaultConfig === undefined) {
+        return;
+    }
+    logSubHeader(logs, 'UI build settings');
+    logObject(logs, cleanupConfig({ ...defaultConfig, baseRelDir }));
+};
 // Log `inlineConfig` option in debug mode
 export const logInlineConfig = function (initialConfig, { logs, debug }) {
-  if (!debug || Object.keys(initialConfig).length === 0) {
-    return
-  }
-
-  logSubHeader(logs, 'Configuration override')
-  logObject(logs, cleanupConfig(initialConfig))
-}
-
+    if (!debug || Object.keys(initialConfig).length === 0) {
+        return;
+    }
+    logSubHeader(logs, 'Configuration override');
+    logObject(logs, cleanupConfig(initialConfig));
+};
 // Log return value of `@netlify/config` in debug mode
 export const logResult = function ({ configPath, buildDir, config, context, branch, env }, { logs, debug }) {
-  if (!debug) {
-    return
-  }
-
-  logSubHeader(logs, 'Resolved build environment')
-  logObject(logs, { configPath, buildDir, context, branch, env: cleanupEnvironment(env) })
-
-  logSubHeader(logs, 'Resolved config')
-  logObject(logs, cleanupConfig(config))
-}
+    if (!debug) {
+        return;
+    }
+    logSubHeader(logs, 'Resolved build environment');
+    logObject(logs, { configPath, buildDir, context, branch, env: cleanupEnvironment(env) });
+    logSubHeader(logs, 'Resolved config');
+    logObject(logs, cleanupConfig(config));
+};

package/lib/log/messages.js

@@ -1,126 +1,87 @@
-import { throwUserError } from '../error.js'
-
-import { logWarning } from './logger.js'
-
-export const ERROR_CALL_TO_ACTION = `Double-check your login status with 'netlify status' or contact support with details of your error.`
-
+import { throwUserError } from '../error.js';
+import { logWarning } from './logger.js';
+export const ERROR_CALL_TO_ACTION = `Double-check your login status with 'netlify status' or contact support with details of your error.`;
 export const throwOnInvalidTomlSequence = function (invalidSequence) {
-  throwUserError(
-    `In netlify.toml, the following backslash should be escaped: ${invalidSequence}
-The following should be used instead: \\${invalidSequence}`,
-  )
-}
-
+    throwUserError(`In netlify.toml, the following backslash should be escaped: ${invalidSequence}
+The following should be used instead: \\${invalidSequence}`);
+};
 export const warnLegacyFunctionsDirectory = ({ config = {}, logs }) => {
-  const { functionsDirectory, functionsDirectoryOrigin } = config
-
-  if (functionsDirectoryOrigin !== 'config-v1') {
-    return
-  }
-
-  logWarning(
-    logs,
-    `
+    const { functionsDirectory, functionsDirectoryOrigin } = config;
+    if (functionsDirectoryOrigin !== 'config-v1') {
+        return;
+    }
+    logWarning(logs, `
 Detected functions directory configuration in netlify.toml under [build] settings.
 We recommend updating netlify.toml to set the functions directory under [functions] settings using the directory property. For example,
 
 [functions]
-  directory = "${functionsDirectory}"`,
-  )
-}
-
+  directory = "${functionsDirectory}"`);
+};
 export const warnContextPluginConfig = function (logs, packageName, context) {
-  logWarning(
-    logs,
-    `
+    logWarning(logs, `
 "${packageName}" is installed in the UI, which means that it runs in all deploy contexts, regardless of file-based configuration.
-To run "${packageName}" in the ${context} context only, uninstall the plugin from the site plugins list.`,
-  )
-}
-
+To run "${packageName}" in the ${context} context only, uninstall the plugin from the site plugins list.`);
+};
 export const throwContextPluginsConfig = function (packageName, context) {
-  throwUserError(
-    `
+    throwUserError(`
 "${packageName}" is installed in the UI, which means that it runs in all deploy contexts, regardless of file-based configuration.
 To run "${packageName}" in the ${context} context only, uninstall the plugin from the site plugins list.
 To run "${packageName}" in all contexts, please remove the following section from "netlify.toml".
 
   [[context.${context}.plugins]]
   package = "${packageName}"
-`,
-  )
-}
-
+`);
+};
 export const warnHeadersParsing = function (logs, errors) {
-  if (errors.length === 0) {
-    return
-  }
-
-  const errorMessage = errors.map(getErrorMessage).join('\n\n')
-  logWarning(
-    logs,
-    `
+    if (errors.length === 0) {
+        return;
+    }
+    const errorMessage = errors.map(getErrorMessage).join('\n\n');
+    logWarning(logs, `
 Warning: some headers have syntax errors:
 
-${errorMessage}`,
-  )
-}
-
+${errorMessage}`);
+};
 // Headers with different cases are not currently the way users probably
 // intend them to be, so we print a warning message.
 // See issue at https://github.com/netlify/build/issues/2290
 export const warnHeadersCaseSensitivity = function (logs, headers) {
-  const headersA = headers.flatMap(getHeaderNames).filter(isNotDuplicateHeaderName).map(addHeaderLowerCase)
-  const differentCaseHeader = headersA.find(hasHeaderCaseDuplicate)
-  if (differentCaseHeader === undefined) {
-    return
-  }
-
-  const { forPath, headerName } = headersA.find((header) => isHeaderCaseDuplicate(header, differentCaseHeader))
-  const sameForPath = forPath === differentCaseHeader.forPath ? ` for "${forPath}"` : ''
-  logWarning(
-    logs,
-    `
-Warning: the same header is set twice with different cases${sameForPath}: "${headerName}" and "${differentCaseHeader.headerName}"`,
-  )
-}
-
+    const headersA = headers.flatMap(getHeaderNames).filter(isNotDuplicateHeaderName).map(addHeaderLowerCase);
+    const differentCaseHeader = headersA.find(hasHeaderCaseDuplicate);
+    if (differentCaseHeader === undefined) {
+        return;
+    }
+    const { forPath, headerName } = headersA.find((header) => isHeaderCaseDuplicate(header, differentCaseHeader));
+    const sameForPath = forPath === differentCaseHeader.forPath ? ` for "${forPath}"` : '';
+    logWarning(logs, `
+Warning: the same header is set twice with different cases${sameForPath}: "${headerName}" and "${differentCaseHeader.headerName}"`);
+};
 const getHeaderNames = function ({ for: forPath, values = {} }) {
-  return Object.keys(values).map((headerName) => ({ forPath, headerName }))
-}
-
+    return Object.keys(values).map((headerName) => ({ forPath, headerName }));
+};
 const isNotDuplicateHeaderName = function ({ headerName }, index, headers) {
-  return headers.slice(index + 1).every((header) => header.headerName !== headerName)
-}
-
+    return headers.slice(index + 1).every((header) => header.headerName !== headerName);
+};
 const addHeaderLowerCase = function ({ forPath, headerName }) {
-  const lowerHeaderName = headerName.toLowerCase()
-  return { forPath, headerName, lowerHeaderName }
-}
-
+    const lowerHeaderName = headerName.toLowerCase();
+    return { forPath, headerName, lowerHeaderName };
+};
 const hasHeaderCaseDuplicate = function ({ lowerHeaderName }, index, headers) {
-  return headers.slice(index + 1).some((header) => header.lowerHeaderName === lowerHeaderName)
-}
-
+    return headers.slice(index + 1).some((header) => header.lowerHeaderName === lowerHeaderName);
+};
 const isHeaderCaseDuplicate = function ({ headerName, lowerHeaderName }, differentCaseHeader) {
-  return differentCaseHeader.headerName !== headerName && differentCaseHeader.lowerHeaderName === lowerHeaderName
-}
-
+    return differentCaseHeader.headerName !== headerName && differentCaseHeader.lowerHeaderName === lowerHeaderName;
+};
 export const warnRedirectsParsing = function (logs, errors) {
-  if (errors.length === 0) {
-    return
-  }
-
-  const errorMessage = errors.map(getErrorMessage).join('\n\n')
-  logWarning(
-    logs,
-    `
+    if (errors.length === 0) {
+        return;
+    }
+    const errorMessage = errors.map(getErrorMessage).join('\n\n');
+    logWarning(logs, `
 Warning: some redirects have syntax errors:
 
-${errorMessage}`,
-  )
-}
-
+${errorMessage}`);
+};
 const getErrorMessage = function ({ message }) {
-  return message
-}
+    return message;
+};