@netlify/config 18.2.4 → 18.2.5

package/lib/env/main.js

@@ -1,202 +1,150 @@
-import omit from 'omit.js'
-
-import { removeFalsy } from '../utils/remove_falsy.js'
-
-import { getEnvelope } from './envelope.js'
-import { getGitEnv } from './git.js'
-
+import omit from 'omit.js';
+import { removeFalsy } from '../utils/remove_falsy.js';
+import { getEnvelope } from './envelope.js';
+import { getGitEnv } from './git.js';
 // Retrieve this site's environment variable. Also take into account team-wide
 // environment variables and addons.
 // The buildbot already has the right environment variables. This is mostly
 // meant so that local builds can mimic production builds
 // TODO: add `netlify.toml` `build.environment`, after normalization
 // TODO: add `CONTEXT` and others
-export const getEnv = async function ({
-  api,
-  mode,
-  config,
-  siteInfo,
-  accounts,
-  addons,
-  buildDir,
-  branch,
-  deployId,
-  buildId,
-  context,
-}) {
-  if (mode === 'buildbot') {
-    return {}
-  }
-
-  const generalEnv = await getGeneralEnv({ siteInfo, buildDir, branch, deployId, buildId, context })
-  const [accountEnv, addonsEnv, uiEnv, configFileEnv] = await getUserEnv({ api, config, siteInfo, accounts, addons })
-
-  // Sources of environment variables, in descending order of precedence.
-  const sources = [
-    { key: 'configFile', values: configFileEnv },
-    { key: 'ui', values: uiEnv },
-    { key: 'addons', values: addonsEnv },
-    { key: 'account', values: accountEnv },
-    { key: 'general', values: generalEnv },
-  ]
-
-  // A hash mapping names of environment variables to objects containing the following properties:
-  // - sources: List of sources where the environment variable was found. The first element is the source that
-  //   actually provided the variable (i.e. the one with the highest precedence).
-  // - value: The value of the environment variable.
-  const env = new Map()
-
-  sources.forEach((source) => {
-    Object.keys(source.values).forEach((key) => {
-      if (env.has(key)) {
-        const { sources: envSources, value } = env.get(key)
-
-        env.set(key, {
-          sources: [...envSources, source.key],
-          value: convertToString(value),
-        })
-      } else {
-        env.set(key, {
-          sources: [source.key],
-          value: convertToString(source.values[key]),
-        })
-      }
-    })
-  })
-
-  return Object.fromEntries(env)
-}
-
+export const getEnv = async function ({ api, mode, config, siteInfo, accounts, addons, buildDir, branch, deployId, buildId, context, }) {
+    if (mode === 'buildbot') {
+        return {};
+    }
+    const generalEnv = await getGeneralEnv({ siteInfo, buildDir, branch, deployId, buildId, context });
+    const [accountEnv, addonsEnv, uiEnv, configFileEnv] = await getUserEnv({ api, config, siteInfo, accounts, addons });
+    // Sources of environment variables, in descending order of precedence.
+    const sources = [
+        { key: 'configFile', values: configFileEnv },
+        { key: 'ui', values: uiEnv },
+        { key: 'addons', values: addonsEnv },
+        { key: 'account', values: accountEnv },
+        { key: 'general', values: generalEnv },
+    ];
+    // A hash mapping names of environment variables to objects containing the following properties:
+    // - sources: List of sources where the environment variable was found. The first element is the source that
+    //   actually provided the variable (i.e. the one with the highest precedence).
+    // - value: The value of the environment variable.
+    const env = new Map();
+    sources.forEach((source) => {
+        Object.keys(source.values).forEach((key) => {
+            if (env.has(key)) {
+                const { sources: envSources, value } = env.get(key);
+                env.set(key, {
+                    sources: [...envSources, source.key],
+                    value: convertToString(value),
+                });
+            }
+            else {
+                env.set(key, {
+                    sources: [source.key],
+                    value: convertToString(source.values[key]),
+                });
+            }
+        });
+    });
+    return Object.fromEntries(env);
+};
 const convertToString = (value) => {
-  if (value === null || value === undefined) {
-    return value
-  }
-
-  if (typeof value === 'string') {
-    return value
-  }
-
-  return value.toString()
-}
-
+    if (value === null || value === undefined) {
+        return value;
+    }
+    if (typeof value === 'string') {
+        return value;
+    }
+    return value.toString();
+};
 // Environment variables not set by users, but meant to mimic the production
 // environment.
