@automattic/vip 4.1.6 → 4.1.8

package/dist/lib/dev-environment/dev-environment-configuration-file.js

@@ -1,221 +1,254 @@
 "use strict";
-
-exports.__esModule = true;
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.CONFIGURATION_TEMPLATE_FILE_NAME = exports.CONFIGURATION_FILE_NAME = void 0;
 exports.getConfigurationFileOptions = getConfigurationFileOptions;
 exports.mergeConfigurationFileOptions = mergeConfigurationFileOptions;
-var _chalk = _interopRequireDefault(require("chalk"));
-var _debug = _interopRequireDefault(require("debug"));
-var _jsYaml = _interopRequireWildcard(require("js-yaml"));
-var _promises = require("node:fs/promises");
-var _nodePath = _interopRequireDefault(require("node:path"));
-var _devEnvironmentCli = require("./dev-environment-cli");
-var exit = _interopRequireWildcard(require("../cli/exit"));
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const debug = (0, _debug.default)('@automattic/vip:bin:dev-environment');
-const CONFIGURATION_FILE_NAME = exports.CONFIGURATION_FILE_NAME = 'vip-dev-env.yml';
-const CONFIGURATION_TEMPLATE_FILE_NAME = exports.CONFIGURATION_TEMPLATE_FILE_NAME = 'vip-dev-env.yml.ejs';
+const chalk_1 = __importDefault(require("chalk"));
+const debug_1 = __importDefault(require("debug"));
+const js_yaml_1 = __importStar(require("js-yaml"));
+const promises_1 = require("node:fs/promises");
+const node_path_1 = __importDefault(require("node:path"));
+const dev_environment_cli_1 = require("./dev-environment-cli");
+const exit = __importStar(require("../cli/exit"));
+const debug = (0, debug_1.default)('@automattic/vip:bin:dev-environment');
+exports.CONFIGURATION_FILE_NAME = 'vip-dev-env.yml';
+exports.CONFIGURATION_TEMPLATE_FILE_NAME = 'vip-dev-env.yml.ejs';
 const ALLOWED_CONFIG_DIR_TEMPLATE = /<%=\s*configDir\s*%>/g;
 const EJS_TEMPLATE_TAG = /<%[\s\S]*?%>/;
 async function getConfigurationFileOptions() {
-  const configurationFile = await findConfigurationFile();
-  if (configurationFile === false) {
-    return {};
-  }
-  const {
-    configurationPath,
-    configurationContents
-  } = configurationFile;
-  let configurationFromFile = {};
-  try {
-    configurationFromFile = _jsYaml.default.load(configurationContents, {
-      // Only allow strings, arrays, and objects to be parsed from configuration file
-      // This causes number-looking values like `php: 8.1` to be parsed directly into strings
-      schema: _jsYaml.FAILSAFE_SCHEMA
-    });
-  } catch (err) {
-    const messageToShow = `Configuration file ${_chalk.default.grey(configurationPath)} could not be loaded:\n` + err.toString();
-    exit.withError(messageToShow);
-  }
-  try {
-    let configuration = sanitizeConfiguration(configurationFromFile, configurationPath);
-    configuration = adjustRelativePaths(configuration, configurationPath);
-    debug('Sanitized configuration from file:', configuration);
-    return configuration;
-  } catch (err) {
-    exit.withError(err instanceof Error ? err : new Error('Unknown error'));
-  }
+    const configurationFile = await findConfigurationFile();
+    if (configurationFile === false) {
+        return {};
+    }
+    const { configurationPath, configurationContents } = configurationFile;
+    let configurationFromFile = {};
+    try {
+        configurationFromFile = js_yaml_1.default.load(configurationContents, {
+            // Only allow strings, arrays, and objects to be parsed from configuration file
+            // This causes number-looking values like `php: 8.1` to be parsed directly into strings
+            schema: js_yaml_1.FAILSAFE_SCHEMA,
+        });
+    }
+    catch (err) {
+        const messageToShow = `Configuration file ${chalk_1.default.grey(configurationPath)} could not be loaded:\n` +
+            err.toString();
+        exit.withError(messageToShow);
+    }
+    try {
+        let configuration = sanitizeConfiguration(configurationFromFile, configurationPath);
+        configuration = adjustRelativePaths(configuration, configurationPath);
+        debug('Sanitized configuration from file:', configuration);
+        return configuration;
+    }
+    catch (err) {
+        exit.withError(err instanceof Error ? err : new Error('Unknown error'));
+    }
 }
 function sanitizeConfiguration(configuration, configurationFilePath) {
-  const genericConfigurationError = `Configuration file ${_chalk.default.grey(configurationFilePath)} is available but ` + `couldn't be loaded. Ensure there is a ${_chalk.default.cyan('configuration-version')} and ${_chalk.default.cyan('slug')} ` + `configured. For example:\n\n${_chalk.default.grey(getConfigurationFileExample())}`;
-  if (Array.isArray(configuration) || typeof configuration !== 'object') {
-    throw new Error(genericConfigurationError);
-  }
-  const version = configuration['configuration-version'];
-  if (typeof version !== 'string' && typeof version !== 'number' || configuration.slug === undefined || configuration.slug === null) {
-    throw new Error(genericConfigurationError);
-  }
-  const validVersions = getAllConfigurationFileVersions().map(ver => _chalk.default.cyan(ver)).join(', ');
-  if (!isValidConfigurationFileVersion(version.toString())) {
-    throw new Error(`Configuration file ${_chalk.default.grey(configurationFilePath)} has an invalid ` + `${_chalk.default.cyan('configuration-version')} key. Update to a supported version. For example:\n\n` + _chalk.default.grey(getConfigurationFileExample()) + `\nSupported configuration versions: ${validVersions}.\n`);
-  }
-  const stringToBooleanIfDefined = value => {
-    if (typeof value !== 'string' || !['true', 'false'].includes(value)) {
-      return undefined;
+    const genericConfigurationError = `Configuration file ${chalk_1.default.grey(configurationFilePath)} is available but ` +
+        `couldn't be loaded. Ensure there is a ${chalk_1.default.cyan('configuration-version')} and ${chalk_1.default.cyan('slug')} ` +
+        `configured. For example:\n\n${chalk_1.default.grey(getConfigurationFileExample())}`;
+    if (Array.isArray(configuration) || typeof configuration !== 'object') {
+        throw new Error(genericConfigurationError);
+    }
+    const version = configuration['configuration-version'];
+    if ((typeof version !== 'string' && typeof version !== 'number') ||
+        configuration.slug === undefined ||
+        configuration.slug === null) {
+        throw new Error(genericConfigurationError);
     }
-    return value === 'true';
-  };
-  const configurationMeta = {
-    'configuration-path': configurationFilePath
-  };
-  const sanitizedConfiguration = {
-    version: version.toString(),
-    // eslint-disable-next-line @typescript-eslint/no-base-to-string
-    slug: configuration.slug.toString(),
-    // NOSONAR
-    title: configuration.title?.toString(),
-    multisite: (0, _devEnvironmentCli.resolveMultisite)((0, _devEnvironmentCli.processStringOrBooleanOption)(configuration.multisite)),
-    php: configuration.php?.toString(),
-    wordpress: configuration.wordpress?.toString(),
-    'mu-plugins': configuration['mu-plugins']?.toString(),
-    'app-code': configuration['app-code']?.toString(),
-    elasticsearch: stringToBooleanIfDefined(configuration.elasticsearch),
-    phpmyadmin: stringToBooleanIfDefined(configuration.phpmyadmin),
-    xdebug: stringToBooleanIfDefined(configuration.xdebug),
-    mailpit: stringToBooleanIfDefined(configuration.mailpit),
-    'media-redirect-domain': configuration['media-redirect-domain']?.toString(),
-    photon: stringToBooleanIfDefined(configuration.photon),
-    cron: stringToBooleanIfDefined(configuration.cron),
-    overrides: configuration.overrides?.toString(),
-    meta: configurationMeta
-  };
-
-  // Remove undefined values
-  Object.keys(sanitizedConfiguration).forEach(
-  // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-  key => sanitizedConfiguration[key] === undefined && delete sanitizedConfiguration[key]);
-  return sanitizedConfiguration;
+    const validVersions = getAllConfigurationFileVersions()
+        .map(ver => chalk_1.default.cyan(ver))
+        .join(', ');
+    if (!isValidConfigurationFileVersion(version.toString())) {
+        throw new Error(`Configuration file ${chalk_1.default.grey(configurationFilePath)} has an invalid ` +
+            `${chalk_1.default.cyan('configuration-version')} key. Update to a supported version. For example:\n\n` +
+            chalk_1.default.grey(getConfigurationFileExample()) +
+            `\nSupported configuration versions: ${validVersions}.\n`);
+    }
+    const stringToBooleanIfDefined = (value) => {
+        if (typeof value !== 'string' || !['true', 'false'].includes(value)) {
+            return undefined;
+        }
+        return value === 'true';
+    };
+    const configurationMeta = {
+        'configuration-path': configurationFilePath,
+    };
+    const sanitizedConfiguration = {
+        version: version.toString(),
+        // eslint-disable-next-line @typescript-eslint/no-base-to-string
+        slug: configuration.slug.toString(), // NOSONAR
+        title: configuration.title?.toString(),
+        multisite: (0, dev_environment_cli_1.resolveMultisite)((0, dev_environment_cli_1.processStringOrBooleanOption)(configuration.multisite)),
+        php: configuration.php?.toString(),
+        wordpress: configuration.wordpress?.toString(),
+        'mu-plugins': configuration['mu-plugins']?.toString(),
+        'app-code': configuration['app-code']?.toString(),
+        elasticsearch: stringToBooleanIfDefined(configuration.elasticsearch),
+        phpmyadmin: stringToBooleanIfDefined(configuration.phpmyadmin),
+        xdebug: stringToBooleanIfDefined(configuration.xdebug),
+        mailpit: stringToBooleanIfDefined(configuration.mailpit),
+        'media-redirect-domain': configuration['media-redirect-domain']?.toString(),
+        photon: stringToBooleanIfDefined(configuration.photon),
+        cron: stringToBooleanIfDefined(configuration.cron),
+        overrides: configuration.overrides?.toString(),
+        meta: configurationMeta,
+    };
+    // Remove undefined values
+    Object.keys(sanitizedConfiguration).forEach(
+    // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+    key => sanitizedConfiguration[key] === undefined && delete sanitizedConfiguration[key]);
+    return sanitizedConfiguration;
 }
 function adjustRelativePaths(configuration, configurationFilePath) {
-  const configurationDirectory = _nodePath.default.resolve(_nodePath.default.dirname(configurationFilePath));
-  const imageOption = ['demo', 'image'];
-  for (const option of ['app-code', 'mu-plugins']) {
-    const value = configuration[option];
-    if (value && !imageOption.includes(value)) {
-      configuration[option] = _nodePath.default.isAbsolute(value) ? value : _nodePath.default.join(configurationDirectory, value);
+    const configurationDirectory = node_path_1.default.resolve(node_path_1.default.dirname(configurationFilePath));
+    const imageOption = ['demo', 'image'];
+    for (const option of ['app-code', 'mu-plugins']) {
+        const value = configuration[option];
+        if (value && !imageOption.includes(value)) {
+            configuration[option] = node_path_1.default.isAbsolute(value)
+                ? value
+                : node_path_1.default.join(configurationDirectory, value);
+        }
     }
-  }
-  return configuration;
+    return configuration;
 }
 function mergeConfigurationFileOptions(preselectedOptions, configurationFileOptions) {
-  // configurationFileOptions holds different parameters than present in
-  // preselectedOptions like "slug", and friendly-named parameters (e.g.
-  // 'app-code' vs 'appCode'). Selectively merge configurationFileOptions
-  // parameters into preselectedOptions.
-  const configurationFileInstanceOptions = {
-    title: configurationFileOptions.title,
-    multisite: configurationFileOptions.multisite,
-    php: configurationFileOptions.php,
-    wordpress: configurationFileOptions.wordpress,
-    muPlugins: configurationFileOptions['mu-plugins'],
-    appCode: configurationFileOptions['app-code'],
-    elasticsearch: configurationFileOptions.elasticsearch,
-    phpmyadmin: configurationFileOptions.phpmyadmin,
-    xdebug: configurationFileOptions.xdebug,
-    xdebugConfig: configurationFileOptions['xdebug-config'],
-    mailpit: configurationFileOptions.mailpit,
-    mediaRedirectDomain: configurationFileOptions['media-redirect-domain'],
-    photon: configurationFileOptions.photon,
-    cron: configurationFileOptions.cron,
-    overrides: configurationFileOptions.overrides
-  };
-  const mergedOptions = {};
-  Object.keys(configurationFileInstanceOptions).forEach(key => {
-    // preselectedOptions (supplied from command-line) override configurationFileOptions
-    if (preselectedOptions[key] !== undefined) {
-      mergedOptions[key] = preselectedOptions[key];
-    } else if (configurationFileInstanceOptions[key] !== undefined) {
-      mergedOptions[key] = configurationFileInstanceOptions[key];
-    }
-  });
-  return mergedOptions;
+    // configurationFileOptions holds different parameters than present in
+    // preselectedOptions like "slug", and friendly-named parameters (e.g.
+    // 'app-code' vs 'appCode'). Selectively merge configurationFileOptions
+    // parameters into preselectedOptions.
+    const configurationFileInstanceOptions = {
+        title: configurationFileOptions.title,
+        multisite: configurationFileOptions.multisite,
+        php: configurationFileOptions.php,
+        wordpress: configurationFileOptions.wordpress,
+        muPlugins: configurationFileOptions['mu-plugins'],
+        appCode: configurationFileOptions['app-code'],
+        elasticsearch: configurationFileOptions.elasticsearch,
+        phpmyadmin: configurationFileOptions.phpmyadmin,
+        xdebug: configurationFileOptions.xdebug,
+        xdebugConfig: configurationFileOptions['xdebug-config'],
+        mailpit: configurationFileOptions.mailpit,
+        mediaRedirectDomain: configurationFileOptions['media-redirect-domain'],
+        photon: configurationFileOptions.photon,
+        cron: configurationFileOptions.cron,
+        overrides: configurationFileOptions.overrides,
+    };
+    const mergedOptions = {};
+    Object.keys(configurationFileInstanceOptions).forEach(key => {
+        // preselectedOptions (supplied from command-line) override configurationFileOptions
+        if (preselectedOptions[key] !== undefined) {
+            mergedOptions[key] = preselectedOptions[key];
+        }
+        else if (configurationFileInstanceOptions[key] !== undefined) {
+            mergedOptions[key] = configurationFileInstanceOptions[key];
+        }
+    });
+    return mergedOptions;
 }
 async function findConfigurationFile() {
-  let currentPath = process.cwd();
-  const rootPath = _nodePath.default.parse(currentPath).root;
-  let depth = 0;
-  const maxDepth = 64;
-  const locations = [];
-  while (currentPath !== rootPath && depth < maxDepth) {
-    locations.push({
-      dir: _nodePath.default.join(currentPath, _devEnvironmentCli.CONFIGURATION_FOLDER),
-      file: _nodePath.default.join(currentPath, _devEnvironmentCli.CONFIGURATION_FOLDER, CONFIGURATION_TEMPLATE_FILE_NAME),
-      template: true
-    }, {
-      dir: _nodePath.default.join(currentPath, _devEnvironmentCli.CONFIGURATION_FOLDER),
-      file: _nodePath.default.join(currentPath, _devEnvironmentCli.CONFIGURATION_FOLDER, CONFIGURATION_FILE_NAME),
-      template: false
-    }, {
-      dir: currentPath,
-      file: _nodePath.default.join(currentPath, '.' + CONFIGURATION_TEMPLATE_FILE_NAME),
-      template: true
-    }, {
-      dir: currentPath,
-      file: _nodePath.default.join(currentPath, '.' + CONFIGURATION_FILE_NAME),
-      template: false
-    });
-
-    // Move up one directory
-    currentPath = _nodePath.default.dirname(currentPath);
-
-    // Use depth as a sanity check to avoid an infitite loop
-    ++depth;
-  }
-  for (const {
-    dir,
-    file,
-    template
-  } of locations) {
-    let contents;
-    try {
-      // eslint-disable-next-line no-await-in-loop
-      contents = await (0, _promises.readFile)(file, 'utf8');
-    } catch (error) {
-      const err = error instanceof Error ? error : new Error('Unknown error');
-      debug(`Error reading file ${file}: ${err.message}`);
-      continue;
+    let currentPath = process.cwd();
+    const rootPath = node_path_1.default.parse(currentPath).root;
+    let depth = 0;
+    const maxDepth = 64;
+    const locations = [];
+    while (currentPath !== rootPath && depth < maxDepth) {
+        locations.push({
+            dir: node_path_1.default.join(currentPath, dev_environment_cli_1.CONFIGURATION_FOLDER),
+            file: node_path_1.default.join(currentPath, dev_environment_cli_1.CONFIGURATION_FOLDER, exports.CONFIGURATION_TEMPLATE_FILE_NAME),
+            template: true,
+        }, {
+            dir: node_path_1.default.join(currentPath, dev_environment_cli_1.CONFIGURATION_FOLDER),
+            file: node_path_1.default.join(currentPath, dev_environment_cli_1.CONFIGURATION_FOLDER, exports.CONFIGURATION_FILE_NAME),
+            template: false,
+        }, {
+            dir: currentPath,
+            file: node_path_1.default.join(currentPath, '.' + exports.CONFIGURATION_TEMPLATE_FILE_NAME),
+            template: true,
+        }, {
+            dir: currentPath,
+            file: node_path_1.default.join(currentPath, '.' + exports.CONFIGURATION_FILE_NAME),
+            template: false,
+        });
+        // Move up one directory
+        currentPath = node_path_1.default.dirname(currentPath);
+        // Use depth as a sanity check to avoid an infitite loop
+        ++depth;
     }
-    if (template) {
-      const stripped = contents.replace(ALLOWED_CONFIG_DIR_TEMPLATE, '');
-      if (EJS_TEMPLATE_TAG.test(stripped)) {
-        exit.withError(`EJS JavaScript is not supported in dev-env configuration file ${file}. ` + 'Use plain YAML, or only the supported <%= configDir %> placeholder.');
-      }
-      const rendered = contents.replace(ALLOWED_CONFIG_DIR_TEMPLATE, () => dir);
-      return {
-        configurationPath: file,
-        configurationContents: rendered
-      };
+    for (const { dir, file, template } of locations) {
+        let contents;
+        try {
+            // eslint-disable-next-line no-await-in-loop
+            contents = await (0, promises_1.readFile)(file, 'utf8');
+        }
+        catch (error) {
+            const err = error instanceof Error ? error : new Error('Unknown error');
+            debug(`Error reading file ${file}: ${err.message}`);
+            continue;
+        }
+        if (template) {
+            const stripped = contents.replace(ALLOWED_CONFIG_DIR_TEMPLATE, '');
+            if (EJS_TEMPLATE_TAG.test(stripped)) {
+                exit.withError(`EJS JavaScript is not supported in dev-env configuration file ${file}. ` +
+                    'Use plain YAML, or only the supported <%= configDir %> placeholder.');
+            }
+            const rendered = contents.replace(ALLOWED_CONFIG_DIR_TEMPLATE, () => dir);
+            return { configurationPath: file, configurationContents: rendered };
+        }
+        return { configurationPath: file, configurationContents: contents };
     }
-    return {
-      configurationPath: file,
-      configurationContents: contents
-    };
-  }
-  return false;
+    return false;
 }
 const CONFIGURATION_FILE_VERSIONS = ['1'];
 function getAllConfigurationFileVersions() {
-  return CONFIGURATION_FILE_VERSIONS;
+    return CONFIGURATION_FILE_VERSIONS;
 }
 function getLatestConfigurationFileVersion() {
-  return CONFIGURATION_FILE_VERSIONS[CONFIGURATION_FILE_VERSIONS.length - 1];
+    return CONFIGURATION_FILE_VERSIONS[CONFIGURATION_FILE_VERSIONS.length - 1];
 }
 function isValidConfigurationFileVersion(version) {
-  return CONFIGURATION_FILE_VERSIONS.includes(version);
+    return CONFIGURATION_FILE_VERSIONS.includes(version);
 }
 function getConfigurationFileExample() {
-  return `configuration-version: ${getLatestConfigurationFileVersion()}
+    return `configuration-version: ${getLatestConfigurationFileVersion()}
 slug: dev-site
 title: Dev Site
 php: 8.2
@@ -230,4 +263,4 @@ mailpit: false
 photon: false
 cron: false
 `;
-}
+}