@john-cli/init 1.0.7

package/README.md

@@ -0,0 +1,11 @@
+# `@john-cli/init`
+
+> TODO: description
+
+## Usage
+
+```
+const init = require('@john-cli/init');
+
+// TODO: DEMONSTRATE API
+```

package/lib/getProjectTemplate.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const request = require('@john-cli/request')
+
+module.exports = function () {
+  return request({
+    url: '/project/template'
+  })
+}

package/lib/index.js

@@ -0,0 +1,362 @@
+'use strict';
+
+const fs = require('fs')
+const inquirer = require('inquirer')
+const path = require('path')
+const fse = require('fs-extra')
+const semver = require('semver')
+const userHome = require('user-home')
+const Command = require('@john-cli/command')
+const log = require('@john-cli/log')
+const Package = require('@john-cli/package')
+const { spinnerStart, sleep, execAsync } = require('@john-cli/utils')
+
+const getProjectTemplate = require('./getProjectTemplate')
+
+const TYPE_PROJECT = 'project'
+const TYPE_COMPONENT = 'component'
+
+const TEMPLATE_TYPE_NORMAL = 'normal' // 标准模板
+const TEMPLATE_TYPE_CUSTOM = 'custom' // 定义模板
+
+const WHITE_CMD = ['npm', 'cnpm']
+
+class InitCommand extends Command {
+  constructor(argv) {
+    super(argv)
+  }
+
+  init () {
+    this.projectName = this._argv[0] || '';
+    const opts = this._cmd._optionValues
+    // console.log('opts', opts)
+    this.force = !!opts.force
+    // console.log('argv:', this._cmd._optionValues)
+    log.verbose(this.projectName, this.force)
+  }
+
+  async exec () {
+    /**
+     * 1.准备阶段
+     * 2.下载模板
+     * 3.安装模板
+     */
+    try {
+      const projectInfo = await this.prepare()
+      log.verbose('projectInfo', projectInfo)
+      this.projectInfo = projectInfo
+      if (projectInfo.type === TYPE_PROJECT) {
+        // 1.下载模板
+        await this.downloadTemplate()
+        // 2.安装模板
+        await this.installTemplate()
+      }
+    } catch (e) {
+      log.error(e.message)
+    }
+  }
+
+  async installTemplate () {
+    // 判断当前模板是否包含template信息
+    if (this.templateInfo) {
+      if (!this.templateInfo.type) {
+        this.templateInfo.type = TEMPLATE_TYPE_NORMAL
+      }
+      if (this.templateInfo.type === TEMPLATE_TYPE_NORMAL) {
+        // 标准安装
+        await this.installNormalTemplate()
+      } else if (this.templateInfo.type === TEMPLATE_TYPE_CUSTOM) {
+        // 自定义安装
+        await this.installCustomTemplate()
+      } else {
+        // 未知类型
+        throw new Error('项目模板无法识别！')
+      }
+    } else {
+      throw new Error('项目模板信息不存在！')
+    }
+  }
+
+  checkCommand (cmd) {
+    if (WHITE_CMD.includes(cmd)) {
+      return cmd
+    }
+    return null
+  }
+
+  async execCommand (command, errMsg) {
+    let ret
+    if (command) {
+      const cmdArr = command.split(' ') // npm install or npm run serve
+      const cmd = this.checkCommand(cmdArr[0])
+      if (!cmd) {
+        throw new Error(errMsg)
+      }
+      const args = cmdArr.slice(1)
+      ret = await execAsync(cmd,args, {
+        stdio: 'inherit',
+        cwd: process.cwd()
+      })
+    }
+    if (ret !== 0) {
+      throw new Error('安装依赖过程失败！')
+    }
+    return ret
+  }
+
+  async installNormalTemplate() {
+    console.log('templateNpm22:', this.templateNpm)
+    // 拷贝模板代码至当前目录
+    let spinner = spinnerStart('正在安装模板...')
+    await sleep()
+    try {
+      const templatePath = path.resolve(this.templateNpm.cacheFilePath, 'template')
+      const targetPath = process.cwd()
+      // fse.ensureDirSync 确保目录存在，不存在则会创建
+      fse.ensureDirSync(templatePath)
+      fse.ensureDirSync(targetPath)
+      fse.copySync(templatePath, targetPath)
+    } catch (e) {
+      throw e
+    } finally {
+      spinner.stop(true)
+      log.success('模板安装成功')
+    }
+    const { installCommand, startCommand } = this.templateInfo
+    // 依赖安装 npm install
+    await this.execCommand(installCommand, '安装依赖过程失败！')
+    // 启动命令 npm run serve
+    await this.execCommand(startCommand, '启动过程失败！')
+  }
+
+  async installCustomTemplate() {
+    console.log('安装自定义模板', this.templateNpm)
+  }
+
+  async downloadTemplate () {
+    // 1.通过项目模板API获取项目模板信息
+    // 1.1.通过egg.js搭建一套后端系统
+    // 1.2.通过npm存储项目模板
+    // 1.3.将项目模板信息存储到mongodb数据库
+    // 1.4.通过egg.js获取mongodb中的数据并且通过API返回
+    // console.log(this.projectInfo, this.template)
+    const { projectTemplate } = this.projectInfo
+    const templateInfo = this.template.find((item) => {
+        return item.npmName === projectTemplate
+    })
+
+    const targetPath = path.resolve(userHome, '.john-cli', 'template') // 缓存项目模板
+    const storeDir = path.resolve(userHome, '.john-cli', 'template', 'node_modules') // 实际存储的目录
+    const { npmName, version } = templateInfo
+    this.templateInfo = templateInfo
+    const templateNpm = new Package({
+      targetPath,
+      storeDir,
+      packageName: npmName,
+      packageVersion: version
+    })
+    // console.log(targetPath, storeDir, npmName, version, 'templateNpm::',templateNpm)
+    if (!await templateNpm.exists()) {
+      const spinner = spinnerStart('正在下载模板')
+      await sleep()
+      try {
+        await templateNpm.install()
+      } catch (e) {
+        throw e
+      } finally {
+        spinner.stop(true)
+        if (await templateNpm.exists()) {
+          log.success('模板下载成功')
+          this.templateNpm = templateNpm
+        }
+      }
+    } else {
+      const spinner = spinnerStart('正在更新模板')
+      await sleep()
+      try {
+        await templateNpm.update()
+      } catch (e) {
+        throw e
+      } finally {
+        spinner.stop(true)
+        if (await templateNpm.exists()) {
+          log.success('模板更新成功')
+          this.templateNpm = templateNpm
+        }
+      }
+    }
+  }
+
+  async prepare () {
+    // 0.判断项目模板是否存在
+    const template = await getProjectTemplate()
+    // console.log('template',template)
+
+    if (!template || template.length === 0) {
+      throw new Error('项目模板不存在')
+    }
+
+    this.template = template
+    const localPath = process.cwd() // 当前命令执行的目录
+    // 1.当前目录是否为空
+    // console.log(__dirname) // 当前代码文件所胡的目录地址
+    // console.log(path.resolve('.'))
+    // const ret = this.cwdIsEmpty()
+    // console.log('ret:',ret)
+
+    // 当前目录是否为空
+    if (!this.isDirEmpty(localPath)) {
+      let ifContinue = false
+      // 2.询问是否继续创建
+      if (!this.force) {
+        ifContinue = (await inquirer.prompt({
+          type: 'confirm',
+          name: 'ifContinue',
+          message: '当前文件夹不为空，是否继续创建项目？',
+          default: false
+        })).ifContinue;
+        // 不继续创建，终止流程
+        if (!ifContinue) {
+          return
+        }
+      }
+      // console.log('ifContinue:',ifContinue)
+      // 3.是否强制更新
+      if (ifContinue || this.force) {
+        // 给用户做二次确认
+        const { confirmDelete } = await  inquirer.prompt({
+          type: 'confirm',
+          name: 'confirmDelete',
+          message: '是否确认清空当前目录下的文件？',
+          default: false
+        })
+        if (confirmDelete) {
+          // 清空当前目录
+          fse.emptyDirSync(localPath)
+        }
+      }
+    }
+    // 4.强制？清空当前目录：''
+    // throw new Error('出错了')
+    return this.getProjectInfo()
+  }
+
+  async getProjectInfo () {
+    let projectInfo = {}
+    // 1.获取项目类型（项目/组件）
+    const { type } = await inquirer.prompt({
+      type: 'list',
+      name: 'type',
+      message: '请选择初始化类型',
+      default: TYPE_PROJECT,
+      choices: [{
+        name: '项目',
+        value: TYPE_PROJECT
+      },{
+        name: '组件',
+        value: TYPE_COMPONENT
+      }]
+    })
+    log.verbose('type', type)
+    // 2.获取项目基本信息（名称、版本号、描述）
+    if (type === TYPE_PROJECT) {
+      // 获取项目的基本信息
+      const project = await inquirer.prompt([{
+        type: 'input',
+        name: 'projectName',
+        message: '请输入项目的名称',
+        default: '',
+        validate: function (v) {
+          // 限制输入规则
+          // 1.输入的首字符必须为英文字符
+          // 2.尾字符必须为英文或数字，不能为字符
+          // 3.字符仅允许"-_"
+          // a-b a_b aaabbb  不能出现 a_  a-
+          // 合法：a,a-b,a_b,a-b-c,a_b_c,a-b1-c1, a_b1_c1
+          // 不合法：1, a_, a-, a_1, a-1
+          // return /^[a-zA-Z]+([-][a-zA-Z][a-zA-Z0-9]*|[_][a-zA-Z][a-zA-Z0-9]*|[a-zA-Z0-9])*$/.test(v)
+          const done = this.async()
+          setTimeout(function() {
+            if (!/^[a-zA-Z]+([-][a-zA-Z][a-zA-Z0-9]*|[_][a-zA-Z][a-zA-Z0-9]*|[a-zA-Z0-9])*$/.test(v)) {
+              done('请输入合法的项目名称(a-zA-Z0-9 or a_zA_Z0_9)')
+              return;
+            }
+            done(null, true)
+          }, 0);
+        },
+        filter: function (v) {
+          return v
+        }
+      },{
+        type: 'input',
+        name: 'projectVersion',
+        message: '请输入项目版本号',
+        default: '1.0.0',
+        validate: function (v) {
+          const done = this.async()
+          setTimeout(function() {
+            if (!(!!semver.valid(v))) {
+              done('请输入合法的版本号（如：v1.0.0 or 1.0.0）')
+              return;
+            }
+            done(null, true)
+          }, 0);
+        },
+        filter: function (v) {
+          if (!!semver.valid(v)) {
+            return semver.valid(v)
+          } else {
+            return v
+          }
+        }
+      },{
+        type: 'list',
+        name: 'projectTemplate',
+        message: '请选择项目模板',
+        choices: this.createTemplateChoice()
+      }
+      ])
+      projectInfo = {
+        type,
+        ...project
+      }
+    } else if (type === TYPE_COMPONENT) {
+
+    }
+
+    // 生成className
+    if (projectInfo.projectName) {
+      projectInfo.className = require('kebab-case')(projectInfo.projectName).replace(/^-/,'')
+    }
+
+    // return 项目的基本信息(Object)
+    return projectInfo
+  }
+
+  createTemplateChoice () {
+    return this.template.map((item) => {
+      return {
+        value: item.npmName,
+        name: item.name
+      }
+    })
+  }
+
+  isDirEmpty (localPath) {
+    let fileList = fs.readdirSync(localPath) // 当前目录下的所有文件
+    // 文件过滤逻辑
+    fileList = fileList.filter((file) => {
+      return !file.startsWith('.') && !['node_modules'].includes(file)
+    })
+    return !fileList || fileList.length <= 0
+  }
+
+}
+
+function init(argv) {
+  // console.log('init', projectName, cmdObj.force, process.env.CLI_TARGET_PATH)
+  return new InitCommand(argv);
+}
+
+module.exports = init;
+module.exports.InitCommand = InitCommand;

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@john-cli/init",
+  "version": "1.0.7",
+  "description": "john-cli init",
+  "author": "tanhongjian <350089447@qq.com>",
+  "homepage": "",
+  "license": "ISC",
+  "main": "lib/index.js",
+  "directories": {
+    "lib": "lib",
+    "test": "__tests__"
+  },
+  "files": [
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/boshilang/john-cli.git"
+  },
+  "scripts": {
+    "test": "echo \"Error: run tests from root\" && exit 1"
+  },
+  "dependencies": {
+    "@john-cli/command": "file:../../mocels/command",
+    "@john-cli/log": "file:../../log/log",
+    "@john-cli/package": "^1.0.7",
+    "@john-cli/request": "^1.0.7",
+    "@john-cli/utils": "^1.0.7",
+    "fs-extra": "^10.1.0",
+    "inquirer": "^8.0.0",
+    "kebab-case": "^1.0.1",
+    "semver": "^7.3.7"
+  },
+  "gitHead": "dca53a0950924ea93b55b1354100343ed7c902cb"
+}