@netlify/config 18.2.6-rc-rc → 18.2.6

package/bin.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+// This is a workaround for npm issue: https://github.com/npm/cli/issues/2632
+
+import './lib/bin/main.js'

package/lib/api/build_settings.js

@@ -1,41 +1,28 @@
-import { removeFalsy } from '../utils/remove_falsy.js'
-
+import { removeFalsy } from '../utils/remove_falsy.js';
 // Netlify UI build settings are used as default configuration values in
 // production. In local builds, we retrieve them with `getSite` (`siteInfo`)
 // instead.
 // This also includes UI-installed plugins.
-export const addBuildSettings = function ({
-  defaultConfig,
-  baseRelDir,
-  siteInfo: { build_settings: buildSettings, plugins },
-}) {
-  if (buildSettings === undefined) {
-    return { defaultConfig, baseRelDir }
-  }
-
-  const defaultConfigA = getDefaultConfig(buildSettings, defaultConfig, plugins)
-  const baseRelDirA = getBaseRelDir(buildSettings, baseRelDir)
-  return { defaultConfig: defaultConfigA, baseRelDir: baseRelDirA }
-}
-
+export const addBuildSettings = function ({ defaultConfig, baseRelDir, siteInfo: { build_settings: buildSettings, plugins }, }) {
+    if (buildSettings === undefined) {
+        return { defaultConfig, baseRelDir };
+    }
+    const defaultConfigA = getDefaultConfig(buildSettings, defaultConfig, plugins);
+    const baseRelDirA = getBaseRelDir(buildSettings, baseRelDir);
+    return { defaultConfig: defaultConfigA, baseRelDir: baseRelDirA };
+};
 // From the `getSite` API response to the corresponding configuration properties
-const getDefaultConfig = function (
-  { cmd: command, dir: publish, functions_dir: functionsDirectory, base },
-  { build, plugins = [], ...defaultConfig },
-  uiPlugins = [],
-) {
-  const siteBuild = removeFalsy({ command, publish, base })
-  const functions = functionsDirectory ? { functionsDirectory, functionsDirectoryOrigin: 'ui' } : {}
-  const uiPluginsA = uiPlugins.map(normalizeUiPlugin)
-  const pluginsA = [...uiPluginsA, ...plugins]
-  return { ...defaultConfig, build: { ...siteBuild, ...build }, plugins: pluginsA, ...functions }
-}
-
+const getDefaultConfig = function ({ cmd: command, dir: publish, functions_dir: functionsDirectory, base }, { build, plugins = [], ...defaultConfig }, uiPlugins = []) {
+    const siteBuild = removeFalsy({ command, publish, base });
+    const functions = functionsDirectory ? { functionsDirectory, functionsDirectoryOrigin: 'ui' } : {};
+    const uiPluginsA = uiPlugins.map(normalizeUiPlugin);
+    const pluginsA = [...uiPluginsA, ...plugins];
+    return { ...defaultConfig, build: { ...siteBuild, ...build }, plugins: pluginsA, ...functions };
+};
 // Make sure we know which fields we are picking from the API
 const normalizeUiPlugin = function ({ package: packageName, inputs, pinned_version: pinnedVersion }) {
-  return { package: packageName, inputs, pinned_version: pinnedVersion }
-}
-
+    return { package: packageName, inputs, pinned_version: pinnedVersion };
+};
 const getBaseRelDir = function ({ base_rel_dir: siteBaseRelDir }, baseRelDir = siteBaseRelDir) {
-  return Boolean(baseRelDir)
-}
+    return Boolean(baseRelDir);
+};

package/lib/api/client.js

