imooc-cli-dev-gd 1.0.0

package/commands/init/README.md

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

package/commands/init/__tests__/init.test.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const init = require('..');
+
+describe('@imooc-cli-dev-gd/init', () => {
+    it('needs tests');
+});

package/commands/init/lib/getProjectTemplate.js

@@ -0,0 +1,7 @@
+const request = require('@imooc-cli-dev-gd/request');
+
+module.exports = function() {
+  return request({
+    url: '/project/template',
+  });
+};

package/commands/init/lib/index.js

@@ -0,0 +1,423 @@
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const inquirer = require('inquirer');
+const fse = require('fs-extra');
+const glob = require('glob');
+const ejs = require('ejs');
+const semver = require('semver');
+const userHome = require('user-home');
+const Command = require('@imooc-cli-dev-gd/command');
+const Package = require('@imooc-cli-dev-gd/package');
+const log = require('@imooc-cli-dev-gd/log');
+const { spinnerStart, sleep, execAsync } = require('@imooc-cli-dev-gd/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_COMMAND = ['npm', 'cnpm'];
+
+class InitCommand extends Command {
+  init() {
+    this.projectName = this._argv[0] || '';
+    this.force = !!this._cmd.force;
+    log.verbose('projectName', this.projectName);
+    log.verbose('force', this.force);
+  }
+
+  async exec() {
+    try {
+      // 1. 准备阶段
+      const projectInfo = await this.prepare();
+      if (projectInfo) {
+        // 2. 下载模板
+        log.verbose('projectInfo', projectInfo);
+        this.projectInfo = projectInfo;
+        await this.downloadTemplate();
+        // 3. 安装模板
+        await this.installTemplate();
+      }
+    } catch (e) {
+      log.error(e.message);
+      if (process.env.LOG_LEVEL === 'verbose') {
+        console.log(e);
+      }
+    }
+  }
+
+  async installTemplate() {
+    log.verbose('templateInfo', this.templateInfo);
+    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_COMMAND.includes(cmd)) {
+      return cmd;
+    }
+    return null;
+  }
+
+  async execCommand(command, errMsg) {
+    let ret;
+    if (command) {
+      const cmdArray = command.split(' ');
+      const cmd = this.checkCommand(cmdArray[0]);
+      if (!cmd) {
+        throw new Error('命令不存在！命令：' + command);
+      }
+      const args = cmdArray.slice(1);
+      ret = await execAsync(cmd, args, {
+        stdio: 'inherit',
+        cwd: process.cwd(),
+      });
+    }
+    if (ret !== 0) {
+      throw new Error(errMsg);
+    }
+    return ret;
+  }
+
+  async ejsRender(options) {
+    const dir = process.cwd();
+    const projectInfo = this.projectInfo;
+    return new Promise((resolve, reject) => {
+      glob('**', {
+        cwd: dir,
+        ignore: options.ignore || '',
+        nodir: true,
+      }, function(err, files) {
+        if (err) {
+          reject(err);
+        }
+        Promise.all(files.map(file => {
+          const filePath = path.join(dir, file);
+          return new Promise((resolve1, reject1) => {
+            ejs.renderFile(filePath, projectInfo, {}, (err, result) => {
+              if (err) {
+                reject1(err);
+              } else {
+                fse.writeFileSync(filePath, result);
+                resolve1(result);
+              }
+            });
+          });
+        })).then(() => {
+          resolve();
+        }).catch(err => {
+          reject(err);
+        });
+      });
+    });
+  }
+
+  async installNormalTemplate() {
+    log.verbose('templateNpm', this.templateNpm);
+    // 拷贝模板代码至当前目录
+    let spinner = spinnerStart('正在安装模板...');
+    await sleep();
+    try {
+      const templatePath = path.resolve(this.templateNpm.cacheFilePath, 'template');
+      const targetPath = process.cwd();
+      fse.ensureDirSync(templatePath);
+      fse.ensureDirSync(targetPath);
+      fse.copySync(templatePath, targetPath);
+    } catch (e) {
+      throw e;
+    } finally {
+      spinner.stop(true);
+      log.success('模板安装成功');
+    }
+    const templateIgnore = this.templateInfo.ignore || [];
+    const ignore = ['**/node_modules/**', ...templateIgnore];
+    await this.ejsRender({ ignore });
+    const { installCommand, startCommand } = this.templateInfo;
+    // 依赖安装
+    await this.execCommand(installCommand, '依赖安装失败！');
+    // 启动命令执行
+    await this.execCommand(startCommand, '启动执行命令失败！');
+  }
+
+  async installCustomTemplate() {
+    // 查询自定义模板的入口文件
+    if (await this.templateNpm.exists()) {
+      const rootFile = this.templateNpm.getRootFilePath();
+      if (fs.existsSync(rootFile)) {
+        log.notice('开始执行自定义模板');
+        const templatePath = path.resolve(this.templateNpm.cacheFilePath, 'template');
+        const options = {
+          templateInfo: this.templateInfo,
+          projectInfo: this.projectInfo,
+          sourcePath: templatePath,
+          targetPath: process.cwd(),
+        };
+        const code = `require('${rootFile}')(${JSON.stringify(options)})`;
+        log.verbose('code', code);
+        await execAsync('node', ['-e', code], { stdio: 'inherit', cwd: process.cwd() });
+        log.success('自定义模板安装成功');
+      } else {
+        throw new Error('自定义模板入口文件不存在！');
+      }
+    }
+  }
+
+  async downloadTemplate() {
+    const { projectTemplate } = this.projectInfo;
+    const templateInfo = this.template.find(item => item.npmName === projectTemplate);
+    const targetPath = path.resolve(userHome, '.imooc-cli-dev', 'template');
+    const storeDir = path.resolve(userHome, '.imooc-cli-dev', 'template', 'node_modules');
+    const { npmName, version } = templateInfo;
+    this.templateInfo = templateInfo;
+    const templateNpm = new Package({
+      targetPath,
+      storeDir,
+      packageName: npmName,
+      packageVersion: version,
+    });
+    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();
+    if (!template || template.length === 0) {
+      throw new Error('项目模板不存在');
+    }
+    this.template = template;
+    // 1. 判断当前目录是否为空
+    const localPath = process.cwd();
+    if (!this.isDirEmpty(localPath)) {
+      let ifContinue = false;
+      if (!this.force) {
+        // 询问是否继续创建
+        ifContinue = (await inquirer.prompt({
+          type: 'confirm',
+          name: 'ifContinue',
+          default: false,
+          message: '当前文件夹不为空，是否继续创建项目？',
+        })).ifContinue;
+        if (!ifContinue) {
+          return;
+        }
+      }
+      // 2. 是否启动强制更新
+      if (ifContinue || this.force) {
+        // 给用户做二次确认
+        const { confirmDelete } = await inquirer.prompt({
+          type: 'confirm',
+          name: 'confirmDelete',
+          default: false,
+          message: '是否确认清空当前目录下的文件？',
+        });
+        if (confirmDelete) {
+          // 清空当前目录
+          fse.emptyDirSync(localPath);
+        }
+      }
+    }
+    return this.getProjectInfo();
+  }
+
+  async getProjectInfo() {
+    function isValidName(v) {
+      return /^[a-zA-Z]+([-][a-zA-Z][a-zA-Z0-9]*|[_][a-zA-Z][a-zA-Z0-9]*|[a-zA-Z0-9])*$/.test(v);
+    }
+
+    let projectInfo = {};
+    let isProjectNameValid = false;
+    if (isValidName(this.projectName)) {
+      isProjectNameValid = true;
+      projectInfo.projectName = this.projectName;
+    }
+    // 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);
+    this.template = this.template.filter(template =>
+      template.tag.includes(type));
+    const title = type === TYPE_PROJECT ? '项目' : '组件';
+    const projectNamePrompt = {
+      type: 'input',
+      name: 'projectName',
+      message: `请输入${title}名称`,
+      default: '',
+      validate: function(v) {
+        const done = this.async();
+        setTimeout(function() {
+          // 1.首字符必须为英文字符
+          // 2.尾字符必须为英文或数字，不能为字符
+          // 3.字符仅允许"-_"
+          if (!isValidName(v)) {
+            done(`请输入合法的${title}名称`);
+            return;
+          }
+          done(null, true);
+        }, 0);
+      },
+      filter: function(v) {
+        return v;
+      },
+    };
+    const projectPrompt = [];
+    if (!isProjectNameValid) {
+      projectPrompt.push(projectNamePrompt);
+    }
+    projectPrompt.push({
+        type: 'input',
+        name: 'projectVersion',
+        message: `请输入${title}版本号`,
+        default: '1.0.0',
+        validate: function(v) {
+          const done = this.async();
+          setTimeout(function() {
+            if (!(!!semver.valid(v))) {
+              done('请输入合法的版本号');
+              return;
+            }
+            done(null, true);
+          }, 0);
+        },
+        filter: function(v) {
+          if (!!semver.valid(v)) {
+            return semver.valid(v);
+          } else {
+            return v;
+          }
+        },
+      },
+      {
+        type: 'list',
+        name: 'projectTemplate',
+        message: `请选择${title}模板`,
+        choices: this.createTemplateChoice(),
+      });
+    if (type === TYPE_PROJECT) {
+      // 2. 获取项目的基本信息
+      const project = await inquirer.prompt(projectPrompt);
+      projectInfo = {
+        ...projectInfo,
+        type,
+        ...project,
+      };
+    } else if (type === TYPE_COMPONENT) {
+      const descriptionPrompt = {
+        type: 'input',
+        name: 'componentDescription',
+        message: '请输入组件描述信息',
+        default: '',
+        validate: function(v) {
+          const done = this.async();
+          setTimeout(function() {
+            if (!v) {
+              done('请输入组件描述信息');
+              return;
+            }
+            done(null, true);
+          }, 0);
+        },
+      };
+      projectPrompt.push(descriptionPrompt);
+      // 2. 获取组件的基本信息
+      const component = await inquirer.prompt(projectPrompt);
+      projectInfo = {
+        ...projectInfo,
+        type,
+        ...component,
+      };
+    }
+    // 生成classname
+    if (projectInfo.projectName) {
+      projectInfo.name = projectInfo.projectName;
+      projectInfo.className = require('kebab-case')(projectInfo.projectName).replace(/^-/, '');
+    }
+    if (projectInfo.projectVersion) {
+      projectInfo.version = projectInfo.projectVersion;
+    }
+    if (projectInfo.componentDescription) {
+      projectInfo.description = projectInfo.componentDescription;
+    }
+    return projectInfo;
+  }
+
+  isDirEmpty(localPath) {
+    let fileList = fs.readdirSync(localPath);
+    // 文件过滤的逻辑
+    fileList = fileList.filter(file => (
+      !file.startsWith('.') && ['node_modules'].indexOf(file) < 0
+    ));
+    return !fileList || fileList.length <= 0;
+  }
+
+  createTemplateChoice() {
+    return this.template.map(item => ({
+      value: item.npmName,
+      name: item.name,
+    }));
+  }
+}
+
+function init(argv) {
+  return new InitCommand(argv);
+}
+
+module.exports = init;
+module.exports.InitCommand = InitCommand;

