@automattic/vip 2.28.0 → 2.28.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Changelog
 
+### 2.28.1
+
+- #1123 [dev-env] Add VSCode workspace config on start
+
 ### 2.28.0
 
 - #1343 fix(dev-env): Force image pulling after recovering Landofile

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

@@ -31,7 +31,7 @@ const examples = [{
   usage: `${_devEnvironment.DEV_ENVIRONMENT_FULL_COMMAND} start`,
   description: 'Starts a local dev environment'
 }];
-(0, _command.default)().option('slug', 'Custom name of the dev environment').option('skip-rebuild', 'Only start stopped services').option(['w', 'skip-wp-versions-check'], 'Skip prompting for wordpress update if non latest').examples(examples).argv(process.argv, async (arg, opt) => {
+(0, _command.default)().option('slug', 'Custom name of the dev environment').option('skip-rebuild', 'Only start stopped services').option(['w', 'skip-wp-versions-check'], 'Skip propting for wordpress update if non latest').option('vscode', 'Open environment workspace in VSCode').examples(examples).argv(process.argv, async (arg, opt) => {
   const slug = await (0, _devEnvironmentCli.getEnvironmentName)(opt);
   const lando = await (0, _devEnvironmentLando.bootstrapLando)();
   await (0, _devEnvironmentCli.validateDependencies)(lando, slug);
@@ -69,4 +69,7 @@ const examples = [{
     await (0, _devEnvironmentCli.handleCLIException)(error, 'dev_env_start_command_error', trackingInfo);
     process.exitCode = 1;
   }
+  await (0, _devEnvironmentCli.postStart)(slug, {
+    openVSCode: !!opt.vscode
+  });
 });

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

@@ -12,6 +12,7 @@ exports.getOptionsFromAppInfo = getOptionsFromAppInfo;
 exports.getTagChoices = getTagChoices;
 exports.handleCLIException = handleCLIException;
 exports.handleDeprecatedOptions = handleDeprecatedOptions;
+exports.postStart = postStart;
 exports.printTable = printTable;
 exports.processBooleanOption = processBooleanOption;
 exports.processComponentOptionInput = processComponentOptionInput;
@@ -32,6 +33,8 @@ var _fs = _interopRequireDefault(require("fs"));
 var _path = _interopRequireDefault(require("path"));
 var _os = _interopRequireDefault(require("os"));
 var _dns = _interopRequireDefault(require("dns"));
+var _child_process = require("child_process");
+var _shelljs = require("shelljs");
 var _progress = require("../../lib/cli/progress");
 var _tracker = require("../tracker");
 var _devEnvironment = require("../constants/dev-environment");
@@ -638,6 +641,40 @@ function getEnvTrackingInfo(slug) {
     };
   }
 }
+async function postStart(slug, options) {
+  if (options.openVSCode) {
+    launchVSCode(slug);
+  }
+}
+const launchVSCode = slug => {
+  const workspacePath = (0, _devEnvironmentCore.getVSCodeWorkspacePath)(slug);
+  if (_fs.default.existsSync(workspacePath)) {
+    console.log('VSCode workspace already exists, skipping creation.');
+  } else {
+    (0, _devEnvironmentCore.generateVSCodeWorkspace)(slug);
+    console.log('VSCode workspace generated');
+  }
+  const vsCodeExecutable = getVSCodeExecutable();
+  if (vsCodeExecutable) {
+    (0, _child_process.spawn)(vsCodeExecutable, [workspacePath], {
+      shell: process.platform === 'win32'
+    });
+  } else {
+    console.log(`VSCode not detected in path, please open ${workspacePath} with VSCode`);
+  }
+};
+const getVSCodeExecutable = () => {
+  const candidates = ['code', 'code-insiders', 'codium'];
+  for (const candidate of candidates) {
+    const result = (0, _shelljs.which)(candidate);
+    if (result) {
+      debug(`Found ${candidate} in path`);
+      return candidate;
+    }
+    debug(`Could not find ${candidate} in path`);
+  }
+  return null;
+};
 function handleDeprecatedOptions(opts) {
   if (opts.mailhog) {
     console.warn(_chalk.default.yellow('Warning: --mailhog is deprecated and will be removed in a future release. Please use --mailpit instead.'));

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

@@ -8,9 +8,11 @@ exports.destroyEnvironment = destroyEnvironment;
 exports.doesEnvironmentExist = doesEnvironmentExist;
 exports.exec = exec;
 exports.fetchVersionList = fetchVersionList;
+exports.generateVSCodeWorkspace = generateVSCodeWorkspace;
 exports.getAllEnvironmentNames = getAllEnvironmentNames;
 exports.getApplicationInformation = getApplicationInformation;
 exports.getEnvironmentPath = getEnvironmentPath;
+exports.getVSCodeWorkspacePath = getVSCodeWorkspacePath;
 exports.getVersionList = getVersionList;
 exports.importMediaPath = importMediaPath;
 exports.printAllEnvironmentsInfo = printAllEnvironmentsInfo;
@@ -629,4 +631,70 @@ async function getVersionList() {
       prerelease: true
     }];
   }
+}
+
+/**
+ * Functions generates workspace config including the launch config
+ *
+ * @param {string} slug - The slug of the environment to generate workspace config for
+ * @return {string} Workspace path
+ */
+function generateVSCodeWorkspace(slug) {
+  var _instanceData$muPlugi, _instanceData$appCode;
+  debug('Generating VSCode Workspace');
+  const location = getEnvironmentPath(slug);
+  const workspacePath = getVSCodeWorkspacePath(slug);
+  const instanceData = readEnvironmentData(slug);
+  const pathMappings = generatePathMappings(location, instanceData);
+  const folders = [{
+    path: location
+  }];
+  if ((_instanceData$muPlugi = instanceData.muPlugins) !== null && _instanceData$muPlugi !== void 0 && _instanceData$muPlugi.dir) {
+    folders.push({
+      path: instanceData.muPlugins.dir
+    });
+  }
+  if ((_instanceData$appCode = instanceData.appCode) !== null && _instanceData$appCode !== void 0 && _instanceData$appCode.dir) {
+    folders.push({
+      path: instanceData.appCode.dir
+    });
+  }
+  const workspace = {
+    folders,
+    launch: {
+      version: '0.2.0',
+      configurations: [{
+        name: `Debug ${slug}`,
+        type: 'php',
+        request: 'launch',
+        port: 9003,
+        pathMappings
+      }]
+    }
+  };
+  _fs.default.writeFileSync(workspacePath, JSON.stringify(workspace, null, 2));
+  return workspacePath;
+}
+const generatePathMappings = (location, instanceData) => {
+  var _instanceData$muPlugi2, _instanceData$appCode2;
+  const pathMappings = {};
+  if ((_instanceData$muPlugi2 = instanceData.muPlugins) !== null && _instanceData$muPlugi2 !== void 0 && _instanceData$muPlugi2.dir) {
+    pathMappings['/wp/wp-content/mu-plugins'] = instanceData.muPlugins.dir;
+  }
+  if ((_instanceData$appCode2 = instanceData.appCode) !== null && _instanceData$appCode2 !== void 0 && _instanceData$appCode2.dir) {
+    pathMappings['/wp/wp-content/client-mu-plugins'] = _path.default.resolve(instanceData.appCode.dir, 'client-mu-plugins');
+    pathMappings['/wp/wp-content/images'] = _path.default.resolve(instanceData.appCode.dir, 'images');
+    pathMappings['/wp/wp-content/languages'] = _path.default.resolve(instanceData.appCode.dir, 'languages');
+    pathMappings['/wp/wp-content/plugins'] = _path.default.resolve(instanceData.appCode.dir, 'plugins');
+    pathMappings['/wp/wp-content/private'] = _path.default.resolve(instanceData.appCode.dir, 'private');
+    pathMappings['/wp/wp-content/themes'] = _path.default.resolve(instanceData.appCode.dir, 'themes');
+    pathMappings['/wp/wp-content/vip-config'] = _path.default.resolve(instanceData.appCode.dir, 'vip-config');
+  }
+  pathMappings['/wp'] = _path.default.resolve(location, 'wordpress');
+  return pathMappings;
+};
+function getVSCodeWorkspacePath(slug) {
+  const location = getEnvironmentPath(slug);
+  const workspacePath = _path.default.join(location, `${slug}.code-workspace`);
+  return workspacePath;
 }

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@automattic/vip",
-  "version": "2.28.0",
+  "version": "2.28.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@automattic/vip",
-      "version": "2.28.0",
+      "version": "2.28.1",
       "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {
@@ -35,6 +35,7 @@
         "proxy-from-env": "^1.1.0",
         "rollbar": "2.22.0",
         "semver": "7.3.8",
+        "shelljs": "^0.8.5",
         "single-line-log": "1.1.2",
         "socket.io-client": "^4.5.3",
         "socket.io-stream": "npm:@wearemothership/socket.io-stream@^0.9.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automattic/vip",
-  "version": "2.28.0",
+  "version": "2.28.1",
   "description": "The VIP Javascript library & CLI",
   "main": "index.js",
   "bin": {
@@ -136,6 +136,7 @@
     "proxy-from-env": "^1.1.0",
     "rollbar": "2.22.0",
     "semver": "7.3.8",
+    "shelljs": "^0.8.5",
     "single-line-log": "1.1.2",
     "socket.io-client": "^4.5.3",
     "socket.io-stream": "npm:@wearemothership/socket.io-stream@^0.9.1",