@automattic/vip 3.12.2 → 3.13.0

package/assets/dev-env.lando.template.yml.ejs

@@ -35,6 +35,8 @@ services:
       image: <%= php %>
       command: run.sh
       working_dir: /wp
+      env_file:
+        - .env
       environment:
         XDEBUG: <%= xdebug ? 'enable' : 'disable' %>
 <% if ( xdebugConfig ) { %>

package/dist/bin/vip-config-envvar-delete.js

@@ -81,4 +81,4 @@ async function deleteEnvVarCommand(arg, opt) {
   envContext: true,
   requiredArgs: 1,
   usage: `${baseUsage} <VARIABLE_NAME>`
-}).examples(examples).option('skip-confirmation', 'Skip manual confirmation of input (USE WITH CAUTION)', false).argv(process.argv, deleteEnvVarCommand);
+}).examples(examples).option('skip-confirmation', 'Skip the confirmation prompt (USE WITH CAUTION).', false).argv(process.argv, deleteEnvVarCommand);

package/dist/bin/vip-config-envvar-set.js

@@ -100,4 +100,4 @@ async function setEnvVarCommand(arg, opt) {
   envContext: true,
   requiredArgs: 1,
   usage: `${baseUsage} <VARIABLE_NAME>`
-}).option('from-file', 'Read environment variable value from file (useful for multiline input)').option('skip-confirmation', 'Skip manual confirmation of input (USE WITH CAUTION)', false).examples(examples).argv(process.argv, setEnvVarCommand);
+}).option('from-file', 'Read environment variable value from a UTF-8-encoded text file (useful for multiline input). Accepts a relative or absolute path.').option('skip-confirmation', 'Skip the confirmation prompt (USE WITH CAUTION).', false).examples(examples).argv(process.argv, setEnvVarCommand);

package/dist/bin/vip-config-envvar.js