-const getGeneralEnv = async function ({
-  siteInfo,
-  siteInfo: { id, name },
-  buildDir,
-  branch,
-  deployId,
-  buildId,
-  context,
-}) {
-  const gitEnv = await getGitEnv(buildDir, branch)
-  const deployUrls = getDeployUrls({ siteInfo, branch, deployId })
-  return removeFalsy({
-    SITE_ID: id,
-    SITE_NAME: name,
-    DEPLOY_ID: deployId,
-    BUILD_ID: buildId,
-    ...deployUrls,
-    CONTEXT: context,
-    NETLIFY_LOCAL: 'true',
-    ...gitEnv,
-    // Localization
-    LANG: 'en_US.UTF-8',
-    LANGUAGE: 'en_US:en',
-    LC_ALL: 'en_US.UTF-8',
-    // Disable telemetry of some tools
-    GATSBY_TELEMETRY_DISABLED: '1',
-    NEXT_TELEMETRY_DISABLED: '1',
-  })
-}
-
-const getDeployUrls = function ({
-  siteInfo: { name = DEFAULT_SITE_NAME, ssl_url: sslUrl, build_settings: { repo_url: REPOSITORY_URL } = {} },
-  branch,
-  deployId,
-}) {
-  return {
-    URL: sslUrl,
-    REPOSITORY_URL,
-    DEPLOY_PRIME_URL: `https://${branch}--${name}${NETLIFY_DEFAULT_DOMAIN}`,
-    DEPLOY_URL: `https://${deployId}--${name}${NETLIFY_DEFAULT_DOMAIN}`,
-  }
-}
-
-const NETLIFY_DEFAULT_DOMAIN = '.netlify.app'
+const getGeneralEnv = async function ({ siteInfo, siteInfo: { id, name }, buildDir, branch, deployId, buildId, context, }) {
+    const gitEnv = await getGitEnv(buildDir, branch);
+    const deployUrls = getDeployUrls({ siteInfo, branch, deployId });
+    return removeFalsy({
+        SITE_ID: id,
+        SITE_NAME: name,
+        DEPLOY_ID: deployId,
+        BUILD_ID: buildId,
+        ...deployUrls,
+        CONTEXT: context,
+        NETLIFY_LOCAL: 'true',
+        ...gitEnv,
+        // Localization
+        LANG: 'en_US.UTF-8',
+        LANGUAGE: 'en_US:en',
+        LC_ALL: 'en_US.UTF-8',
+        // Disable telemetry of some tools
+        GATSBY_TELEMETRY_DISABLED: '1',
+        NEXT_TELEMETRY_DISABLED: '1',
+    });
+};
+const getDeployUrls = function ({ siteInfo: { name = DEFAULT_SITE_NAME, ssl_url: sslUrl, build_settings: { repo_url: REPOSITORY_URL } = {} }, branch, deployId, }) {
+    return {
+        URL: sslUrl,
+        REPOSITORY_URL,
+        DEPLOY_PRIME_URL: `https://${branch}--${name}${NETLIFY_DEFAULT_DOMAIN}`,
+        DEPLOY_URL: `https://${deployId}--${name}${NETLIFY_DEFAULT_DOMAIN}`,
+    };
+};
+const NETLIFY_DEFAULT_DOMAIN = '.netlify.app';
 // `site.name` is `undefined` when there is no token or siteId
