@mpxjs/cli 3.2.0 → 3.3.0

package/.release-it.js

@@ -0,0 +1,13 @@
+module.exports = {
+  git: {
+    commitMessage: 'chore: release v${version}'
+  },
+  github: {
+    release: true
+  },
+  npm: {
+    skipChecks: true
+  },
+  plugins: {},
+  hooks: {}
+}

package/README.md

@@ -1,13 +1,11 @@
-## mpx-cli@next
+## mpx-cli
 
 A cli tool that based on [@vue/cli](https://cli.vuejs.org/) for creating mpx project.
 
-## Stage: alpha
-
 ## Install
 
 ```javascript
-npm i @mpxjs/cli@next -g
+npm i @mpxjs/cli -g
 ```
 
 ## Usage

package/__tests__/preset.spec.js

@@ -0,0 +1,206 @@
+jest.mock('inquirer')
+
+const path = require('path')
+const fs = require('fs')
+const create = require('@mpxjs/cli/lib/create')
+
+test('normal', async () => {
+  const cwd = path.resolve(__dirname, '../../test')
+  const name = 'test-normal'
+  await create(
+    name,
+    {
+      force: true,
+      git: false,
+      cwd
+    },
+    {
+      srcMode: 'wx',
+      appid: 'test',
+      description: 'test',
+      cross: true,
+      plugins: {},
+      useConfigFiles: true
+    }
+  )
+
+  const pkg = require(path.resolve(cwd, name, 'package.json'))
+  expect(pkg.devDependencies).toHaveProperty('@mpxjs/vue-cli-plugin-mpx')
+})
+
+/**
+ * 非跨平台项目不生成static/ali目录
+ */
+test('normal-nocross', async () => {
+  const cwd = path.resolve(__dirname, '../../test')
+  const name = 'normal-nocross'
+  await create(
+    name,
+    {
+      force: true,
+      git: false,
+      cwd
+    },
+    {
+      srcMode: 'wx',
+      appid: 'test',
+      description: 'test',
+      cross: false,
+      plugins: {},
+      useConfigFiles: true
+    }
+  )
+
+  const staticAliDir = fs.existsSync(path.resolve(cwd, name, 'static/ali'))
+  expect(staticAliDir).toBe(false)
+})
+
+test('test-ts', async () => {
+  const cwd = path.resolve(__dirname, '../../test')
+  const name = 'test-ts'
+  await create(
+    name,
+    {
+      force: true,
+      git: false,
+      cwd
+    },
+    {
+      srcMode: 'wx',
+      appid: 'test',
+      description: 'test',
+      cross: true,
+      needTs: true,
+      plugins: {},
+      useConfigFiles: true
+    }
+  )
+
+  const pkg = require(path.resolve(cwd, name, 'package.json'))
+  expect(pkg.devDependencies).toHaveProperty('@mpxjs/vue-cli-plugin-mpx-typescript')
+})
+
+test('test-cloud-func', async () => {
+  const cwd = path.resolve(__dirname, '../../test')
+  const name = 'test-cloud-func'
+  await create(
+    name,
+    {
+      force: true,
+      git: false,
+      cwd
+    },
+    {
+      srcMode: 'wx',
+      appid: 'test',
+      description: 'test',
+      cross: true,
+      cloudFunc: true,
+      plugins: {},
+      useConfigFiles: true
+    }
+  )
+
+  const pkg = require(path.resolve(cwd, name, 'package.json'))
+  expect(pkg.devDependencies).toHaveProperty('@mpxjs/vue-cli-plugin-mpx-cloud-func')
+})
+
+test('test-cloud-func', async () => {
+  const cwd = path.resolve(__dirname, '../../test')
+  const name = 'test-cloud-func'
+  await create(
+    name,
+    {
+      force: true,
+      git: false,
+      cwd
+    },
+    {
+      srcMode: 'wx',
+      appid: 'test',
+      description: 'test',
+      cross: true,
+      cloudFunc: true,
+      plugins: {},
+      useConfigFiles: true
+    }
+  )
+
+  const pkg = require(path.resolve(cwd, name, 'package.json'))
+  expect(pkg.devDependencies).toHaveProperty('@mpxjs/vue-cli-plugin-mpx-cloud-func')
+})
+
+test('test-plugin', async () => {
+  const cwd = path.resolve(__dirname, '../../test')
+  const name = 'test-plugin'
+  await create(
+    name,
+    {
+      force: true,
+      git: false,
+      cwd
+    },
+    {
+      srcMode: 'wx',
+      appid: 'test',
+      description: 'test',
+      cross: true,
+      isPlugin: true,
+      plugins: {},
+      useConfigFiles: true
+    }
+  )
+
+  const pkg = require(path.resolve(cwd, name, 'package.json'))
+  expect(pkg.devDependencies).toHaveProperty('@mpxjs/vue-cli-plugin-mpx-plugin-mode')
+})
+
+test('test-unit', async () => {
+  const cwd = path.resolve(__dirname, '../../test')
+  const name = 'test-unit'
+  await create(
+    name,
+    {
+      force: true,
+      git: false,
+      cwd
+    },
+    {
+      srcMode: 'wx',
+      appid: 'test',
+      description: 'test',
+      cross: true,
+      needUnitTest: true,
+      plugins: {},
+      useConfigFiles: true
+    }
+  )
+
+  const pkg = require(path.resolve(cwd, name, 'package.json'))
+  expect(pkg.devDependencies).toHaveProperty('@mpxjs/vue-cli-plugin-mpx-unit-test')
+})
+
+test('test-e2e', async () => {
+  const cwd = path.resolve(__dirname, '../../test')
+  const name = 'test-e2e'
+  await create(
+    name,
+    {
+      force: true,
+      git: false,
+      cwd
+    },
+    {
+      srcMode: 'wx',
+      appid: 'test',
+      description: 'test',
+      cross: true,
+      needE2ETest: true,
+      plugins: {},
+      useConfigFiles: true
+    }
+  )
+
+  const pkg = require(path.resolve(cwd, name, 'package.json'))
+  expect(pkg.devDependencies).toHaveProperty('@mpxjs/vue-cli-plugin-mpx-e2e-test')
+})

package/bin/mpx.js

@@ -1,6 +1,8 @@
 #!/usr/bin/env node
 const program = require('commander')
+const minimist = require('minimist')
 const { doVueCli } = require('../utils')
+const { chalk } = require('@vue/cli-shared-utils')
 
 program
   .version(`@mpx/cli ${require('../package').version}`)
@@ -35,9 +37,15 @@ program.command('create <app-name>')
   .option('-c, --clone', 'Use git clone when fetching remote preset')
   .option('-x, --proxy <proxyUrl>', 'Use specified proxy when creating project')
   .option('-b, --bare', 'Scaffold project without beginner instructions')
-  .option('--skipGetStarted', 'Skip displaying "Get started" instructions')
-  .action(async () => {
-    require('../lib/create')()
+  .action(async (appName, options) => {
+    if (minimist(process.argv.slice(3))._.length > 1) {
+      console.log(chalk.yellow('\n Info: You provided more than one argument. The first one will be used as the app\'s name, the rest are ignored.'))
+    }
+    // --git makes commander to default git to true
+    if (process.argv.includes('-g') || process.argv.includes('--git')) {
+      options.forceGit = true
+    }
+    return require('../lib/create')(appName, options)
   })
 
 program
@@ -59,26 +67,14 @@ program
   })
 
 program
-  .command('inspect:mp [paths...]')
+  .command('inspect [paths...]')
   .description('inspect the webpack config in a project with mpx-cli-service')
   .option('--mode <mode>')
   .option('--targets <targets>')
+  .option('--env <env>', 'custom define __mpx_env__')
   .option('-v --verbose', 'Show full function definitions in output')
   .action((paths, options) => {
-    require('../lib/inspect')(paths, options, 'mp')
-  })
-
-program
-  .command('inspect:web [paths...]')
-  .description('inspect the webpack config in a project with mpx-cli-service')
-  .option('--mode <mode>')
-  .option('--rule <ruleName>', 'inspect a specific module rule')
-  .option('--plugin <pluginName>', 'inspect a specific plugin')
-  .option('--rules', 'list all module rule names')
-  .option('--plugins', 'list all plugin names')
-  .option('-v --verbose', 'Show full function definitions in output')
-  .action((paths, options) => {
-    require('../lib/inspect')(paths, options, 'web')
+    require('../lib/inspect')(paths, options)
   })
 
 program

package/env/index.js

@@ -0,0 +1,7 @@
+// const path = require('path')
+// const os = require('os')
+
+module.exports.resetEnv = function () {
+  // process.env.VUE_CLI_CONFIG_PATH = path.join(os.homedir(), '.mpxrc')
+  // process.env.VUE_CLI_SERVICE_CONFIG_PATH = './mpx.config.js'
+}

package/lib/create.js

@@ -1,19 +1,26 @@
-const minimist = require('minimist')
 const path = require('path')
 const inquirer = require('inquirer')
-const merge = require('lodash.merge')
-const { chalk, exit, error, log } = require('@vue/cli-shared-utils')
+const fs = require('fs-extra')
+const validateProjectName = require('validate-npm-package-name')
+const {
+  chalk,
+  exit,
+  error,
+  log,
+  stopSpinner
+} = require('@vue/cli-shared-utils')
+const Creator = require('@vue/cli/lib/Creator')
 const loadRemotePreset = require('@vue/cli/lib/util/loadRemotePreset')
 const loadLocalPreset = require('@vue/cli/lib/util/loadLocalPreset')
-
+const { getPromptModules } = require('@vue/cli/lib/util/createTools')
+const { clearConsole } = require('@vue/cli/lib/util/clearConsole')
+const { linkBin } = require('@vue/cli/lib/util/linkBin')
+const merge = require('lodash.merge')
 const prompts = require('./prompts')
-const plugins = require('./plugins')
 const builtInPreset = require('./preset')
 
-const { regenCmd, doVueCli } = require('../utils')
-
 async function resolvePreset (args = {}) {
-  const { p, preset, i, inlinePreset, c, clone } = args
+  const { p, preset, c, clone } = args
   let res = {}
   let cliPreset = {}
   if (p || preset) {
@@ -34,58 +41,161 @@ async function resolvePreset (args = {}) {
         throw e
       }
     }
-  } else if (i || inlinePreset) {
-    // mpx create foo --inlinePreset {...}
-    cliPreset = i || inlinePreset
-    try {
-      res = JSON.parse(cliPreset)
-    } catch (e) {
-      error(`CLI inline preset is not valid JSON: ${cliPreset}`)
-      exit(1)
-    }
   }
   return res
 }
 