@@ -1,15 +1,12 @@
-import { NetlifyAPI } from 'netlify'
-
-import { removeUndefined } from '../utils/remove_falsy.js'
-
+import { NetlifyAPI } from 'netlify';
+import { removeUndefined } from '../utils/remove_falsy.js';
 // Retrieve Netlify API client, if an access token was passed
 export const getApiClient = function ({ token, offline, testOpts = {}, host, scheme, pathPrefix }) {
-  if (!token || offline) {
-    return
-  }
-
-  // TODO: find less intrusive way to mock HTTP requests
-  const parameters = removeUndefined({ scheme: testOpts.scheme || scheme, host: testOpts.host || host, pathPrefix })
-  const api = new NetlifyAPI(token, parameters)
-  return api
-}
+    if (!token || offline) {
+        return;
+    }
+    // TODO: find less intrusive way to mock HTTP requests
+    const parameters = removeUndefined({ scheme: testOpts.scheme || scheme, host: testOpts.host || host, pathPrefix });
+    const api = new NetlifyAPI(token, parameters);
+    return api;
+};

package/lib/api/site_info.js

@@ -1,7 +1,6 @@
-import { getEnvelope } from '../env/envelope.js'
-import { throwUserError } from '../error.js'
-import { ERROR_CALL_TO_ACTION } from '../log/messages.js'
-
+import { getEnvelope } from '../env/envelope.js';
+import { throwUserError } from '../error.js';
+import { ERROR_CALL_TO_ACTION } from '../log/messages.js';
 // Retrieve Netlify Site information, if available.
 // Used to retrieve local build environment variables and UI build settings.
 // This is not used in production builds since the buildbot passes this
@@ -9,59 +8,52 @@ import { ERROR_CALL_TO_ACTION } from '../log/messages.js'
 // Requires knowing the `siteId` and having the access `token`.
 // Silently ignore API errors. For example the network connection might be down,
 // but local builds should still work regardless.
-// eslint-disable-next-line complexity
 export const getSiteInfo = async function ({ api, siteId, mode, testOpts: { env: testEnv = true } = {} }) {
-  if (api === undefined || mode === 'buildbot' || !testEnv) {
-    const siteInfo = siteId === undefined ? {} : { id: siteId }
-    return { siteInfo, accounts: [], addons: [] }
-  }
-
-  const [siteInfo, accounts, addons] = await Promise.all([
-    getSite(api, siteId),
-    getAccounts(api),
-    getAddons(api, siteId),
-  ])
-
-  if (siteInfo.use_envelope) {
-    const envelope = await getEnvelope({ api, accountId: siteInfo.account_slug, siteId })
-    // eslint-disable-next-line fp/no-mutation
-    siteInfo.build_settings.env = envelope
-  }
-
-  return { siteInfo, accounts, addons }
-}
-
+    if (api === undefined || mode === 'buildbot' || !testEnv) {
+        const siteInfo = siteId === undefined ? {} : { id: siteId };
+        return { siteInfo, accounts: [], addons: [] };
+    }
+    const [siteInfo, accounts, addons] = await Promise.all([
+        getSite(api, siteId),
+        getAccounts(api),
+        getAddons(api, siteId),
+    ]);
+    if (siteInfo.use_envelope) {
+        const envelope = await getEnvelope({ api, accountId: siteInfo.account_slug, siteId });
+        siteInfo.build_settings.env = envelope;
+    }
+    return { siteInfo, accounts, addons };
+};
 const getSite = async function (api, siteId) {
-  if (siteId === undefined) {
-    return {}
-  }
-
-  try {
-    const site = await api.getSite({ siteId })
-    return { ...site, id: siteId }
-  } catch (error) {
-    throwUserError(`Failed retrieving site data for site ${siteId}: ${error.message}. ${ERROR_CALL_TO_ACTION}`)
-  }
-}
-
+    if (siteId === undefined) {
+        return {};
+    }
+    try {
+        const site = await api.getSite({ siteId });
+        return { ...site, id: siteId };
+    }
+    catch (error) {
+        throwUserError(`Failed retrieving site data for site ${siteId}: ${error.message}. ${ERROR_CALL_TO_ACTION}`);
+    }
+};
 const getAccounts = async function (api) {
-  try {
-    const accounts = await api.listAccountsForUser()
-    return Array.isArray(accounts) ? accounts : []
-  } catch (error) {
-    throwUserError(`Failed retrieving user account: ${error.message}. ${ERROR_CALL_TO_ACTION}`)
-  }
-}
-
+    try {
+        const accounts = await api.listAccountsForUser();
+        return Array.isArray(accounts) ? accounts : [];
+    }
+    catch (error) {
+        throwUserError(`Failed retrieving user account: ${error.message}. ${ERROR_CALL_TO_ACTION}`);
+    }
+};
 const getAddons = async function (api, siteId) {
-  if (siteId === undefined) {
-    return []
-  }
-
-  try {
-    const addons = await api.listServiceInstancesForSite({ siteId })
-    return Array.isArray(addons) ? addons : []
-  } catch (error) {
-    throwUserError(`Failed retrieving addons for site ${siteId}: ${error.message}. ${ERROR_CALL_TO_ACTION}`)
-  }
-}
+    if (siteId === undefined) {
+        return [];
+    }
+    try {
+        const addons = await api.listServiceInstancesForSite({ siteId });
+        return Array.isArray(addons) ? addons : [];
+    }
+    catch (error) {
+        throwUserError(`Failed retrieving addons for site ${siteId}: ${error.message}. ${ERROR_CALL_TO_ACTION}`);
+    }
+};