-const DEFAULT_SITE_NAME = 'site-name'
-
+const DEFAULT_SITE_NAME = 'site-name';
 // Environment variables specified by the user
 const getUserEnv = async function ({ api, config, siteInfo, accounts, addons }) {
-  const accountEnv = await getAccountEnv({ api, siteInfo, accounts })
-  const addonsEnv = getAddonsEnv(addons)
-  const uiEnv = getUiEnv({ siteInfo })
-  const configFileEnv = getConfigFileEnv({ config })
-  return [accountEnv, addonsEnv, uiEnv, configFileEnv].map(cleanUserEnv)
-}
-
+    const accountEnv = await getAccountEnv({ api, siteInfo, accounts });
+    const addonsEnv = getAddonsEnv(addons);
+    const uiEnv = getUiEnv({ siteInfo });
+    const configFileEnv = getConfigFileEnv({ config });
+    return [accountEnv, addonsEnv, uiEnv, configFileEnv].map(cleanUserEnv);
+};
 // Account-wide environment variables
 const getAccountEnv = async function ({ api, siteInfo, accounts }) {
-  if (siteInfo.use_envelope) {
-    const envelope = await getEnvelope({ api, accountId: siteInfo.account_slug })
-    return envelope
-  }
-  const { site_env: siteEnv = {} } = accounts.find(({ slug }) => slug === siteInfo.account_slug) || {}
-  return siteEnv
-}
-
+    if (siteInfo.use_envelope) {
+        const envelope = await getEnvelope({ api, accountId: siteInfo.account_slug });
+        return envelope;
+    }
+    const { site_env: siteEnv = {} } = accounts.find(({ slug }) => slug === siteInfo.account_slug) || {};
+    return siteEnv;
+};
 // Environment variables from addons
 const getAddonsEnv = function (addons) {
-  return Object.assign({}, ...addons.map(getAddonEnv))
-}
-
+    return Object.assign({}, ...addons.map(getAddonEnv));
+};
 const getAddonEnv = function ({ env }) {
-  return env
-}
-
+    return env;
+};
 // Site-specific environment variables set in the UI
 const getUiEnv = function ({ siteInfo: { build_settings: { env = {} } = {} } }) {
-  return env
-}
-
+    return env;
+};
 // Site-specific environment variables set in netlify.toml
-const getConfigFileEnv = function ({
-  config: {
-    build: { environment = {} },
-  },
-}) {
-  return environment
-}
-
+const getConfigFileEnv = function ({ config: { build: { environment = {} }, }, }) {
+    return environment;
+};
 // Some environment variables cannot be overridden by configuration
 const cleanUserEnv = function (userEnv) {
-  return omit.default(userEnv, READONLY_ENV)
-}
-
+    return omit.default(userEnv, READONLY_ENV);
+};
 const READONLY_ENV = [
-  // Set in local builds
-  'BRANCH',
-  'CACHED_COMMIT_REF',
-  'COMMIT_REF',
-  'CONTEXT',
-  'HEAD',
-  'REPOSITORY_URL',
-  'URL',
-
-  // CI builds set NETLIFY=true while CLI and programmatic builds set
-  // NETLIFY_LOCAL=true
-  'NETLIFY',
-  'NETLIFY_LOCAL',
-
-  // Not set in local builds because there is no CI build/deploy, incoming hooks nor PR
-  'INCOMING_HOOK_BODY',
-  'INCOMING_HOOK_TITLE',
-  'INCOMING_HOOK_URL',
-  'NETLIFY_BUILD_BASE',
-  'NETLIFY_BUILD_LIFECYCLE_TRIAL',
-  'NETLIFY_IMAGES_CDN_DOMAIN',
-  'PULL_REQUEST',
-  'REVIEW_ID',
-]
+    // Set in local builds
+    'BRANCH',
+    'CACHED_COMMIT_REF',
+    'COMMIT_REF',
+    'CONTEXT',
+    'HEAD',
+    'REPOSITORY_URL',
+    'URL',
+    // CI builds set NETLIFY=true while CLI and programmatic builds set
+    // NETLIFY_LOCAL=true
+    'NETLIFY',
+    'NETLIFY_LOCAL',
+    // Not set in local builds because there is no CI build/deploy, incoming hooks nor PR
+    'INCOMING_HOOK_BODY',
+    'INCOMING_HOOK_TITLE',
+    'INCOMING_HOOK_URL',
+    'NETLIFY_BUILD_BASE',
+    'NETLIFY_BUILD_LIFECYCLE_TRIAL',
+    'NETLIFY_IMAGES_CDN_DOMAIN',
+    'PULL_REQUEST',
+    'REVIEW_ID',
+];