package/commands/init/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@imooc-cli-dev-gd/init",
+  "version": "1.0.0",
+  "description": "imooc-cli-dev init",
+  "author": "sam <247765564@qq.com>",
+  "homepage": "",
+  "license": "ISC",
+  "main": "lib/index.js",
+  "directories": {
+    "lib": "lib",
+    "test": "__tests__"
+  },
+  "files": [
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://git.imooc.com/class-110/imooc-cli-dev.git"
+  },
+  "scripts": {
+    "test": "echo \"Error: run tests from root\" && exit 1"
+  },
+  "dependencies": {
+    "@imooc-cli-dev-gd/command": "file:../../models/command",
+    "@imooc-cli-dev-gd/log": "file:../../utils/log",
+    "@imooc-cli-dev-gd/package": "file:../../models/package",
+    "@imooc-cli-dev-gd/request": "file:../../utils/request",
+    "@imooc-cli-dev-gd/utils": "file:../../utils/utils",
+    "ejs": "^3.1.5",
+    "fs-extra": "^9.0.1",
+    "glob": "^7.1.6",
+    "inquirer": "^7.3.3",
+    "kebab-case": "^1.0.0",
+    "semver": "^7.3.4",
+    "spinner": "^0.3.4",
+    "user-home": "^2.0.0"
+  }
+}