package/lib/base.js

@@ -1,14 +1,8 @@
-import { resolvePath } from './files.js'
-
+import { resolvePath } from './files.js';
 // Retrieve the first `base` directory used to load the first config file.
-export const getInitialBase = function ({
-  repositoryRoot,
-  defaultConfig: { build: { base: defaultBase } = {} },
-  inlineConfig: { build: { base: initialBase = defaultBase } = {} },
-}) {
-  return resolveBase(repositoryRoot, initialBase)
-}
-
+export const getInitialBase = function ({ repositoryRoot, defaultConfig: { build: { base: defaultBase } = {} }, inlineConfig: { build: { base: initialBase = defaultBase } = {} }, }) {
+    return resolveBase(repositoryRoot, initialBase);
+};
 // Two config files can be used:
 //  - The first one, using the `config` property or doing a default lookup
 //    of `netlify.toml`
@@ -21,14 +15,12 @@ export const getInitialBase = function ({
 // If the second file has a `base` property, it is ignored, i.e. it is not
 // recursive.
 export const getBase = function (base, repositoryRoot, config) {
-  return base === undefined ? resolveBase(repositoryRoot, config.build.base) : base
-}
-
+    return base === undefined ? resolveBase(repositoryRoot, config.build.base) : base;
+};
 const resolveBase = function (repositoryRoot, base) {
-  return resolvePath(repositoryRoot, repositoryRoot, base, 'build.base')
-}
-
+    return resolvePath(repositoryRoot, repositoryRoot, base, 'build.base');
+};
 // Also `config.build.base`.
 export const addBase = function (config, base) {
-  return { ...config, build: { ...config.build, base } }
-}
+    return { ...config, build: { ...config.build, base } };
+};

package/lib/bin/flags.js