package/lib/error.js

@@ -1,36 +1,28 @@
 // We distinguish between errors thrown intentionally and uncaught exceptions
 // (such as bugs) with a `customErrorInfo.type` property.
 export const throwUserError = function (messageOrError, error) {
-  const errorA = getError(messageOrError, error)
-  errorA[CUSTOM_ERROR_KEY] = { type: USER_ERROR_TYPE }
-  throw errorA
-}
-
+    const errorA = getError(messageOrError, error);
+    errorA[CUSTOM_ERROR_KEY] = { type: USER_ERROR_TYPE };
+    throw errorA;
+};
 // Can pass either `message`, `error` or `message, error`
 const getError = function (messageOrError, error) {
-  if (messageOrError instanceof Error) {
-    return messageOrError
-  }
-
-  if (error === undefined) {
-    return new Error(messageOrError)
-  }
-
-  error.message = `${messageOrError}\n${error.message}`
-  return error
-}
-
+    if (messageOrError instanceof Error) {
+        return messageOrError;
+    }
+    if (error === undefined) {
+        return new Error(messageOrError);
+    }
+    error.message = `${messageOrError}\n${error.message}`;
+    return error;
+};
 export const isUserError = function (error) {
-  return (
-    canHaveErrorInfo(error) && error[CUSTOM_ERROR_KEY] !== undefined && error[CUSTOM_ERROR_KEY].type === USER_ERROR_TYPE
-  )
-}
-
+    return (canHaveErrorInfo(error) && error[CUSTOM_ERROR_KEY] !== undefined && error[CUSTOM_ERROR_KEY].type === USER_ERROR_TYPE);
+};
 // Exceptions that are not objects (including `Error` instances) cannot have an
 // `CUSTOM_ERROR_KEY` property
 const canHaveErrorInfo = function (error) {
-  return error != null
-}
-
-const CUSTOM_ERROR_KEY = 'customErrorInfo'
-const USER_ERROR_TYPE = 'resolveConfig'
+    return error != null;
+};
+const CUSTOM_ERROR_KEY = 'customErrorInfo';
+const USER_ERROR_TYPE = 'resolveConfig';

package/lib/events.js

@@ -1,22 +1,21 @@
 // List of build plugins events
 export const EVENTS = [
-  // Before build command
-  'onPreBuild',
-  // After build command, before Functions bundling
-  'onBuild',
-  // After Functions bundling
-  'onPostBuild',
-  // After build success
-  'onSuccess',
-  // After build error
-  'onError',
-  // After build error or success
-  'onEnd',
-]
-
+    // Before build command
+    'onPreBuild',
+    // After build command, before Functions bundling
+    'onBuild',
+    // After Functions bundling
+    'onPostBuild',
+    // After build success
+    'onSuccess',
+    // After build error
+    'onError',
+    // After build error or success
+    'onEnd',
+];
 export const DEV_EVENTS = [
-  // Before dev command
-  'onPreDev',
-  // The dev command
-  'onDev',
-]
+    // Before dev command
+    'onPreDev',
+    // The dev command
+    'onDev',
+];