-async function resolvePrompts (name, builtInPreset) {
-  return new Promise(function (resolve) {
-    inquirer.prompt(prompts).then((answers) => {
-      if (answers.needTs) {
-        Object.assign(builtInPreset.plugins, plugins.tsSupport)
-      }
-      if (answers.cloudFunc) {
-        Object.assign(builtInPreset.plugins, plugins.cloudFunc)
-      }
-      if (answers.isPlugin) {
-        Object.assign(builtInPreset.plugins, plugins.isPlugin)
-      }
-      if (answers.transWeb) {
-        Object.assign(builtInPreset.plugins, plugins.transWeb)
+async function resolvePrompts () {
+  return inquirer.prompt(prompts).then((answers) => answers)
+}
+
+/**
+ * 从vue-cli clone 下来，方便处理creator的创建以及生命周期管理
+ * @param {*} projectName
+ * @param {*} options
+ * @param {*} preset
+ * @returns
+ */
+async function create (projectName, options, preset = null) {
+  // resolve preset
+  if (!preset) {
+    if (options.preset) {
+      preset = await resolvePreset(options)
+    } else if (options.inlinePreset) {
+      try {
+        preset = JSON.parse(options.inlinePreset)
+      } catch (error) {
+        error(`CLI inline preset is not valid JSON: ${options.inlinePreset}`)
+        exit(1)
       }
-      // TODO: 添加其他 prompt 插件配置
+    } else {
+      preset = await resolvePrompts()
+    }
+  }
+  // css preprocessor
+  preset.cssPreprocessor = 'stylus'
+
+  // mpx cli 插件
+  preset.plugins = Object.assign(
+    {},
+    preset.plugins,
+    builtInPreset.plugins
+  )
 
-      // 各插件共享 answers 配置
-      Object.keys(builtInPreset.plugins).forEach(function (key) {
-        const plugin = builtInPreset.plugins[key]
-        Object.assign(plugin, {
-          ...answers,
-          name
-        })
+  // 合并问答中的preset
+  prompts.forEach(v => {
+    if (preset[v.name]) {
+      merge(preset, v.preset)
+    }
+  })
+
+  // 设置代理
+  if (options.proxy) {
+    process.env.HTTP_PROXY = options.proxy
+  }
+
+  const cwd = options.cwd || process.cwd()
+  const inCurrent = projectName === '.'
+  const name = inCurrent ? path.relative('../', cwd) : projectName
+  const targetDir = path.resolve(cwd, projectName || '.')
+
+  const result = validateProjectName(name)
+  if (!result.validForNewPackages) {
+    console.error(chalk.red(`Invalid project name: "${name}"`))
+    result.errors &&
+      result.errors.forEach((err) => {
+        console.error(chalk.red.dim('Error: ' + err))
+      })
+    result.warnings &&
+      result.warnings.forEach((warn) => {
+        console.error(chalk.red.dim('Warning: ' + warn))
       })
+    exit(1)
+  }
 
-      resolve(builtInPreset)
+  if (fs.existsSync(targetDir) && !options.merge) {
+    if (options.force) {
+      await fs.remove(targetDir)
+    } else {
+      await clearConsole()
+      if (inCurrent) {
+        const { ok } = await inquirer.prompt([
+          {
+            name: 'ok',
+            type: 'confirm',
+            message: 'Generate project in current directory?'
+          }
+        ])
+        if (!ok) {
+          return
+        }
+      } else {
+        const { action } = await inquirer.prompt([
+          {
+            name: 'action',
+            type: 'list',
+            message: `Target directory ${chalk.cyan(
+              targetDir
+            )} already exists. Pick an action:`,
+            choices: [
+              { name: 'Overwrite', value: 'overwrite' },
+              { name: 'Merge', value: 'merge' },
+              { name: 'Cancel', value: false }
+            ]
+          }
+        ])
+        if (!action) {
+          return
+        } else if (action === 'overwrite') {
+          console.log(`\nRemoving ${chalk.cyan(targetDir)}...`)
+          await fs.remove(targetDir)
+        }
+      }
+    }
+  }
+
+  Object.keys(preset.plugins).forEach(function (key) {
+    const plugin = preset.plugins[key]
+    Object.assign(plugin, {
+      srcMode: preset.srcMode,
+      appid: preset.appid,
+      description: preset.description,
+      needE2ETest: preset.needE2ETest,
+      needUnitTest: preset.needUnitTest,
+      needTs: preset.needTs,
+      isPlugin: preset.isPlugin,
+      cloudFunc: preset.cloudFunc,
+      cross: preset.cross,
+      name
     })
   })
+
+  const creator = new Creator(name, targetDir, getPromptModules())
+
+  if (process.env.VUE_CLI_TEST || process.env.VUE_CLI_DEBUG) {
+    // 单测下，link bin文件到源码
+    creator.on('creation', ({ event }) => {
+      if (event === 'plugins-install') {
+        linkBin(
+          require.resolve('@mpxjs/mpx-cli-service/bin/mpx-cli-service'),
+          path.join(targetDir, 'node_modules', '.bin', 'mpx-cli-service')
+        )
+      }
+    })
+  }
+
+  await creator.create({
+    ...options,
+    inlinePreset: JSON.stringify(preset)
+  })
 }
 
-module.exports = async function () {
-  const args = process.argv.slice(2)
-  const parsedArgs = minimist(args)
-  const name = args[1]
-  const cmd = regenCmd(parsedArgs)
-  const mpxBuiltInPreset = await resolvePrompts(name, builtInPreset)
-  const cliPreset = await resolvePreset(parsedArgs)
-  const mergedPreset = merge(mpxBuiltInPreset, cliPreset)
-  cmd.push('-i', JSON.stringify(mergedPreset))
-  doVueCli(cmd)
+module.exports = function (...args) {
+  return create(...args).catch((err) => {
+    stopSpinner(false) // do not persist
+    error(err)
+    if (!process.env.VUE_CLI_TEST) {
+      process.exit(1)
+    }
+  })
 }

package/lib/info.js

@@ -1,4 +1,4 @@
-const chalk = require('chalk')
+const { chalk } = require('@vue/cli-shared-utils')
 
 module.exports = function () {
   console.log(chalk.bold('\nEnvironment Info:'))

package/lib/inspect.js

@@ -3,7 +3,7 @@ const path = require('path')
 const resolve = require('resolve')
 const { execa } = require('@vue/cli-shared-utils')
 
-module.exports = function inspect (paths, args, mode) {
+module.exports = function inspect (paths, args) {
   const cwd = process.cwd()
   let servicePath
   try {
@@ -21,9 +21,10 @@ module.exports = function inspect (paths, args, mode) {
   if (fs.existsSync(binPath)) {
     execa('node', [
       binPath,
-      `inspect:${mode}`,
+      'inspect',
       ...(args.mode ? ['--mode', args.mode] : []),
       ...(args.targets ? ['--targets', args.targets] : []),
+      ...(args.env ? ['--env', args.env] : []),
       ...(args.rule ? ['--rule', args.rule] : []),
       ...(args.plugin ? ['--plugin', args.plugin] : []),
       ...(args.rules ? ['--rules'] : []),

package/lib/preset.js

@@ -1,17 +1,17 @@
+/**
+ * 默认preset
+ */
 module.exports = {
   cssPreprocessor: 'stylus',
   plugins: {
     '@mpxjs/mpx-cli-service': {
-      version: '^1.0.0'
+      version: '^2.0.0'
     },
     '@mpxjs/vue-cli-plugin-mpx': {
-      version: '^1.0.0'
-    },
-    '@mpxjs/vue-cli-plugin-mpx-mp': {
-      version: '^1.0.0'
+      version: '^2.0.0'
     },
     '@mpxjs/vue-cli-plugin-mpx-eslint': {
-      version: '^1.0.0'
+      version: '^2.0.0'
     }
   }
 }

package/lib/prompts.js

@@ -1,10 +1,12 @@
+const prefix = '@mpxjs/vue-cli-plugin-mpx'
+
 module.exports = [
   {
     name: 'srcMode',
     type: 'list',
     required: true,
     message: '请选择小程序项目所属平台（目前仅微信下支持跨平台输出）',
-    choices: ['wx', 'ali', 'swan', 'qq', 'tt'],
+    choices: ['wx', 'ali', 'swan', 'qq', 'tt', 'dd'],
     default: 'wx'
   },
   {
@@ -14,19 +16,19 @@ module.exports = [
     type: 'confirm',
     default: true
   },
-  {
-    name: 'transWeb',
-    when: ({ srcMode, cross }) => srcMode === 'wx' && cross === true,
-    message: '是否需要支持输出web',
-    type: 'confirm',
-    default: false
-  },
   {
     name: 'cloudFunc',
     when: ({ srcMode, cross }) => srcMode === 'wx' && cross === false,
     message: '是否需要使用小程序云开发能力',
     type: 'confirm',
-    default: false
+    default: false,
+    preset: {
+      plugins: {
+        [`${prefix}-cloud-func`]: {
+          version: '^2.0.0'
+        }
+      }
+    }
   },
   {
     name: 'isPlugin',
@@ -34,13 +36,53 @@ module.exports = [
     type: 'confirm',
     message:
       '是否是个插件项目?（不清楚请选 No ！什么是插件项目请看微信官方文档！）',
-    default: false
+    default: false,
+    preset: {
+      plugins: {
+        [`${prefix}-plugin-mode`]: {
+          version: '^2.0.0'
+        }
+      }
+    }
   },
   {
     name: 'needTs',
     type: 'confirm',
     message: '是否需要typescript',
-    default: false
+    default: false,
+    preset: {
+      plugins: {
+        [`${prefix}-typescript`]: {
+          version: '^2.0.0'
+        }
+      }
+    }
+  },
+  {
+    name: 'needUnitTest',
+    message: '是否需要单元测试',
+    type: 'confirm',
+    default: false,
+    preset: {
+      plugins: {
+        [`${prefix}-unit-test`]: {
+          version: '^2.0.0'
+        }
+      }
+    }
+  },
+  {
+    name: 'needE2ETest',
+    message: '是否需要自动化测试',
+    type: 'confirm',
+    default: false,
+    preset: {
+      plugins: {
+        [`${prefix}-e2e-test`]: {
+          version: '^2.0.0'
+        }
+      }
+    }
   },
   {
     name: 'description',

package/package.json

@@ -1,24 +1,33 @@
 {
-  "name": "@mpxjs/cli",
-  "version": "3.2.0",
-  "description": "",
+  "author": "",
   "bin": {
     "mpx": "bin/mpx.js"
   },
-  "keywords": [],
-  "author": "",
-  "license": "Apache",
   "dependencies": {
+    "@types/inquirer": "^8.1.3",
     "@vue/cli": "^5.0.0",
-    "execa": "^4.1.0",
+    "commander": "^7.1.0",
+    "fs-extra": "^9.1.0",
+    "inquirer": "^8.0.0",
     "lodash.merge": "^4.6.2",
-    "shelljs": "^0.8.4"
+    "minimist": "^1.2.5",
+    "resolve": "^1.20.0",
+    "shelljs": "^0.8.4",
+    "validate-npm-package-name": "^3.0.0"
+  },
+  "description": "",
+  "devDependencies": {
+    "cmd-shim": "^4.1.0"
   },
   "engines": {
     "node": ">=8.9"
   },
+  "keywords": [],
+  "license": "Apache",
+  "name": "@mpxjs/cli",
   "publishConfig": {
-    "registry": "https://registry.npmjs.org",
-    "access": "public"
-  }
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "version": "3.3.0"
 }

package/utils/index.js

@@ -1,4 +1,4 @@
-const execa = require('execa')
+const { execa } = require('@vue/cli-shared-utils')
 const vueCliBinPath = require.resolve('@vue/cli/bin/vue')
 
 module.exports.regenCmd = function regenCmd (parsedArgs) {

package/lib/plugins.js

@@ -1,27 +0,0 @@
-const prefix = '@mpxjs/vue-cli-plugin-mpx'
-
-const plugins = {
-  tsSupport: {
-    [`${prefix}-typescript`]: {
-      version: '^1.0.0'
-    }
-  },
-  cloudFunc: {
-    [`${prefix}-cloud-func`]: {
-      version: '^1.0.0'
-    }
-  },
-  isPlugin: {
-    [`${prefix}-plugin-mode`]: {
-      version: '^1.0.0'
-    }
-  },
-  transWeb: {
-    [`${prefix}-web`]: {
-      version: '^1.0.0'
-    }
-  }
-  // TODO: 添加其他插件配置
-}
-
-module.exports = plugins