@@ -8,8 +8,8 @@ const exampleUsage = 'vip @example-app.develop config envvar';
 
 // Command examples
 const examples = [{
-  usage: `${exampleUsage} delete MY_VARIABLE`,
-  description: 'Delete the environment variable "MY_VARIABLE" from the environment.'
+  usage: `${exampleUsage} set MY_VARIABLE`,
+  description: 'Add or update the environment variable "MY_VARIABLE" and assign its value at the prompt.'
 }, {
   usage: `${exampleUsage} get MY_VARIABLE`,
   description: 'Retrieve the value of the environment variable "MY_VARIABLE".'
@@ -20,8 +20,8 @@ const examples = [{
   usage: `${exampleUsage} list`,
   description: 'List the names of all environment variables.'
 }, {
-  usage: `${exampleUsage} set MY_VARIABLE`,
-  description: 'Add or update the environment variable "MY_VARIABLE" and assign its value at the prompt.'
+  usage: `${exampleUsage} delete MY_VARIABLE`,
+  description: 'Delete the environment variable "MY_VARIABLE" from the environment.'
 }];
 (0, _command.default)({
   requiredArgs: 0,

package/dist/bin/vip-dev-env-create.js

@@ -69,10 +69,13 @@ cmd.argv(process.argv, async (arg, opt) => {
   let defaultOptions = {};
   /** @type {Record<string,import('../lib/dev-environment/types').IntegrationConfig>} */
   let integrationsConfig = {};
+  /** @type {Record<string,string>} */
+  let envVars = {};
   try {
     if (opt.app) {
       const appInfo = await (0, _devEnvironmentCore.getApplicationInformation)(opt.app, opt.env);
       integrationsConfig = appInfo.environment?.integrations ?? {};
+      envVars = appInfo.environment?.envVars ?? {};
       defaultOptions = (0, _devEnvironmentCli.getOptionsFromAppInfo)(appInfo);
     }
   } catch (error) {
@@ -90,7 +93,7 @@ cmd.argv(process.argv, async (arg, opt) => {
   const instanceData = await (0, _devEnvironmentCli.promptForArguments)(preselectedOptions, defaultOptions, suppressPrompts, true);
   instanceData.siteSlug = slug;
   try {
-    await (0, _devEnvironmentCore.createEnvironment)(lando, instanceData, integrationsConfig);
+    await (0, _devEnvironmentCore.createEnvironment)(lando, instanceData, integrationsConfig, envVars);
     await (0, _devEnvironmentCore.printEnvironmentInfo)(lando, slug, {
       extended: false,
       suppressWarnings: true

package/dist/bin/vip-dev-env-start.js

@@ -21,17 +21,24 @@ const examples = [{
   usage: `${exampleUsage} --skip-rebuild --slug=example-site`,
   description: 'Start only the services of a local environment that are not currently in a running state.'
 }, {
-  usage: `${exampleUsage} --vscode --slug=example-site`,
+  usage: `${exampleUsage} --editor=vscode --slug=example-site`,
   description: 'Start a local environment and generate a Workspace file for developing in Visual Studio Code.'
+}, {
+  usage: `${exampleUsage} --editor=cursor --slug=example-site`,
+  description: 'Start a local environment and generate a Workspace file for developing in Cursor Editor.'
+}, {
+  usage: `${exampleUsage} --editor=phpstorm --slug=example-site`,
+  description: 'Start a local environment and generate a Workspace file for developing in PhpStorm.'
 }];
 (0, _command.default)({
   usage
-}).option('slug', 'A unique name for a local environment. Default is "vip-local".', undefined, _devEnvironmentCli.processSlug).option('skip-rebuild', 'Only start services that are not in a running state.').option(['w', 'skip-wp-versions-check'], 'Skip the prompt to update WordPress; occurs if the last major release version is not configured.').option('vscode', 'Generate a Visual Studio Code Workspace file.').examples(examples).argv(process.argv, async (arg, opt) => {
+}).option('slug', 'A unique name for a local environment. Default is "vip-local".', undefined, _devEnvironmentCli.processSlug).option('skip-rebuild', 'Only start services that are not in a running state.').option(['w', 'skip-wp-versions-check'], 'Skip the prompt to update WordPress; occurs if the last major release version is not configured.').option('vscode', 'Generate a Visual Studio Code Workspace file (deprecated, use --editor=vscode instead).').option('editor', 'Generate a workspace file for the specified editor (supports: vscode, cursor, windsurf, phpstorm).').examples(examples).argv(process.argv, async (arg, opt) => {
   const slug = await (0, _devEnvironmentCli.getEnvironmentName)(opt);
   const lando = await (0, _devEnvironmentLando.bootstrapLando)();
   (0, _devEnvironmentCli.validateDependencies)(lando);
   const startProcessing = new Date();
   const trackingInfo = (0, _devEnvironmentCli.getEnvTrackingInfo)(slug);
+  trackingInfo.editor = opt.editor || (opt.vscode ? 'vscode' : undefined);
   trackingInfo.vscode = Boolean(opt.vscode);
   trackingInfo.docker = lando.config.versions.engine;
   trackingInfo.docker_compose = lando.config.versions.compose;
@@ -55,6 +62,7 @@ const examples = [{
     process.exitCode = 1;
   }
   (0, _devEnvironmentCli.postStart)(slug, {
-    openVSCode: Boolean(opt.vscode)
+    editor: opt.editor,
+    vscode: Boolean(opt.vscode)
   });
 });

package/dist/bin/vip-dev-env.js

@@ -3,6 +3,10 @@
 
 var _command = _interopRequireDefault(require("../lib/cli/command"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+if (process.getuid?.() === 0) {
+  console.error('This script should not be run as root. Exiting.');
+  process.exit(1);
+}
 (0, _command.default)({
   requiredArgs: 0
 }).command('create', 'Create a new local environment.').command('update', 'Update the settings of a local environment.').command('start', 'Start a local environment.').command('stop', 'Stop a local environment.').command('destroy', 'Remove a local environment.').command('info', 'Retrieve information about a local environment.').command('list', 'Retrieve information about all local environments.').command('exec', 'Run a WP-CLI command against a local environment.').command('import', 'Import media or database files to a local environment.').command('shell', 'Create a shell and run commands against a local environment.').command('logs', 'Retrieve logs for a local environment.').command('sync', 'Sync the database of a VIP Platform environment to a local environment.').command('purge', 'Remove all local environments.').argv(process.argv);

package/dist/bin/vip-sync.js

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 "use strict";
 
+var _singleLineLog = require("@wwa/single-line-log");
 var _chalk = _interopRequireDefault(require("chalk"));
 var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
-var _singleLineLog = require("single-line-log");
 var _api = _interopRequireDefault(require("../lib/api"));
 var _app2 = _interopRequireDefault(require("../lib/api/app"));
 var _command = _interopRequireDefault(require("../lib/cli/command"));

package/dist/commands/dev-env-sync-sql.js

@@ -67,8 +67,9 @@ async function extractSiteUrls(sqlFile) {
   return new Promise((resolve, reject) => {
     const urls = new Set();
     readInterface.on('line', line => {
-      const url = findSiteHomeUrl(line);
+      let url = findSiteHomeUrl(line);
       if (url) {
+        url = url.replace(/\/$/, '');
         urls.add(url);
       }
     });
@@ -178,7 +179,7 @@ class DevEnvSyncSQLCommand {
       if (!site?.blogId || site.blogId === 1) continue;
       const url = site?.homeUrl;
       if (!url) continue;
-      const strippedUrl = stripProtocol(url);
+      const strippedUrl = stripProtocol(url).replace(/\/$/, '');
       if (!this.searchReplaceMap[strippedUrl]) continue;
       const domain = new URL(url).hostname;
       const newDomain = primaryDomain === domain ? this.landoDomain : `${this.slugifyDomain(domain)}.${this.landoDomain}`;

package/dist/lib/cli/progress.js

@@ -2,8 +2,8 @@
 
 exports.__esModule = true;
 exports.StepStatus = exports.ProgressTracker = void 0;
+var _singleLineLog = require("@wwa/single-line-log");
 var _nodeOs = require("node:os");
-var _singleLineLog = require("single-line-log");
 var _format = require("../../lib/cli/format");
 const PRINT_INTERVAL = process.env.DEBUG ? 5000 : 200; // How often the report is printed. Mainly affects the "spinner" animation.
 let StepStatus = exports.StepStatus = /*#__PURE__*/function (StepStatus) {

package/dist/lib/dev-environment/dev-environment-cli.js

@@ -23,6 +23,7 @@ exports.promptForComponent = promptForComponent;
 exports.promptForMultisite = promptForMultisite;
 exports.promptForPhpVersion = promptForPhpVersion;
 exports.promptForText = promptForText;
+exports.promptForURL = promptForURL;
 exports.promptForWordPress = promptForWordPress;
 exports.resolvePath = resolvePath;
 exports.resolvePhpVersion = resolvePhpVersion;
@@ -161,7 +162,7 @@ function processComponentOptionInput(passedParam, allowLocal) {
   }
   return {
     mode: 'image',
-    tag: param === 'demo' ? undefined : param
+    tag: param === 'demo' || param === 'image' ? undefined : param
   };
 }
 function getOptionsFromAppInfo(appInfo) {
@@ -190,6 +191,13 @@ function getOptionsFromAppInfo(appInfo) {
 // eslint-disable-next-line complexity
 async function promptForArguments(preselectedOptions, defaultOptions, suppressPrompts, create) {
   debug('Provided preselected', preselectedOptions, 'and default', defaultOptions);
+  let isVIPUser;
+  try {
+    const currentUser = await (0, _user.getCurrentUserInfo)(true);
+    isVIPUser = currentUser?.isVIP ?? false;
+  } catch (err) {
+    isVIPUser = false;
+  }
   if (suppressPrompts) {
     preselectedOptions = {
       ...defaultOptions,
@@ -208,7 +216,7 @@ async function promptForArguments(preselectedOptions, defaultOptions, suppressPr
     elasticsearch: false,
     php: preselectedOptions.php ? resolvePhpVersion(preselectedOptions.php) : await promptForPhpVersion(resolvePhpVersion(defaultOptions.php ?? _devEnvironment.DEV_ENVIRONMENT_DEFAULTS.phpVersion)),
     mariadb: preselectedOptions.mariadb ?? defaultOptions.mariadb,
-    mediaRedirectDomain: preselectedOptions.mediaRedirectDomain ?? '',
+    mediaRedirectDomain: preselectedOptions.mediaRedirectDomain ?? defaultOptions.mediaRedirectDomain ?? '',
     wordpress: {
       mode: 'image',
       tag: ''
@@ -241,16 +249,19 @@ async function promptForArguments(preselectedOptions, defaultOptions, suppressPr
     if (setMediaRedirectDomain) {
       instanceData.mediaRedirectDomain = defaultOptions.mediaRedirectDomain;
     }
-  }
-  instanceData.wordpress = await processWordPress((preselectedOptions.wordpress ?? '').toString(), (defaultOptions.wordpress ?? '').toString());
-  for (const component of _devEnvironment.DEV_ENVIRONMENT_COMPONENTS) {
-    const option = (preselectedOptions[component] ?? '').toString();
-    const defaultValue = (defaultOptions[component] ?? '').toString();
-
-    // eslint-disable-next-line no-await-in-loop
-    const result = await processComponent(component, option, defaultValue, suppressPrompts);
-    instanceData[component] = result;
-  }
+  } else if (!create && defaultOptions.mediaRedirectDomain) {
+    const mediaRedirectPromptText = 'URL to redirect for missing media files ("n" to disable)?';
+    const mediaRedirectDomain = await promptForURL(mediaRedirectPromptText, defaultOptions.mediaRedirectDomain);
+    instanceData.mediaRedirectDomain = mediaRedirectDomain;
+  }
+  instanceData.wordpress = await processWordPress(preselectedOptions.wordpress ?? '', defaultOptions.wordpress ?? '');
+  instanceData.appCode = await processComponent('appCode', preselectedOptions.appCode ?? '', defaultOptions.appCode ?? '', suppressPrompts, validateAppCodeLocalPath);
+  let preselectedMU = preselectedOptions.muPlugins;
+  const defaultMU = defaultOptions.muPlugins;
+  if (!preselectedMU && !isVIPUser && (!defaultMU || ['demo', 'image'].includes(defaultMU))) {
+    preselectedMU = 'image';
+  }
+  instanceData.muPlugins = await processComponent('muPlugins', preselectedMU ?? '', defaultMU ?? '', suppressPrompts, validateMuPluginsLocalPath);
   debug(`Processing elasticsearch with preselected "%s"`, preselectedOptions.elasticsearch);
   if ('elasticsearch' in preselectedOptions) {
     instanceData.elasticsearch = Boolean(preselectedOptions.elasticsearch);
@@ -295,48 +306,41 @@ async function processWordPress(preselectedValue, defaultValue) {
   debug(result);
   return result;
 }
-async function processComponent(component, preselectedValue, defaultValue, suppressPrompts = false) {
-  debug(`processing a component '${component}', with preselected/default - ${preselectedValue}/${defaultValue}`);
-  let result;
-  let allowLocal = true;
-  if (component === 'muPlugins') {
-    try {
-      const currentUser = await (0, _user.getCurrentUserInfo)(true);
-      allowLocal = currentUser?.isVIP ?? false;
-    } catch (err) {
-      allowLocal = false;
-    }
+async function processComponent(componentType, preselectedValue, defaultValue, suppressPrompts, localPathValidator) {
+  debug(`Processing the '${componentType}' component, with preselected = %s, default = %s`, preselectedValue, defaultValue);
+  const defaultObject = defaultValue ? processComponentOptionInput(defaultValue, true) : null;
+  if (preselectedValue && !suppressPrompts) {
+    console.log('%s Path to your local %s: %s', _chalk.default.green('✓'), componentDisplayNames[componentType], preselectedValue);
   }
-  const defaultObject = defaultValue ? processComponentOptionInput(defaultValue, allowLocal) : null;
-  if (preselectedValue) {
-    result = processComponentOptionInput(preselectedValue, allowLocal);
-    if (!suppressPrompts) {
-      console.log(`${_chalk.default.green('✓')} Path to your local ${componentDisplayNames[component]}: ${preselectedValue}`);
-    }
-  } else {
-    result = await promptForComponent(component, allowLocal, defaultObject);
+  let result = preselectedValue ? processComponentOptionInput(preselectedValue, true) : await promptForComponent(componentType, true, defaultObject);
+  debug(result);
+  if (result.mode === 'local') {
+    result = await validateLocalPath(result, localPathValidator, componentType, defaultObject);
   }
   debug(result);
-  while ('local' === result.mode) {
-    const resolvedPath = resolvePath(result.dir ?? '');
-    result.dir = resolvedPath;
+  return result;
+}
+async function validateLocalPath(config, validator, componentName, defaultObject) {
+  while (config.mode === 'local') {
+    const resolvedPath = resolvePath(config.dir ?? '');
+    config.dir = resolvedPath;
     const {
       result: isPathValid,
       message
-    } = validateLocalPath(component, resolvedPath);
+    } = validator(resolvedPath);
     if (isPathValid) {
       break;
     } else if (isStdinTTY) {
       console.log(_chalk.default.yellow('Warning:'), message);
       // eslint-disable-next-line no-await-in-loop
-      result = await promptForComponent(component, allowLocal, defaultObject);
+      config = await promptForComponent(componentName, true, defaultObject);
     } else {
       throw new Error(message);
     }
   }
-  return result;
+  return config;
 }
-function validateLocalPath(component, providedPath) {
+function validateMuPluginsLocalPath(providedPath) {
   if (!isNonEmptyDirectory(providedPath)) {
     const message = `Provided path "${providedPath}" does not point to a valid or existing directory.`;
     return {
@@ -344,24 +348,35 @@ function validateLocalPath(component, providedPath) {
       message
     };
   }
-  if (component === 'appCode') {
-    const files = ['languages', 'plugins', 'themes', 'private', 'images', 'client-mu-plugins', 'vip-config'];
-    const missingFiles = [];
-    for (const file of files) {
-      const filePath = _path.default.resolve(providedPath, file);
-      if (!(0, _nodeFs.existsSync)(filePath)) {
-        missingFiles.push(file);
-      }
-    }
-    if (missingFiles.length > 0) {
-      // eslint-disable-next-line max-len
-      const message = `Provided path "${providedPath}" is missing following files/folders: ${missingFiles.join(', ')}. Learn more: https://docs.wpvip.com/wordpress-skeleton/`;
-      return {
-        result: false,
-        message
-      };
+  return {
+    result: true,
+    message: ''
+  };
+}
+function validateAppCodeLocalPath(providedPath) {
+  if (!isNonEmptyDirectory(providedPath)) {
+    const message = `Provided path "${providedPath}" does not point to a valid or existing directory.`;
+    return {
+      result: false,
+      message
+    };
+  }
+  const files = ['languages', 'plugins', 'themes', 'private', 'images', 'client-mu-plugins', 'vip-config'];
+  const missingFiles = [];
+  for (const file of files) {
+    const filePath = _path.default.resolve(providedPath, file);
+    if (!(0, _nodeFs.existsSync)(filePath)) {
+      missingFiles.push(file);
     }
   }
+  if (missingFiles.length > 0) {
+    // eslint-disable-next-line max-len
+    const message = `Provided path "${providedPath}" is missing following files/folders: ${missingFiles.join(', ')}. Learn more: https://docs.wpvip.com/wordpress-skeleton/`;
+    return {
+      result: false,
+      message
+    };
+  }
   return {
     result: true,
     message: ''
@@ -399,6 +414,36 @@ async function promptForText(message, initial) {
   }
   return (result.input || '').trim();
 }
+async function promptForURL(message, initial) {
+  let result = {
+    input: initial
+  };
+  if (isStdinTTY) {
+    const URLValidator = value => {
+      if (!value.trim() || value === 'n') {
+        return true;
+      }
+      try {
+        const url = new URL(value);
+        if (url.protocol !== 'http:' && url.protocol !== 'https:') {
+          return 'value must be a http:// or https:// URL';
+        }
+        return true;
+      } catch {
+        return 'value needs to be a valid URL or an empty string';
+      }
+    };
+    result = await (0, _enquirer.prompt)({
+      type: 'input',
+      name: 'input',
+      message,
+      initial,
+      validate: URLValidator
+    });
+  }
+  const retval = result.input.trim();
+  return retval === 'n' ? '' : retval;
+}
 const multisiteOptions = ['subdomain', 'subdirectory'];
 async function promptForMultisite(message, initial) {
   // `undefined` is used here only because our tests need overhauling
@@ -676,30 +721,92 @@ function getEnvTrackingInfo(slug) {
     };
   }
 }
+// Map of supported editors and their configurations
+const SUPPORTED_EDITORS = {
+  vscode: {
+    displayName: 'VS Code',
+    candidates: ['code', 'code-insiders', 'codium'],
+    workspace: {
+      extension: 'code-workspace',
+      generator: _devEnvironmentCore.generateVSCodeWorkspace
+    }
+  },
+  cursor: {
+    displayName: 'Cursor',
+    candidates: ['cursor'],
+    workspace: {
+      extension: 'code-workspace',
+      generator: _devEnvironmentCore.generateVSCodeWorkspace
+    }
+  },
+  phpstorm: {
+    displayName: 'PHPStorm',
+    candidates: ['phpstorm', 'phpstorm64.exe'],
+    errors: {
+      notFound: `PHPStorm launcher was not detected in the expected path.\nPlease follow the setup instructions: https://www.jetbrains.com/help/phpstorm/working-with-the-ide-features-from-command-line.html#standalone`
+    },
+    workspace: {
+      extension: 'iml',
+      generator: _devEnvironmentCore.generatePHPStormWorkspace
+    }
+  },
+  windsurf: {
+    displayName: 'Windsurf',
+    candidates: ['windsurf'],
+    workspace: {
+      extension: 'code-workspace',
+      generator: _devEnvironmentCore.generateVSCodeWorkspace
+    }
+  }
+};
+
+// Helper to get workspace path for any editor
+function getWorkspacePath(slug, editor) {
+  const {
+    workspace
+  } = SUPPORTED_EDITORS[editor];
+  if (editor === 'phpstorm') {
+    return _path.default.join((0, _devEnvironmentCore.getEnvironmentPath)(slug), '.idea', `${slug}.${workspace.extension}`);
+  }
+  return _path.default.join((0, _devEnvironmentCore.getEnvironmentPath)(slug), `${slug}.${workspace.extension}`);
+}
 function postStart(slug, options) {
-  if (options.openVSCode) {
-    launchVSCode(slug);
+  let editorType;
+  if (options.editor) {
+    const editor = options.editor.toLowerCase();
+    if (!Object.keys(SUPPORTED_EDITORS).includes(editor)) {
+      throw new Error(`Invalid editor specified. Supported editors are: ${Object.keys(SUPPORTED_EDITORS).join(', ')}`);
+    }
+    editorType = editor;
+  } else if (options.vscode) {
+    editorType = 'vscode';
+  }
+  if (editorType) {
+    launchEditor(slug, editorType);
   }
 }
-const launchVSCode = slug => {
-  const workspacePath = (0, _devEnvironmentCore.getVSCodeWorkspacePath)(slug);
+const launchEditor = (slug, type) => {
+  const editorConfig = SUPPORTED_EDITORS[type];
+  const workspacePath = getWorkspacePath(slug, type);
   if ((0, _nodeFs.existsSync)(workspacePath)) {
-    console.log('VS Code workspace already exists, skipping creation.');
+    console.log('Project already exists, skipping creation.');
   } else {
-    (0, _devEnvironmentCore.generateVSCodeWorkspace)(slug);
-    console.log('VS Code workspace generated');
-  }
-  const vsCodeExecutable = getVSCodeExecutable();
-  if (vsCodeExecutable) {
-    (0, _child_process.spawn)(vsCodeExecutable, [workspacePath], {
+    editorConfig.workspace.generator(slug);
+    console.log(`${editorConfig.displayName} project generated`);
+  }
+  console.log(`Project file location:\n${workspacePath}\n`);
+  const executable = findExecutable(editorConfig.candidates);
+  if (executable) {
+    // For PHPStorm, pass the environment home folder instead of the workspace path
+    const launchPath = type === 'phpstorm' ? (0, _devEnvironmentCore.getEnvironmentPath)(slug) : workspacePath;
+    (0, _child_process.spawn)(executable, [launchPath], {
       shell: process.platform === 'win32'
     });
   } else {
-    console.log(`VS Code was not detected in the expected path. VS Code Workspace file location:\n${workspacePath}`);
+    console.log(editorConfig.errors?.notFound || `${editorConfig.displayName} was not detected in the expected path.`);
   }
 };
-const getVSCodeExecutable = () => {
-  const candidates = ['code', 'code-insiders', 'codium'];
+const findExecutable = candidates => {
   for (const candidate of candidates) {
     const result = (0, _shelljs.which)(candidate);
     if (result) {