package/lib/files.js

@@ -1,107 +1,83 @@
-import { resolve, relative, parse } from 'path'
-
-import { getProperty, setProperty, deleteProperty } from 'dot-prop'
-import { pathExists } from 'path-exists'
-
-import { throwUserError } from './error.js'
-import { mergeConfigs } from './merge.js'
-import { isTruthy } from './utils/remove_falsy.js'
-
+import { resolve, relative, parse } from 'path';
+import { getProperty, setProperty, deleteProperty } from 'dot-prop';
+import { pathExists } from 'path-exists';
+import { throwUserError } from './error.js';
+import { mergeConfigs } from './merge.js';
+import { isTruthy } from './utils/remove_falsy.js';
 // Make configuration paths relative to `buildDir` and converts them to
 // absolute paths
 export const resolveConfigPaths = async function ({ config, repositoryRoot, buildDir, baseRelDir }) {
-  const baseRel = baseRelDir ? buildDir : repositoryRoot
-  const configA = resolvePaths(config, FILE_PATH_CONFIG_PROPS, baseRel, repositoryRoot)
-  const configB = await addDefaultPaths(configA, repositoryRoot, baseRel)
-  return configB
-}
-
+    const baseRel = baseRelDir ? buildDir : repositoryRoot;
+    const configA = resolvePaths(config, FILE_PATH_CONFIG_PROPS, baseRel, repositoryRoot);
+    const configB = await addDefaultPaths(configA, repositoryRoot, baseRel);
+    return configB;
+};
 // All file paths in the configuration file are are relative to `buildDir`
 // (if `baseRelDir` is `true`).
-const FILE_PATH_CONFIG_PROPS = ['functionsDirectory', 'build.publish', 'build.edge_functions']
-
+const FILE_PATH_CONFIG_PROPS = ['functionsDirectory', 'build.publish', 'build.edge_functions'];
 const resolvePaths = function (config, propNames, baseRel, repositoryRoot) {
-  return propNames.reduce((configA, propName) => resolvePathProp(configA, propName, baseRel, repositoryRoot), config)
-}
-
+    return propNames.reduce((configA, propName) => resolvePathProp(configA, propName, baseRel, repositoryRoot), config);
+};
 const resolvePathProp = function (config, propName, baseRel, repositoryRoot) {
-  const path = getProperty(config, propName)
-
-  if (!isTruthy(path)) {
-    deleteProperty(config, propName)
-    return config
-  }
-
-  return setProperty(config, propName, resolvePath(repositoryRoot, baseRel, path, propName))
-}
-
+    const path = getProperty(config, propName);
+    if (!isTruthy(path)) {
+        deleteProperty(config, propName);
+        return config;
+    }
+    return setProperty(config, propName, resolvePath(repositoryRoot, baseRel, path, propName));
+};
 export const resolvePath = function (repositoryRoot, baseRel, originalPath, propName) {
-  if (!isTruthy(originalPath)) {
-    return
-  }
-
-  const path = originalPath.replace(LEADING_SLASH_REGEXP, '')
-  const pathA = resolve(baseRel, path)
-  validateInsideRoot(originalPath, pathA, repositoryRoot, propName)
-  return pathA
-}
-
+    if (!isTruthy(originalPath)) {
+        return;
+    }
+    const path = originalPath.replace(LEADING_SLASH_REGEXP, '');
+    const pathA = resolve(baseRel, path);
+    validateInsideRoot(originalPath, pathA, repositoryRoot, propName);
+    return pathA;
+};
 // We allow paths in configuration file to start with /
 // In that case, those are actually relative paths not absolute.
