@automattic/vip 2.7.0-dev1 → 2.8.0-alpha

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automattic/vip",
-  "version": "2.7.0-dev1",
+  "version": "2.8.0-alpha",
   "description": "The VIP Javascript library & CLI",
   "main": "index.js",
   "bin": {
@@ -23,6 +23,7 @@
     "vip-dev-env-import-media": "dist/bin/vip-dev-env-import-media.js",
     "vip-dev-env-import-sql": "dist/bin/vip-dev-env-import-sql.js",
     "vip-dev-env-info": "dist/bin/vip-dev-env-info.js",
+    "vip-dev-env-list": "dist/bin/vip-dev-env-list.js",
     "vip-dev-env-start": "dist/bin/vip-dev-env-start.js",
     "vip-dev-env-stop": "dist/bin/vip-dev-env-stop.js",
     "vip-import": "dist/bin/vip-import.js",
@@ -36,6 +37,7 @@
     "vip-logs": "dist/bin/vip-logs.js",
     "vip-search-replace": "dist/bin/vip-search-replace.js",
     "vip-sync": "dist/bin/vip-sync.js",
+    "vip-whoami": "dist/bin/vip-whoami.js",
     "vip-wp": "dist/bin/vip-wp.js"
   },
   "scripts": {
@@ -109,7 +111,7 @@
     "cli-columns": "^4.0.0",
     "cli-table": "github:automattic/cli-table#7b14232",
     "configstore": "5.0.1",
-    "debug": "4.3.2",
+    "debug": "4.3.3",
     "ejs": "^3.1.6",
     "enquirer": "2.3.6",
     "graphql": "15.5.1",
@@ -117,7 +119,7 @@
     "ini": "2.0.0",
     "json2csv": "5.0.6",
     "jwt-decode": "2.2.0",
-    "lando": "git+https://github.com/Automattic/lando-cli.git#v3.5.1-patch2021_11_22",
+    "lando": "git+https://github.com/Automattic/lando-cli.git#v3.5.1-patch2021_12_06",
     "node-fetch": "^2.6.1",
     "opn": "5.5.0",
     "rollbar": "2.22.0",

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

@@ -1,41 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * 
- * @fomat
- */
-
-/**
- * External dependencies
- */
-"use strict";
-
-var _debug = _interopRequireDefault(require("debug"));
-
-var _chalk = _interopRequireDefault(require("chalk"));
-
-var _command = _interopRequireDefault(require("../lib/cli/command"));
-
-var _devEnvironment = require("../lib/dev-environment");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * Internal dependencies
- */
-const debug = (0, _debug.default)('@automattic/vip:bin:dev-environment'); // Command examples
-
-const examples = [{
-  usage: 'vip dev-environment start',
-  description: 'Starts local dev environment\n' + '       * If the environment isn\'t built yet it will build it as well'
-}];
-(0, _command.default)().option('slug', `Custom name of the dev environment (default: "${_devEnvironment.defaults.environmentSlug}")`).option('title', 'Title for the WordPress site (default: "VIP Dev")').option('multisite', 'Enable multisite install').option('php', 'Use a specific PHP version').option('wordpress', 'Use a specific WordPress version or local directory (default: last stable)').option('mu-plugins', 'Use a specific mu-plugins changeset or local directory (default: "auto": last commit in master)').option('jetpack', 'Use a specific Jetpack from a local directory (default: "mu": use the version in mu-plugins)').option('client-code', 'Use the client code from a local directory or VIP skeleton (default: use the VIP skeleton)').examples(examples).argv(process.argv, async (arg, opt) => {
-  const slug = opt.slug || _devEnvironment.defaults.environmentSlug;
-  debug('Args: ', arg, 'Options: ', opt);
-
-  try {
-    await (0, _devEnvironment.startEnvironment)(slug, opt);
-  } catch (e) {
-    console.log(_chalk.default.red('Error:'), e.message);
-  }
-});

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

@@ -1,23 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * 
- * @fomat
- */
-
-/**
- * External dependencies
- */
-
-/**
- * Internal dependencies
- */
-"use strict";
-
-var _command = _interopRequireDefault(require("../lib/cli/command"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-(0, _command.default)({
-  requiredArgs: 1
-}).command('start', 'Start the local dev environment').argv(process.argv);

package/dist/lib/dev-environment.js

@@ -1,194 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.startEnvironment = startEnvironment;
-exports.generateInstanceData = generateInstanceData;
-exports.getEnvironmentPath = getEnvironmentPath;
-exports.defaults = void 0;
-
-var _debug = _interopRequireDefault(require("debug"));
-
-var _xdgBasedir = _interopRequireDefault(require("xdg-basedir"));
-
-var _os = _interopRequireDefault(require("os"));
-
-var _fs = _interopRequireDefault(require("fs"));
-
-var _ejs = _interopRequireDefault(require("ejs"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _lando = _interopRequireDefault(require("lando/lib/lando"));
-
-var _utils = _interopRequireDefault(require("lando/plugins/lando-core/lib/utils"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * 
- * @format
- */
-
-/**
- * External dependencies
- */
-
-/**
- * Internal dependencies
- */
-const debug = (0, _debug.default)('@automattic/vip:bin:dev-environment');
-const containerImages = {
-  wordpress: {
-    image: 'wpvipdev/wordpress',
-    tag: '5.6'
-  },
-  jetpack: {
-    image: 'wpvipdev/jetpack'
-  },
-  muPlugins: {
-    image: 'wpvipdev/mu-plugins',
-    tag: 'auto'
-  },
-  clientCode: {
-    image: 'wpvipdev/skeleton',
-    tag: '181a17d9aedf7da73730d65ccef3d8dbf172a5c5'
-  }
-};
-const defaults = {
-  environmentSlug: 'vip-local',
-  title: 'VIP Dev',
-  multisite: false,
-  phpVersion: '7.3',
-  jetpack: {
-    mode: 'inherit'
-  },
-  wordpress: {},
-  muPlugins: {},
-  clientCode: {}
-};
-exports.defaults = defaults;
-['wordpress', 'muPlugins', 'clientCode'].forEach(type => {
-  defaults[type] = {
-    mode: 'image',
-    image: containerImages[type].image,
-    tag: containerImages[type].tag
-  };
-});
-const landoFileTemplatePath = 'assets/dev-environment.lando.template.yml.ejs';
-const landoFileName = '.lando.yml';
-
-async function startEnvironment(slug, options) {
-  debug('Will start an environment', slug, 'with options: ', options);
-  const instancePath = getEnvironmentPath(slug);
-
-  const alreadyExists = _fs.default.existsSync(instancePath);
-
-  if (alreadyExists) {
-    const parameters = Object.keys(options || {}).filter(key => key !== 'slug');
-
-    if (parameters && parameters.length) {
-      throw new Error(`The environment ${slug} already exists and we can not change its configuration` + ` ( configuration parameters - ${parameters.join(', ')} found ).` + ' Destroy the environment first if you would like to recreate it.');
-    }
-  } else {
-    const instanceData = generateInstanceData(slug, options);
-    debug('Instance data to create a new environment:', instanceData);
-    await prepareLandoEnv(instanceData, instancePath);
-  }
-
-  await landoStart(instancePath);
-}
-
-function getLandoConfig() {
-  const landoPath = _path.default.join(__dirname, '..', '..', 'node_modules', 'lando');
-
-  debug(`Getting lando config, using path '${landoPath}' for plugins`);
-  return {
-    logLevelConsole: 'warn',
-    landoFile: '.lando.yml',
-    preLandoFiles: ['.lando.base.yml', '.lando.dist.yml', '.lando.upstream.yml'],
-    postLandoFiles: ['.lando.local.yml'],
-    pluginDirs: [landoPath, {
-      path: _path.default.join(landoPath, 'integrations'),
-      subdir: '.'
-    }]
-  };
-}
-
-async function landoStart(instancePath) {
-  debug('Will start lando app on path:', instancePath);
-  const lando = new _lando.default(getLandoConfig());
-  await lando.bootstrap();
-  const app = lando.getApp(instancePath);
-  await app.init();
-  await app.start();
-  console.log(lando.cli.formatData(_utils.default.startTable(app), {
-    format: 'table'
-  }, {
-    border: false
-  }));
-}
-
-async function prepareLandoEnv(instanceData, instancePath) {
-  const landoFile = await _ejs.default.renderFile(landoFileTemplatePath, instanceData);
-
-  const landoFileTargetPath = _path.default.join(instancePath, landoFileName);
-
-  _fs.default.mkdirSync(instancePath, {
-    recursive: true
-  });
-
-  _fs.default.writeFileSync(landoFileTargetPath, landoFile);
-
-  debug(`Lando file created in ${landoFileTargetPath}`);
-}
-
-function generateInstanceData(slug, options) {
-  const instanceData = {
-    siteSlug: slug,
-    wpTitle: options.title || defaults.title,
-    multisite: options.multisite || defaults.multisite,
-    phpVersion: options.phpVersion || defaults.phpVersion,
-    wordpress: getParamInstanceData(options.wordpress, 'wordpress'),
-    muPlugins: getParamInstanceData(options.muPlugins, 'muPlugins'),
-    jetpack: getParamInstanceData(options.jetpack, 'jetpack'),
-    clientCode: getParamInstanceData(options.clientCode, 'clientCode')
-  };
-  return instanceData;
-}
-
-function getParamInstanceData(param, type) {
-  if (param) {
-    if (param.includes('/')) {
-      return {
-        mode: 'local',
-        dir: param
-      };
-    }
-
-    if (type === 'jetpack' && param === 'mu') {
-      return {
-        mode: 'inherit'
-      };
-    }
-
-    return {
-      mode: 'image',
-      image: containerImages[type].image,
-      tag: param
-    };
-  }
-
-  return defaults[type];
-}
-
-function getEnvironmentPath(name) {
-  if (!name) {
-    throw new Error('Name was not provided');
-  }
-
-  const mainEnvironmentPath = _xdgBasedir.default.data || _os.default.tmpdir();
-
-  return _path.default.join(mainEnvironmentPath, 'vip', 'dev-environment', name);
-}