package/commands/publish/README.md

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

package/commands/publish/__tests__/publish.test.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const publish = require('..');
+
+describe('@imooc-cli-dev-gd/publish', () => {
+    it('needs tests');
+});

package/commands/publish/lib/index.js

@@ -0,0 +1,67 @@
+'use strict';
+
+const path = require('path');
+const fs = require('fs');
+const fse = require('fs-extra');
+const Command = require('@imooc-cli-dev-gd/command');
+const log = require('@imooc-cli-dev-gd/log');
+const Git = require('@imooc-cli-dev-gd/git');
+
+class PublishCommand extends Command {
+  init() {
+    // 处理参数
+    log.verbose('publish', this._argv, this._cmd);
+    this.options = {
+      refreshServer: this._cmd.refreshServer,
+      refreshToken: this._cmd.refreshToken,
+      refreshOwner: this._cmd.refreshOwner,
+      buildCmd: this._cmd.buildCmd,
+    };
+  }
+
+  async exec() {
+    try {
+      const startTime = new Date().getTime();
+      // 1.初始化检查
+      this.prepare();
+      // 2.Git Flow自动化
+      const git = new Git(this.projectInfo, this.options);
+      await git.prepare(); // 自动化提交准备和代码仓库初始化
+      await git.commit(); // 代码自动化提交
+      await git.publish(); // 代码云构建+云发布
+      // 3.云构建和云发布
+      const endTime = new Date().getTime();
+      log.info('本次发布耗时：', Math.floor((endTime - startTime) / 1000) + '秒');
+    } catch (e) {
+      log.error(e.message);
+      if (process.env.LOG_LEVEL === 'verbose') {
+        console.log(e);
+      }
+    }
+  }
+
+  prepare() {
+    // 1.确认项目是否为npm项目
+    const projectPath = process.cwd();
+    const pkgPath = path.resolve(projectPath, 'package.json');
+    log.verbose('package.json', pkgPath);
+    if (!fs.existsSync(pkgPath)) {
+      throw new Error('package.json不存在！');
+    }
+    // 2.确认是否包含name、version、build命令
+    const pkg = fse.readJsonSync(pkgPath);
+    const { name, version, scripts } = pkg;
+    log.verbose('package.json', name, version, scripts);
+    if (!name || !version || !scripts || !scripts.build) {
+      throw new Error('package.json信息不全，请检查是否存在name、version和scripts（需提供build命令）！');
+    }
+    this.projectInfo = { name, version, dir: projectPath };
+  }
+}
+
+function init(argv) {
+  return new PublishCommand(argv);
+}
+
+module.exports = init;
+module.exports.PublishCommand = PublishCommand;

