@netlify/config 20.3.3 → 20.3.5

package/lib/bin/flags.js

@@ -27,7 +27,7 @@ Defaults to any netlify.toml in the git repository root directory or the base di
     defaultConfig: {
         string: true,
         describe: `JSON configuration object containing default values.
-Each configuration default value is used unless overriden through the main configuration file.
+Each configuration default value is used unless overridden through the main configuration file.
 Default: none.`,
         coerce: jsonParse,
         hidden: true,
@@ -60,7 +60,7 @@ Default: none.`,
         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
+  - "keys": array of keys targeting the property to change
   - "value": new value of that property
   - "event": build event when this change was applied, e.g. "onPreBuild"
 Default: empty array.`,

package/lib/build_dir.js

@@ -11,7 +11,7 @@ export const getBuildDir = async function (repositoryRoot, base) {
     return buildDir;
 };
 // The build directory is used as the current directory of build commands and
-// build plugins. Therefore it must exist.
+// build plugins. Therefore, it must exist.
 // We already check `repositoryRoot` earlier in the code, so only need to check
 // `buildDir` when it is the base directory instead.
 const checkBuildDir = async function (buildDir, repositoryRoot) {

package/lib/context.js

@@ -63,7 +63,7 @@ const isEdgeFunctionsConfig = function (key, value) {
     return key === 'edge_functions' && Array.isArray(value);
 };
 // Ensure that `inlineConfig` has higher priority than context properties by
-// assigining it to `context.*`. Still keep it at the top-level as well since
+// assigning it to `context.*`. Still keep it at the top-level as well since
 // some properties are not handled context-sensitively by the API.
 // Takes into account that `context.{context}.build.*` is the same as
 // `context.{context}.*`

package/lib/default.js

@@ -1,6 +1,6 @@
 import { addBuildSettings } from './api/build_settings.js';
 import { logDefaultConfig } from './log/main.js';
-// Retrieve default configuration file. It has less priority and it also does
+// Retrieve default configuration file. It has less priority, and it also does
 // not get normalized, merged with contexts, etc.
 export const parseDefaultConfig = function ({ defaultConfig, base, baseRelDir, siteInfo, logs, debug }) {
     const defaultConfigB = addDefaultConfigBase(defaultConfig, base);
@@ -21,7 +21,7 @@ const addDefaultConfigBase = function (defaultConfig, base) {
     const { build = {} } = defaultConfig;
     return { ...defaultConfig, build: { ...build, base } };
 };
-// `baseRelDir` should default to `true` only if the option was not passed and
+// `baseRelDir` should default to `true` only if the option was not passed, and
 // it could be retrieved from the `siteInfo`, which is why the default value
 // is assigned later than other properties.
 const DEFAULT_BASE_REL_DIR = true;

package/lib/files.js

@@ -12,7 +12,7 @@ export const resolveConfigPaths = function ({ config, repositoryRoot, buildDir,
     const configB = addDefaultPaths(configA, repositoryRoot, baseRel);
     return configB;
 };
-// All file paths in the configuration file are are relative to `buildDir`
+// All file paths in the configuration file are relative to `buildDir`
 // (if `baseRelDir` is `true`).
 const FILE_PATH_CONFIG_PROPS = [
     'functionsDirectory',
@@ -44,7 +44,7 @@ export const resolvePath = function (repositoryRoot, baseRel, originalPath, prop
 // In that case, those are actually relative paths not absolute.
 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
+// However, we allow file paths to be outside 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)) {

package/lib/index.js

@@ -0,0 +1,5 @@
+export { DEV_EVENTS, EVENTS } from './events.js';
+export { cleanupConfig } from './log/cleanup.js';
+export { resolveConfig } from './main.js';
+export { applyMutations } from './mutations/apply.js';
+export { restoreConfig, updateConfig } from './mutations/update.js';

package/lib/log/logger.js

@@ -21,7 +21,7 @@ export const log = function (logs, string, { color } = {}) {
     }
     console.warn(stringB);
 };
-// We need to add a zero width space character in empty lines. Otherwise the
+// 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}';

package/lib/main.js

@@ -17,9 +17,6 @@ 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`.

package/lib/merge.js

@@ -13,7 +13,7 @@ export const mergeConfigs = function (configs) {
 const removeUndefinedProps = function ({ build = {}, ...config }) {
     return removeUndefined({ ...config, build: removeUndefined(build) });
 };
-// By default `deepmerge` concatenates arrays. We use the `arrayMerge` option
+// 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) {

package/lib/mutations/config_prop_name.js

@@ -1,14 +1,13 @@
-// Retrieve normalized property name
+/** Properties with dynamic children */
+const DYNAMIC_OBJECT_PROPS = new Set(['build.services', 'build.environment', 'functions', 'functions.*']);
+/** Retrieve normalized property name */
 export const getPropName = function (keys) {
-    return keys.reduce(normalizeDynamicProp, '');
-};
-// Some properties are user-defined, i.e. we need to replace them with a "*" token
-// Check if a property name is dynamic, such as `functions.{functionName}`, or
-// is an array index.
-// In those cases, we replace it by "*".
-const normalizeDynamicProp = function (propName, key) {
-    const normalizedKey = Number.isInteger(key) || DYNAMIC_OBJECT_PROPS.has(propName) ? '*' : String(key);
-    return propName === '' ? normalizedKey : `${propName}.${normalizedKey}`;
+    // Some properties are user-defined, i.e. we need to replace them with a "*" token
+    // Check if a property name is dynamic, such as `functions.{functionName}`, or
+    // is an array index.
+    // In those cases, we replace it by "*".
+    return keys.reduce((propName, key) => {
+        const normalizedKey = Number.isInteger(key) || DYNAMIC_OBJECT_PROPS.has(propName) ? '*' : String(key);
+        return propName === '' ? normalizedKey : `${propName}.${normalizedKey}`;
+    }, '');
 };
-// Properties with dynamic children
-const DYNAMIC_OBJECT_PROPS = new Set(['build.services', 'build.environment', 'functions', 'functions.*']);

package/lib/mutations/update.js

@@ -46,7 +46,7 @@ const deleteSideFile = async function (filePath) {
     await fs.unlink(filePath);
 };
 // Modifications to `netlify.toml` and `_headers/_redirects` are only meant for
-// the deploy API call. After it's been performed, we restore their former
+// the deployment API call. After it's been performed, we restore their former
 // state.
 // We do this by backing them up inside some sibling directory.
 const backupConfig = async function ({ buildDir, configPath, headersPath, redirectsPath }) {

package/lib/normalize.js

@@ -12,7 +12,7 @@ export const normalizeConfig = function (config) {
 };
 // Remove empty strings.
 // This notably ensures that empty strings in the build command are removed.
-// Otherwise those would be run during builds, making the build fail.
+// Otherwise, those would be run during builds, making the build fail.
 const removeEmpty = function ({ build, ...config }) {
     return removeFalsy({ ...config, build: removeFalsy(build) });
 };

package/lib/options/base.js

@@ -19,7 +19,7 @@ export const getBaseOverride = async function ({ repositoryRoot, cwd }) {
     // `base` starting with a `/` are relative to `repositoryRoot`, so we cannot
     // return an absolute path
     const base = relative(repositoryRoot, dirname(basePath));
-    // When `base` is explicitely overridden, `baseRelDir: true` makes more sense
+    // When `base` is explicitly overridden, `baseRelDir: true` makes more sense
     // since we want `publish`, `functions` and `edge_functions` to be relative to it.
     return { base, baseRelDir: true };
 };

package/lib/utils/toml.js

@@ -3,7 +3,7 @@ import tomlify from 'tomlify-j0.4';
 // Parse from TOML to JavaScript
 export const parseToml = function (configString) {
     const config = loadToml(configString);
-    // `toml.parse()` returns a object with `null` prototype deeply, which can
+    // `toml.parse()` returns an object with `null` prototype deeply, which can
     // sometimes create problems with some utilities. We convert it.
     // TOML can return Date instances, but JSON will stringify those, and we
     // don't use Date in netlify.toml, so this should be ok.

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@netlify/config",
-  "version": "20.3.3",
+  "version": "20.3.5",
   "description": "Netlify config module",
   "type": "module",
-  "exports": "./lib/main.js",
-  "main": "./lib/main.js",
-  "types": "./lib/main.d.ts",
+  "exports": "./lib/index.js",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "bin": {
     "netlify-config": "./bin.js"
   },
@@ -71,8 +71,8 @@
     "js-yaml": "^4.0.0",
     "map-obj": "^5.0.0",
     "netlify": "^13.1.2",
-    "netlify-headers-parser": "^7.1.1",
-    "netlify-redirect-parser": "^14.1.1",
+    "netlify-headers-parser": "^7.1.2",
+    "netlify-redirect-parser": "^14.1.2",
     "omit.js": "^2.0.2",
     "p-locate": "^6.0.0",
     "path-type": "^5.0.0",
@@ -82,7 +82,7 @@
     "yargs": "^17.6.0"
   },
   "devDependencies": {
-    "@types/node": "^14.18.31",
+    "@types/node": "^18.14.2",
     "ava": "^4.0.0",
     "c8": "^7.12.0",
     "del": "^6.0.0",
@@ -94,5 +94,5 @@
   "engines": {
     "node": "^14.16.0 || >=16.0.0"
   },
-  "gitHead": "d78a65c209ed987d3475cd1f37cf357693b99e3c"
+  "gitHead": "35d6533c324d061b9e8e4165d369880a25bab707"
 }