-const LEADING_SLASH_REGEXP = /^\/+/
-
+const LEADING_SLASH_REGEXP = /^\/+/;
 // We ensure all file paths are within the repository root directory.
 // However we allow file paths to be outside of the build directory, since this
 // can be convenient in monorepo setups.
 const validateInsideRoot = function (originalPath, path, repositoryRoot, propName) {
-  if (relative(repositoryRoot, path).startsWith('..') || getWindowsDrive(repositoryRoot) !== getWindowsDrive(path)) {
-    throwUserError(
-      `Configuration property "${propName}" "${originalPath}" must be inside the repository root directory.`,
-    )
-  }
-}
-
+    if (relative(repositoryRoot, path).startsWith('..') || getWindowsDrive(repositoryRoot) !== getWindowsDrive(path)) {
+        throwUserError(`Configuration property "${propName}" "${originalPath}" must be inside the repository root directory.`);
+    }
+};
 const getWindowsDrive = function (path) {
-  return parse(path).root
-}
-
+    return parse(path).root;
+};
 // Some configuration properties have default values that are only set if a
 // specific directory/file exists in the build directory
 const addDefaultPaths = async function (config, repositoryRoot, baseRel) {
-  const defaultPathsConfigs = await Promise.all(
-    DEFAULT_PATHS.map(({ defaultPath, getConfig, propName }) =>
-      addDefaultPath({ repositoryRoot, baseRel, defaultPath, getConfig, propName }),
-    ),
-  )
-  const defaultPathsConfigsA = defaultPathsConfigs.filter(Boolean)
-  return mergeConfigs([...defaultPathsConfigsA, config])
-}
-
+    const defaultPathsConfigs = await Promise.all(DEFAULT_PATHS.map(({ defaultPath, getConfig, propName }) => addDefaultPath({ repositoryRoot, baseRel, defaultPath, getConfig, propName })));
+    const defaultPathsConfigsA = defaultPathsConfigs.filter(Boolean);
+    return mergeConfigs([...defaultPathsConfigsA, config]);
+};
 const DEFAULT_PATHS = [
-  // @todo Remove once we drop support for the legacy default functions directory.
-  {
-    getConfig: (directory) => ({ functionsDirectory: directory, functionsDirectoryOrigin: 'default-v1' }),
-    defaultPath: 'netlify-automatic-functions',
-    propName: 'functions.directory',
-  },
-  {
-    getConfig: (directory) => ({ functionsDirectory: directory, functionsDirectoryOrigin: 'default' }),
-    defaultPath: 'netlify/functions',
-    propName: 'functions.directory',
-  },
-  {
-    getConfig: (directory) => ({ build: { edge_functions: directory } }),
-    defaultPath: 'netlify/edge-functions',
-    propName: 'build.edge_functions',
-  },
-]
-
+    // @todo Remove once we drop support for the legacy default functions directory.
+    {
+        getConfig: (directory) => ({ functionsDirectory: directory, functionsDirectoryOrigin: 'default-v1' }),
+        defaultPath: 'netlify-automatic-functions',
+        propName: 'functions.directory',
+    },
+    {
+        getConfig: (directory) => ({ functionsDirectory: directory, functionsDirectoryOrigin: 'default' }),
+        defaultPath: 'netlify/functions',
+        propName: 'functions.directory',
+    },
+    {
+        getConfig: (directory) => ({ build: { edge_functions: directory } }),
+        defaultPath: 'netlify/edge-functions',
+        propName: 'build.edge_functions',
+    },
+];
 const addDefaultPath = async function ({ repositoryRoot, baseRel, defaultPath, getConfig, propName }) {
-  const absolutePath = resolvePath(repositoryRoot, baseRel, defaultPath, propName)
-
-  if (!(await pathExists(absolutePath))) {
-    return
-  }
-
-  return getConfig(absolutePath)
-}
+    const absolutePath = resolvePath(repositoryRoot, baseRel, defaultPath, propName);
+    if (!(await pathExists(absolutePath))) {
+        return;
+    }
+    return getConfig(absolutePath);
+};