package/commands/publish/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@imooc-cli-dev-gd/publish",
+  "version": "1.0.0",
+  "description": "> TODO: description",
+  "author": "sam <247765564@qq.com>",
+  "homepage": "",
+  "license": "ISC",
+  "main": "lib/index.js",
+  "directories": {
+    "lib": "lib",
+    "test": "__tests__"
+  },
+  "files": [
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://git.imooc.com/class-110/imooc-cli-dev.git"
+  },
+  "scripts": {
+    "test": "echo \"Error: run tests from root\" && exit 1"
+  },
+  "dependencies": {
+    "@imooc-cli-dev-gd/command": "file:../../models/command",
+    "@imooc-cli-dev-gd/log": "file:../../utils/log",
+    "@imooc-cli-dev-gd/git": "file:../../models/git",
+    "fs-extra": "^10.0.0"
+  }
+}

package/core/cli/README.md

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

package/core/cli/__tests__/core.test.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const core = require('..');
+
+describe('core', () => {
+    it('needs tests');
+});

package/core/cli/bin/index.js

@@ -0,0 +1,9 @@
+#! /usr/bin/env node
+
+const importLocal = require('import-local');
+
+if (importLocal(__filename)) {
+  require('npmlog').info('cli', '正在使用 imooc-cli 本地版本');
+} else {
+  require('../lib')(process.argv.slice(2));
+}

package/core/cli/lib/const.js

@@ -0,0 +1,5 @@
+const DEFAULT_CLI_HOME = '.imooc-cli-dev';
+
+module.exports = {
+  DEFAULT_CLI_HOME,
+};