@@ -1,181 +1,173 @@
-import process from 'process'
-
-import filterObj from 'filter-obj'
-import yargs from 'yargs'
-import { hideBin } from 'yargs/helpers'
-
-import { normalizeCliFeatureFlags } from '../options/feature_flags.js'
-
+import process from 'process';
+import filterObj from 'filter-obj';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { normalizeCliFeatureFlags } from '../options/feature_flags.js';
 // Parse CLI flags
 export const parseFlags = function () {
-  const { featureFlags: cliFeatureFlags = '', ...flags } = yargs(hideBin(process.argv))
-    .options(FLAGS)
-    .usage(USAGE)
-    .parse()
-  const featureFlags = normalizeCliFeatureFlags(cliFeatureFlags)
-  const flagsA = { ...flags, featureFlags }
-  const flagsB = filterObj(flagsA, isUserFlag)
-  return flagsB
-}
-
+    const { featureFlags: cliFeatureFlags = '', ...flags } = yargs(hideBin(process.argv))
+        .options(FLAGS)
+        .usage(USAGE)
+        .parse();
+    const featureFlags = normalizeCliFeatureFlags(cliFeatureFlags);
+    const flagsA = { ...flags, featureFlags };
+    const flagsB = filterObj(flagsA, isUserFlag);
+    return flagsB;
+};
 const jsonParse = function (value) {
-  return value === undefined ? undefined : JSON.parse(value)
-}
-
+    return value === undefined ? undefined : JSON.parse(value);
+};
 // List of CLI flags
 const FLAGS = {
-  config: {
-    string: true,
-    describe: `Path to the configuration file.
+    config: {
+        string: true,
+        describe: `Path to the configuration file.
 Defaults to any netlify.toml in the git repository root directory or the base directory`,
-  },
-  defaultConfig: {
-    string: true,
-    describe: `JSON configuration object containing default values.
+    },
+    defaultConfig: {
+        string: true,
+        describe: `JSON configuration object containing default values.
 Each configuration default value is used unless overriden through the main configuration file.
 Default: none.`,
-    coerce: jsonParse,
-    hidden: true,
-  },
-  cachedConfig: {
-    string: true,
-    describe: `JSON configuration object returned by @netlify/config when --output=/ is used
+        coerce: jsonParse,
+        hidden: true,
+    },
+    cachedConfig: {
+        string: true,
+        describe: `JSON configuration object returned by @netlify/config when --output=/ is used
 or when using @netlify/config programmatically.
 This is done as a performance optimization to cache the configuration loading logic.
 Default: none.`,
-    coerce: jsonParse,
-    hidden: true,
-  },
-  cachedConfigPath: {
-    string: true,
-    describe: `File path to the JSON configuration object returned by @netlify/config
+        coerce: jsonParse,
+        hidden: true,
+    },
+    cachedConfigPath: {
+        string: true,
+        describe: `File path to the JSON configuration object returned by @netlify/config
 when --output=/path is used.
 This is done as a performance optimization to cache the configuration loading logic.
 Default: none.`,
-    hidden: true,
-  },
-  inlineConfig: {
-    string: true,
-    describe: `JSON configuration object overriding the configuration file and other settings.
+        hidden: true,
+    },
+    inlineConfig: {
+        string: true,
+        describe: `JSON configuration object overriding the configuration file and other settings.
 Default: none.`,
-    coerce: jsonParse,
-    hidden: true,
-  },
-  configMutations: {
-    array: true,
-    describe: `Array of changes to apply to the configuration.
+        coerce: jsonParse,
+        hidden: true,
+    },
+    configMutations: {
+        array: true,
+        describe: `Array of changes to apply to the configuration.
 Each change must be an object with three properties:
   - "keys": array of keys targetting the property to change
   - "value": new value of that property
   - "event": build event when this change was applied, e.g. "onPreBuild"
 Default: empty array.`,
-    coerce: jsonParse,
-    hidden: true,
-  },
-  cwd: {
-    string: true,
-    describe: `Current directory. Used to retrieve the configuration file.
+        coerce: jsonParse,
+        hidden: true,
+    },
+    cwd: {
+        string: true,
+        describe: `Current directory. Used to retrieve the configuration file.
 Default: current directory`,
-  },
-  repositoryRoot: {
-    string: true,
-    describe: `Git repository root directory. Used to retrieve the configuration file.
+    },
+    repositoryRoot: {
+        string: true,
+        describe: `Git repository root directory. Used to retrieve the configuration file.
 Default: automatically guessed`,
-  },
-  output: {
-    string: true,
-    describe: `Where to output the JSON result.
+    },
+    output: {
+        string: true,
+        describe: `Where to output the JSON result.
 Default: "-" (stdout)`,
-  },
-  stable: {
-    boolean: true,
-    describe: `Sort keys printed in the output.
+    },
+    stable: {
+        boolean: true,
+        describe: `Sort keys printed in the output.
 Default: false`,
-    default: false,
-  },
-  token: {
-    string: true,
-    describe: `Netlify API token for authentication.
+        default: false,
+    },
+    token: {
+        string: true,
+        describe: `Netlify API token for authentication.
 The NETLIFY_AUTH_TOKEN environment variable can be used as well.`,
-  },
-  host: {
-    string: true,
-    describe: `Host of the Netlify API.`,
-    hidden: true,
-  },
-  scheme: {
-    string: true,
-    describe: `Scheme/protocol of the Netlify API.`,
-    hidden: true,
-  },
-  pathPrefix: {
-    string: true,
-    describe: `Base path prefix of the Netlify API.`,
-    hidden: true,
-  },
-  siteId: {
-    string: true,
-    describe: `Netlify Site ID.`,
-  },
-  context: {
-    string: true,
-    describe: `Build context.
+    },
+    host: {
+        string: true,
+        describe: `Host of the Netlify API.`,
+        hidden: true,
+    },
+    scheme: {
+        string: true,
+        describe: `Scheme/protocol of the Netlify API.`,
+        hidden: true,
+    },
+    pathPrefix: {
+        string: true,
+        describe: `Base path prefix of the Netlify API.`,
+        hidden: true,
+    },
+    siteId: {
+        string: true,
+        describe: `Netlify Site ID.`,
+    },
+    context: {
+        string: true,
+        describe: `Build context.
 Default: 'production'`,
-  },
-  branch: {
-    string: true,
-    describe: `Repository branch.
+    },
+    branch: {
+        string: true,
+        describe: `Repository branch.
 Default: automatically guessed`,
-  },
-  baseRelDir: {
-    boolean: true,
-    describe: `Feature flag meant for backward compatibility.
+    },
+    baseRelDir: {
+        boolean: true,
+        describe: `Feature flag meant for backward compatibility.
 When enabled, if the 'build.base' configuration property is defined, it is used
 to try to retrieve a second configuration file and discard the first one.
 Default: true`,
-    hidden: true,
-  },
-  mode: {
-    string: true,
-    describe: `Environment in which this is loaded. Can be:
+        hidden: true,
+    },
+    mode: {
+        string: true,
+        describe: `Environment in which this is loaded. Can be:
   - 'buildbot': within Netlify Buildbot
   - 'cli': within Netlify CLI
   - 'require': through import('@netlify/config')`,
-    hidden: true,
-  },
-  debug: {
-    boolean: true,
-    describe: 'Print debugging information',
-    hidden: true,
-  },
-  testOpts: {
-    describe: 'Options for testing only',
-    hidden: true,
-  },
-  featureFlags: {
-    describe: 'Comma-separated list of feature flags to enable unreleased features',
-    hidden: true,
-  },
-  offline: {
-    boolean: true,
-    describe: `Do not send requests to the Netlify API to retrieve site settings.
+        hidden: true,
+    },
+    debug: {
+        boolean: true,
+        describe: 'Print debugging information',
+        hidden: true,
+    },
+    testOpts: {
+        describe: 'Options for testing only',
+        hidden: true,
+    },
+    featureFlags: {
+        describe: 'Comma-separated list of feature flags to enable unreleased features',
+        hidden: true,
+    },
+    offline: {
+        boolean: true,
+        describe: `Do not send requests to the Netlify API to retrieve site settings.
 Default: false`,
-  },
-  buffer: {
-    boolean: true,
-    describe: 'Buffer output instead of streaming it',
-    hidden: true,
-  },
-}
-
+    },
+    buffer: {
+        boolean: true,
+        describe: 'Buffer output instead of streaming it',
+        hidden: true,
+    },
+};
 const USAGE = `netlify-config [OPTIONS...]
 
 Retrieve and resolve the Netlify configuration.
-The result is printed as a JSON object on stdout.`
-
+The result is printed as a JSON object on stdout.`;
 // Remove `yargs`-specific options, shortcuts, dash-cased and aliases
 const isUserFlag = function (key, value) {
-  return value !== undefined && !INTERNAL_KEYS.has(key) && key.length !== 1 && !key.includes('-')
-}
-
-const INTERNAL_KEYS = new Set(['help', 'version', '_', '$0'])
+    return value !== undefined && !INTERNAL_KEYS.has(key) && key.length !== 1 && !key.includes('-');
+};
+const INTERNAL_KEYS = new Set(['help', 'version', '_', '$0']);