sparrow-ci 1.0.5

package/README.md

@@ -0,0 +1,81 @@
+<!--
+ * @Author: wangqi
+ * @Date: 2022-08-12 15:36:41
+ * @LastEditors: wangqi
+ * @LastEditTime: 2022-09-01 17:17:29
+ * @FilePath: /sparrow-ci/README.md
+ * @Description: README
+-->
+# sparrow-ci
+
+#### 介绍
+基于miniprogram-ci开发的小程序命令行工具
+
+# install
+
+（1）全局安装：
+```shell
+npm install sparrow-ci -g
+```
+（2）也可以只在项目中安装：
+```shell
+npm install sparrow-ci --save-dev
+```
+
+在`package.json`的`scripts`属性下加上：
+
+```json
+  "scripts": {
+    ...
+    "ci": "ci "
+  },
+```
+
+在使用的时候不能像全局安装那样直接使用`ci`了，需要在指令前面加上`npx`。比如，全局安装时上传代码用的是`ci -u`，只在项目中安装时需要使用`npx ci -u`。
+
+# usage
+
+1.使用命令行工具的前提条件是，在微信开发者工具中把服务端口打开。
+
+设置 -> 安全设置 ->  服务端口
+
+2.执行`cli`指令初始化之后，会生成一个`cli.js`文件，文件内容是这样的：
+
+```javascript
+module.exports = {
+  "environment": "DEV",
+  "version": "版本号",
+  "description": "描述文本",
+  "projectRoot": "电脑里面项目的路径",
+  "needCheckNpmPackages": ["需要检查的包的名字"]
+};
+```
+
+在项目代码中引入这个文件的数据，主要是前三个属性，来进行一些处理。
+
+3.指令使用方式：`ci <command>`
+
+` <command>` 是以下选项中的一个：
+
+| 选项            | 简写 | 作用                        |
+| --------------- | ---- | --------------------------- |
+| --publish       | -pub | 上传正式代码                |
+| --upload        | -u   | 上传测试代码                |
+| --preview       | -p   | 预览                        |
+| --switch        | -s   | 切换环境                    |
+| --build-npm     | -b   | npm构建                     |
+| --help          | -h   | 描述如何使用                |
+| --edit-live     | -e   | 编辑live直播插件json        |
+| --git-pull      | -g   | 拉取远端master代码          |
+| --clone         | -c   | 克隆文件夹                  |
+
+比如，上传测试代码：
+
+```shell
+ci --upload
+```
+
+4.注意：
+
++ node版本需大于等于v14.9.0。
+

package/bin/ci.js

@@ -0,0 +1,355 @@
+/*
+ * @Author: wangqi
+ * @Date: 2022-08-12 15:56:29
+ * @LastEditors: wangqi
+ * @LastEditTime: 2022-09-01 17:15:42
+ * @FilePath: /sparrow-ci/bin/ci.js
+ * @Description: 
+*/
+
+const path = require('path');
+const fs = require('fs');
+const inquirer = require('inquirer');
+const chalk = require('chalk');
+const { getProInfo, commonFilePath, configOutPut, createVersion, handleList, printSuccess, printFail, printWarnning, handleVersion } = require('./utils/index');
+const { isDependentExisted, writeToFile, installAndBuild, installPackages, handleLivePlugin, handleExecFile, handleFolder } = require('./utils/node_utils.js');
+const { environment, helpDescription } = require('../ci.config');
+const { uploadCi, packNpmCi, previewCi } = require('./command');
+
+const currentWorkingDirectory = process.cwd(); // 命令执行位置的路径
+
+class Ci {
+  /*
+    @constructor
+    environment 项目环境 默认是开发环境
+    projectRoot 项目路径
+    version 项目版本号
+    description 项目描述
+    miniprogramRoot 代码根路径
+    appJson app.json文件
+    subPackages 所有的分包
+    independentSubPackages 过滤得到独立分包
+    mainCliFilePath cli.js 文件的路径
+    packageJSONPath 项目中package.json文件的位置
+    cliFileExisted cli.js文件是否已经创建了，默认为false
+    needCheckNpmPackages 需要检查更新的包
+    appid
+  */
+  version = '';
+  description = '';
+  miniprogramRoot = '';
+  appJson = '';
+  subPackages = '';
+  mainCliFilePath = '';
+  packageJSONPath = '';
+  cliFileExisted = false;
+  needCheckNpmPackages = '';
+  appid = '';
+  environment = environment.DEV;
+  constructor() {
+    this.projectRoot = currentWorkingDirectory;
+    const { version, description } = getProInfo(currentWorkingDirectory);
+    this.version = version;
+    this.description = description;
+  }
+
+  async init() {
+    // 代码根路径，比如src目录
+    const configJson = commonFilePath(this.projectRoot, 'project.config.json');
+    this.appid = configJson.appid;
+    this.miniprogramRoot = configJson.miniprogramRoot ? path.join(this.projectRoot, configJson.miniprogramRoot) : this.projectRoot;
+    this.appJson = commonFilePath(this.miniprogramRoot, 'app.json');
+    this.subPackages = this.appJson.subPackages;
+    this.independentSubPackages = this.subPackages.filter(inPackage => inPackage.independent);
+    this.mainCliFilePath = path.join(this.miniprogramRoot, 'cli.js');
+    this.packageJSONPath = path.join(this.projectRoot, 'package.json');
+    // 独立分包是否存在
+    isDependentExisted(this.miniprogramRoot, this.independentSubPackages);
+    // cli.js是否存在
+    this.cliFileExisted = await this.checkCliFileCreated();
+    if (!this.cliFileExisted) { // 没有创建cli.js文件，就需要创建
+      this.version = createVersion(); // 初始化版本号
+      const createCliFileSuccess = await this.createCliFile();
+      if (!createCliFileSuccess) return; // cli.js文件没有创建成功直接返回
+
+      const installSuccess = await installPackages(this.packageJSONPath); // 安装依赖
+      if (!installSuccess) return; // 依赖没有安装成功直接返回
+
+      const buildSuccess = await this.buildNpm(); // 构建npm包
+      if (!buildSuccess) return; // 没有构建成功直接返回
+
+      printSuccess('初始化完成');
+    } else { // 已经初始化过，直接读取cli.js文件中的数据
+      this.readCliFile(this.mainCliFilePath);
+    }
+  }
+
+  // 需要的配置参数
+  handleConfigParams() {
+    return {
+      environment: this.environment,
+      version: this.version,
+      description: this.description,
+      projectRoot: this.projectRoot,
+      needCheckNpmPackages: this.needCheckNpmPackages,
+    };
+  }
+
+  // 设置实例的配置信息
+  setConfigInfo(data = {}) {
+    const {
+      environment,
+      version,
+      description,
+      projectRoot,
+      needCheckNpmPackages,
+    } = data;
+    // 给相应属性赋值
+    this.environment = environment;
+    this.version = version;
+    this.description = description;
+    this.projectRoot = projectRoot;
+    this.needCheckNpmPackages = needCheckNpmPackages;
+  }
+
+  // 检查配置文件是否已经创建过了;TODO 如果主包存在，就以主包为准;如果主包不存在，就提示创建;然后复制到所有独立分包中
+  async checkCliFileCreated() {
+    const { mainCliFilePath, independentSubPackages, miniprogramRoot } = this;
+    return new Promise(async (resolve) => {
+      const cliFileExisted = fs.existsSync(mainCliFilePath);
+      if (!cliFileExisted) {
+        resolve(false); // 独立分包不存在
+        return;
+      }
+      // 主包cli文件存在
+      // 复制到分包中
+      const cliFileData = this.formatData(mainCliFilePath);
+      const result = await Promise.all(independentSubPackages.map(inPackage => {
+        const inPackageCliPath = path.join(miniprogramRoot, inPackage.root, 'cli.js');
+        return writeToFile(inPackageCliPath, cliFileData, false);
+      }));
+      if (!result) {
+        fs.rmSync(mainCliFilePath); // 删主包cli文件
+        resolve(false);
+      } else {
+        resolve(true);
+      }
+    });
+  }
+
+  // 创建cli.js文件
+  async createCliFile() {
+    let configInfo = this.handleConfigParams();
+    configInfo.environment = environment.PRO; // 默认是PRO
+    return await this.writeCliFile(configInfo);
+  }
+
+  // 读取cli.js文件的信息
+  readCliFile(filePath) {
+    const cliFileData = require(filePath);
+    const { miniapp_version, version, version_description } = require(this.packageJSONPath);
+    // 把package里的版本和版本描述同步到cli中，当使用cli -u时写入到cli
+    // 22.1.8新加miniapp_version
+    cliFileData.version = miniapp_version || version;
+    cliFileData.description = version_description || ''
+    this.setConfigInfo(cliFileData);
+  }
+
+  // 写cli.json文件
+  async writeCliFile(data = {}) {
+    return new Promise(async (resolve) => {
+      // 默认值是初始化实例后对应的属性的值
+      const {
+        environment = this.environment,
+        version = this.version,
+        description = this.description,
+        projectRoot = this.projectRoot,
+        needCheckNpmPackages = this.needCheckNpmPackages.join(','),
+      } = data;
+
+      // 这个对象是为了用来初始化cli实例的
+      const configData = {
+        environment,
+        version,
+        description,
+        projectRoot,
+        needCheckNpmPackages,
+      };
+
+      const configDataString = this.formatData('', false, configData);
+
+      const r1 = writeToFile(this.mainCliFilePath, configDataString);
+      const r2 = Promise.all(this.independentSubPackages.map(inPackage => {
+        const inPackageCliPath = path.join(this.miniprogramRoot, inPackage.root, 'cli.js');
+        return writeToFile(inPackageCliPath, configDataString);
+      }))
+      let result1 = await r1;
+      let result2 = await r2;
+
+      if (result1 && result2) {
+        this.setConfigInfo(configData);
+      }
+      resolve(result1 && result2);
+    });
+  }
+
+  // 展示简单的配置信息
+  async showSimpleCliConfig(type) {
+    let promptArr = handleList(['environment', 'version', 'description'], { environmentType: this.environment, version: this.version, description: this.description });
+    if (type === 'publish') {
+      // 如果是publish, 移除选择环境，默认PRO
+      promptArr.shift();
+      this.environment = environment.PRO;
+    }
+    return new Promise((resolve) => {
+      inquirer
+        .prompt(promptArr)
+        .then(async (answers) => {
+          const { version } = answers;
+          if (!version) {
+            printWarnning('项目版本号为必填');
+            resolve(false);
+            return;
+          }
+          await this.writeCliFile(answers);
+          resolve(answers);
+        })
+        .catch(error => {
+          console.log(`提问简单配置信息的时候出错，error：`, error);
+          resolve(false);
+        });
+    });
+  }
+
+  // 组合文件要写的内容
+  formatData(filePath, isTrue = true, configParams) {
+    if (isTrue) this.readCliFile(filePath);
+    const needCheckNpmPackages = isTrue ? this.needCheckNpmPackages.join(',') : configParams.needCheckNpmPackages;
+    let needCheckNpmPackagesArr = [];
+    if (needCheckNpmPackages) {
+      needCheckNpmPackagesArr = needCheckNpmPackages.split(',');
+    }
+    const needCheckNpmPackagesString = JSON.stringify(needCheckNpmPackagesArr);
+    if (!isTrue) {
+      const { environment, version, description, projectRoot } = configParams;
+      return configOutPut(environment, version, description, projectRoot, needCheckNpmPackagesString)
+    };
+    return configOutPut(this.environment, this.version, this.description, this.projectRoot, needCheckNpmPackagesString);
+  }
+
+  async online() {
+    await this.upload('online');
+  }
+
+  async publish() {
+    // 拉取master
+    await this.pull();
+    // 处理直播插件 默认添加
+    const writeFileSuccess = await handleLivePlugin(this.miniprogramRoot);
+    if (writeFileSuccess) {
+      printSuccess(`直播插件${writeFileSuccess}`);
+    }
+    await this.upload('publish');
+  }
+
+  // 上传代码
+  // @isPublish 是否自动上传
+  async upload(type = 'upload') {
+    const installAndBuildSuccess = await installAndBuild(this.needCheckNpmPackages, this.packageJSONPath, this.miniprogramRoot); // 检查安装的版本和package.json文件中的版本是否一致，不一致的话要重新安装和构建
+    if (!installAndBuildSuccess) return;
+    // 获取用户填写的版本和描述，写入cli
+    if (type !== 'online') {
+      const answers = await this.showSimpleCliConfig(type);
+      if (!answers) return;
+    }
+    await uploadCi({
+      projectPath: this.projectRoot,
+      version: this.version,
+      description: this.description,
+      keyPath: this.miniprogramRoot,
+      appid: this.appid,
+    });
+    if (type === 'online') return;
+    const packageObj = require(this.packageJSONPath);
+    packageObj.miniapp_version = this.version;
+    packageObj.version = handleVersion(this.version);
+    packageObj.version_description = this.description;
+    const packageStr = JSON.stringify(packageObj, null, 2);
+    writeToFile(this.packageJSONPath, packageStr);
+    console.log(`上传成功后可至微信小程序管理后台 ${chalk.blue('https://mp.weixin.qq.com/wxamp/wacodepage/getcodepage')} 将上传的版本选为体验版`);
+  }
+
+  // 构建
+  async buildNpm() {
+    const data = await packNpmCi({
+      packageJSONPath: this.packageJSONPath,
+      miniprogramRoot: this.miniprogramRoot,
+    });
+    return data;
+  }
+
+  // 预览
+  preview() {
+    previewCi({
+      version: this.version,
+      description: this.description,
+      projectPath: this.projectRoot,
+      keyPath: __dirname,
+      projectRoot: this.projectRoot
+    })
+  }
+
+  // 添加/删除直播插件
+  subscribe() {
+    let promptArr = handleList(['status'], { status: 'add' });
+    inquirer
+      .prompt(promptArr)
+      .then(async (answers) => {
+        const writeFileSuccess = await handleLivePlugin(this.miniprogramRoot, answers.status);
+        if (writeFileSuccess) {
+          printSuccess(`直播插件${writeFileSuccess}`);
+        }
+      })
+      .catch(error => {
+        printFail(`${error}`);
+      });
+  }
+
+  // 拉取远端代码
+  async pull() {
+    //获取文件路径
+    const filepath = path.join(__dirname, '../git.sh');
+    // 执行拉取
+    await handleExecFile(filepath);
+  }
+
+  // 克隆文件夹(克隆到独立分包)
+  clone() {
+    handleFolder(this.independentSubPackages, this.miniprogramRoot);
+  }
+
+  // 切换项目环境
+  switch() {
+    const promptArr = handleList(['environment'], { environmentType: this.environment });
+    inquirer
+      .prompt(promptArr)
+      .then(async (answers) => {
+        const { environment } = answers;
+        const writeFileSuccess = await this.writeCliFile(answers);
+        if (writeFileSuccess) {
+          printSuccess(`环境已成功切换为${environment}`);
+        }
+      })
+      .catch(error => {
+        printFail(`${error}`);
+      });
+  }
+
+  // 帮助
+  // 查看帮助
+  help() {
+    console.log(helpDescription);
+  }
+}
+
+module.exports = Ci;

package/bin/command/index.js

@@ -0,0 +1,136 @@
+/*
+ * @Author: wangqi
+ * @Date: 2022-08-12 10:20:19
+ * @LastEditors: wangqi
+ * @LastEditTime: 2022-09-01 17:17:37
+ * @FilePath: /sparrow-ci/bin/command/index.js
+ * @Description: 上传代码
+ */
+
+const ci = require("miniprogram-ci");
+const path = require('path');
+const ora = require("ora");
+const chalk = require('chalk');
+const { handleCodeSize, getKeyName } = require('../utils/index');
+
+function project(params) {
+  const { projectPath, keyPath, appid } = params;
+  const project = new ci.Project({
+    appid,
+    type: "miniProgram",
+    projectPath,
+    privateKeyPath: getKeyName(path.join(keyPath, '/key/')),
+    ignores: ["node_modules/**/*"],
+  });
+  return project;
+}
+
+async function uploadCi(params) {
+  const spinner = ora(`${chalk.blue('准备上传')}\n`).start();
+  spinner.color = 'blue';
+  const { version, description } = params;
+  try {
+    const { subPackageInfo } = await ci.upload({
+      project: project(params),
+      version,
+      desc: description,
+      setting: {
+        es6: true, // 对应小程序开发者工具的 "es6 转 es5"
+        minify: true, // 压缩所有代码，对应小程序开发者工具的 "压缩代码"
+        autoPrefixWXSS: true, // 对应小程序开发者工具的 "样式自动补全"
+        minifyWXML: true, // 压缩 WXML 代码
+        minifyWXSS: true, // 压缩 WXSS 代码
+        minifyJS: true, // 压缩 JS 代码
+      },
+      robot: 1,
+      onProgressUpdate: (res) => {
+        const { _status } = res;
+        if (_status === 'doing') {
+          spinner.text = `${chalk.blue('上传代码中')}\n`;
+          spinner.color = 'blue';
+        }
+        if (_status === 'done') {
+          spinner.text = `${chalk.green('上传完成')}\n`;
+          spinner.color = 'green';
+          spinner.succeed();
+        }
+      },
+    });
+    console.table(handleCodeSize(subPackageInfo));
+  } catch(err) {
+    spinner.text = `${chalk.red('上传失败')}\n${chalk.yellow(err)}`;
+    spinner.fail();
+  }
+}
+
+// 注意当前构建存在问题
+function packNpmCi(params) {
+  return new Promise(async (resolve) => {
+    const spinner = ora(`${chalk.blue('构建中')}\n`).start();
+    spinner.color = 'blue';
+    const { packageJSONPath, miniprogramRoot } = params;
+    const { miniProgramPackNum, otherNpmPackNum, warnList} = await ci.packNpmManually({
+      packageJsonPath: packageJSONPath,
+      miniprogramNpmDistDir: miniprogramRoot,
+    })
+
+    if ((miniProgramPackNum > 0 || otherNpmPackNum > 0) && warnList.length === 0) {
+      spinner.text = `${chalk.green('构建成功')}\n${chalk.green(`miniProgramPackNum: ${miniProgramPackNum}个，otherNpmPackNum:${otherNpmPackNum}个`)}`;
+      spinner.color = 'green';
+      spinner.succeed();
+    }
+
+    if (warnList.length > 0) {
+      warnList.forEach(item => {
+        spinner.text = `${chalk.yellow('提示')}\n${chalk.yellow(`${item.jsPath}，${item.msg}`)}`;
+        spinner.warn();
+      })
+    }
+    resolve(true);
+  });
+}
+
+async function previewCi(params) {
+  const { version, description, pagePath, searchQuery, scene, projectRoot, keyPath } = params;
+  const previewResult = await ci.preview({
+    project: project(params),
+    desc: description,
+    version,
+    setting: {
+      es6: true, // 对应小程序开发者工具的 "es6 转 es5"
+      minify: true, // 压缩所有代码，对应小程序开发者工具的 "压缩代码"
+      autoPrefixWXSS: true, // 对应小程序开发者工具的 "样式自动补全"
+      minifyWXML: true, // 压缩 WXML 代码
+      minifyWXSS: true, // 压缩 WXSS 代码
+      minifyJS: true, // 压缩 JS 代码
+    },
+    qrcodeFormat: 'base64',
+    qrcodeOutputDest: '/Users/wq/Desktop/qrcode/destination.jpg',
+    onProgressUpdate: (res) => {
+      const { _status, subPackageInfo } = res;
+      if (_status === 'doing') {
+        console.log('==============');
+        console.log('_status', _status);
+        console.log('==============');
+      }
+      if (_status === 'done') {
+        console.log('==============');
+        console.log('_status', _status, subPackageInfo);
+        console.log('==============');
+      }
+    },
+    pagePath, // 预览页面 pages/index/index
+    searchQuery,  // 预览参数 [注意!]这里的`&`字符在命令行中应写成转义字符`\&` a=1&b=2
+    scene, // 场景值 1011
+  })
+  const { subPackageInfo } = previewResult;
+  console.log('==============');
+  console.log('subPackageInfo', subPackageInfo);
+  console.log('==============');
+}
+
+module.exports = {
+  uploadCi,
+  packNpmCi,
+  previewCi
+}

package/bin/main.js

@@ -0,0 +1,70 @@
+#!/usr/bin/env node
+
+/*
+ * @Author: wangqi
+ * @Date: 2020-11-06 13:33:56
+ * @LastEditTime: 2022-08-31 17:23:47
+ * @LastEditor: wangqi
+ * @Description: 脚手架的类
+*/
+
+const { program } = require('commander');
+const Ci = require('./ci');
+
+// 设置命令行的选项
+program
+  .option('-o, --online', '自动发布代码')
+  .option('-pub, --publish', '发布正式环境代码')
+  .option('-u, --upload', '上传代码')
+  .option('-p, --preview', '预览')
+  .option('-s, --switch', '切换环境')
+  .option('-b, --build-npm', 'npm构建')
+  .option('-e, --edit-live', '编辑live直播插件json')
+  .option('-g, --git-pull', '拉取远端master代码')
+  .option('-c, --clone', '克隆文件夹')
+  .option('-h, --help', '描述如何使用')
+
+program.parse(process.argv); // 处理传入的参数
+
+async function main () {
+  const ci = new Ci();
+  // 等待实例初始化完成
+  await ci.init();
+  switch (true) {
+    case Boolean(program.online): // 自动发布代码
+      ci.online();
+      break;
+    case Boolean(program.publish): // 发布正式环境代码
+      ci.publish();
+      break;
+    case Boolean(program.upload): // 上传
+      ci.upload();
+      break;
+    case Boolean(program.preview): // 预览
+      ci.preview();
+      break;
+    case Boolean(program.switch): // 切换项目环境
+      ci.switch();
+      return;
+    case Boolean(program.buildNpm): // npm构建
+      ci.buildNpm();
+      break;
+    case Boolean(program.editLive): // 编辑直播插件
+      ci.subscribe();
+      break;
+    case Boolean(program.gitPull): // 编辑直播插件
+      ci.pull();
+      break;
+    case Boolean(program.clone): // 编辑直播插件
+      ci.clone();
+      break;
+    case Boolean(program.help): // 查看帮助
+      ci.help();
+      break;
+    default: // 默认是查看帮助
+      ci.help();
+      break;
+  }
+}
+
+main();

package/bin/utils/index.js

@@ -0,0 +1,203 @@
+/*
+ * @Author: wangqi
+ * @Date: 2022-08-12 17:10:25
+ * @LastEditors: wangqi
+ * @LastEditTime: 2022-09-01 18:13:11
+ * @FilePath: /sparrow-ci/bin/utils/index.js
+ * @Description: 公用方法
+ */
+
+const path = require('path');
+const fs = require('fs');
+const chalk = require('chalk');
+const logSymbols = require('log-symbols');
+const { environment, folderSrc } = require('../../ci.config');
+
+// 数字补0
+function formatNumber(number) {
+  if (number > 0 && number < 10) {
+    return `0${number}`;
+  }
+  return number;
+}
+
+/**
+ *  处理版本号为三位，因为写入小程序package.json里的version如果不是三位，那么构建npm的时候虽然显示构建成功，但实际没有构建
+ * 
+ */
+function handleVersion(miniappVersion) {
+  let version = '';
+  const arr = miniappVersion.split('.');
+  arr.length = 3;
+  version = arr.join('.');
+  return version;
+}
+
+// 获取项目版本和描述
+function getProInfo(projectRoot) {
+  const packageJson = commonFilePath(projectRoot, 'package.json'); // 项目package.json的路径
+  const { miniapp_version, version_description } = packageJson;
+  return {
+    version: miniapp_version, 
+    description: version_description,
+  }
+}
+
+function commonFilePath(pathUrl, file) {
+  return require(path.join(pathUrl, file));
+}
+
+// 输出需要的配置
+function configOutPut(environment, version, description, projectRoot, needCheckNpmPackagesString) {
+  const configDataString =
+    `module.exports = {
+  "environment": "${environment}",
+  "version": "${version}",
+  "description": "${description}",
+  "projectRoot": "${projectRoot}",
+  "needCheckNpmPackages": ${needCheckNpmPackagesString}
+};
+`;
+  return configDataString;
+}
+
+// 创建版本号，目前的版本号是这样的：21.7.261
+function createVersion(lastNumber) {
+  const date = new Date();
+  const currentYear = date.getFullYear();
+  const currentMonth = date.getMonth() + 1;
+  const currentDate = date.getDate();
+  const lastVersionNumber = lastNumber || 1;
+  const versionNumber = `${currentYear.toString().slice(2)}.${currentMonth}.${currentDate}${lastVersionNumber}`;
+  return versionNumber;
+}
+
+// 打印警告的信息
+function printWarnning(message) {
+  console.log(logSymbols.warning, chalk.yellow(message));
+}
+
+// 打印成功的信息
+function printSuccess(message) {
+  console.log(logSymbols.success, chalk.green(message));
+}
+
+// 打印失败的信息
+function printFail(message) {
+  console.log(logSymbols.error, chalk.red(message));
+}
+
+// 处理列表
+function handleList(listName, configObj, independentSubPackages) {
+  let { environmentType, version, description, projectRoot, typeName, defaultDestinationRelativePath, status, folderName, positionName } = configObj;
+  let folderDest = [];
+  if (independentSubPackages && independentSubPackages.length > 0) {
+    independentSubPackages.forEach((item) => {
+      folderDest.push(item.root);
+    })
+  }
+  const listChioce = [
+    {
+      name: 'environment',
+      type: 'list',
+      default: environmentType,
+      message: '项目环境：',
+      choices: [environment.DEV, environment.PRO],
+    },
+    {
+      name: 'version',
+      type: 'input',
+      default: version,
+      message: '项目版本：',
+    },
+    {
+      name: 'description',
+      type: 'input',
+      default: description,
+      message: '项目描述：',
+    },
+    {
+      name: 'projectRoot',
+      type: 'input',
+      default: projectRoot,
+      message: '项目根路径：'
+    },
+    {
+      name: 'needCheckNpmPackages',
+      type: 'input',
+      default: '',
+      message: '需要检查更新的组件（以,分隔）：',
+    },
+    {
+      name: 'name',
+      type: 'input',
+      default: '',
+      message: `${typeName}名称：`,
+    },
+    {
+      name: 'location',
+      type: 'input',
+      default: defaultDestinationRelativePath,
+      message: `${typeName}位置：`,
+      suffix: '(相对项目根目录，且路径以/结尾)',
+    },
+    {
+      name: 'status',
+      type: 'list',
+      default: status,
+      message: '直播插件：',
+      choices: ['add', 'delete'],
+    },
+    {
+      name: 'folderName',
+      type: 'list',
+      default: folderName,
+      message: '源目录：',
+      choices: folderSrc,
+    },
+    {
+      name: 'positionName',
+      type: 'list',
+      default: positionName,
+      message: '目标目录：',
+      choices: folderDest,
+    },
+  ];
+  let arr = [];
+  listName.forEach(type => {
+    listChioce.forEach(item => {
+      if (type === item.name) {
+        arr.push(item);
+      }
+    })
+  })
+  return arr;
+}
+
+function handleCodeSize(arr) {
+  let value = JSON.parse(JSON.stringify(arr).replace(/size/g,'sizeByte'));
+
+  value.forEach(item => {
+    item.size = (item.sizeByte / 1024).toFixed(2) + 'kb';
+  });
+  return value;
+}
+
+function getKeyName(pathUrl) {
+  const file = fs.readdirSync(pathUrl);
+  return path.join(pathUrl, file[0]);
+}
+
+module.exports = {
+  printWarnning,
+  printSuccess,
+  printFail,
+  getProInfo,
+  commonFilePath,
+  configOutPut,
+  createVersion,
+  handleList,
+  handleCodeSize,
+  handleVersion,
+  getKeyName,
+}

package/bin/utils/node_utils.js

@@ -0,0 +1,276 @@
+/*
+ * @Author: wangqi
+ * @Date: 2022-08-26 10:39:50
+ * @LastEditors: wangqi
+ * @LastEditTime: 2022-09-01 17:16:49
+ * @FilePath: /sparrow-ci/bin/utils/node_utils.js
+ * @Description: 工具方法
+ */
+
+const path = require('path');
+const ora = require('ora');
+const chalk = require('chalk');
+const fs = require('fs');
+const logSymbols = require('log-symbols');
+const inquirer = require('inquirer');
+const { spawnSync } = require('child_process');
+const { mkdirSync, existsSync, writeFile, readFile, execFile } = require('fs');
+const { handleList, printSuccess, printWarnning, printFail } = require('./index');
+const { packNpmCi } = require('../command');
+const { liveJsonArr, liveUrl, folderSrc } = require('../../ci.config');
+
+// 判断独立分包文件是否存在
+function isDependentExisted(miniprogramRoot, independentSubPackages) {
+  for (let i = 0; i < independentSubPackages.length; i++) {
+    const inPackagePath = path.join(miniprogramRoot, independentSubPackages[i].root);
+    if (!existsSync(inPackagePath)) {
+      mkdirSync(inPackagePath);
+    }
+  }
+}
+
+// 写入文件
+function writeToFile(filePath, configDataString, isLog = true) {
+  return new Promise((resolve) => {
+    writeFile(filePath, configDataString, (err) => {
+      if (err) {
+        console.log(chalk.red(`写入${filePath}文件失败，error：${err}`, chalk.green(`请输入cli重新执行`)));
+        resolve(false);
+      }
+      if (isLog) printSuccess(`写入${filePath}文件成功`)
+      resolve(true);
+    });
+  });
+}
+
+// 提问用户初始化相关的问题
+async function askUsersInitQuestions(params) {
+  const { environment, version, description, projectRoot, needCheckNpmPackages } = params;
+  const promptArr = handleList(['environment', 'version', 'description', 'projectRoot', 'needCheckNpmPackages'], { environment, version, description, projectRoot, needCheckNpmPackages });
+  return new Promise((resolve) => {
+    inquirer
+      .prompt(promptArr)
+      .then(answers => {
+        const { projectRoot } = answers;
+        if (!projectRoot) {
+          console.log(chalk.red('初始化失败'), `${chalk.yellow('微信开发者工具的命令行工具的安装路径')}和${chalk.yellow('项目根路径')}是必填项!`);
+          resolve(false);
+          return;
+        }
+        console.log('==============');
+        console.log('answers', answers);
+        console.log('==============');
+        resolve(answers);
+      })
+      .catch(error => {
+        console.log(`回答初始化相关问题中出现的错误，error：`, error);
+        resolve(false);
+      })
+  });
+}
+
+// 检查npm包的版本是否一直
+function checkNpmVersionConsistent(needCheckNpmPackages, packageJSONPath) {
+  return new Promise((resolve) => {
+    const checkedPackagesCount = needCheckNpmPackages.length;
+
+    const packageJSON = require(packageJSONPath);
+
+    let inconsistentPackages = []; // 版本不一致的包
+    let count = 0;
+
+    if (checkedPackagesCount < 1) {
+      resolve(inconsistentPackages);
+      return;
+    }
+
+    for (let i = 0; i < checkedPackagesCount; i++) {
+      const packageName = needCheckNpmPackages[i];
+      if (packageName) {
+        let installedPackageVersion = spawnSync('npm', ['ls', packageName]); // 检查这个包本地安装的版本
+        installedPackageVersion = installedPackageVersion.stdout.toString().trim();
+        const packageNameIndex = installedPackageVersion.indexOf(packageName);
+        installedPackageVersion = packageNameIndex === -1 ? '' : installedPackageVersion.slice(packageNameIndex + packageName.length + 1);
+
+        const packageVersionInPackageJSON = packageJSON.dependencies[packageName]; // 本地package.json文件中包的版本
+        let packageLocalVersion = packageVersionInPackageJSON;
+        if (packageVersionInPackageJSON.indexOf('^') > -1) { // 如果版本号包含^，需要把^去掉
+          packageLocalVersion = packageVersionInPackageJSON.slice(1);
+        }
+
+        if (installedPackageVersion !== packageLocalVersion) {
+          inconsistentPackages.push(packageName + `@${packageLocalVersion}`);
+        }
+      }
+      count++;
+      if (count === checkedPackagesCount) {
+        resolve(inconsistentPackages);
+      }
+    }
+  });
+}
+
+// 安装和进行npm构建
+async function installAndBuild(needCheckNpmPackages, packageJSONPath, miniprogramRoot) {
+  const checkedPackagesCount = needCheckNpmPackages.length;
+  if (checkedPackagesCount === 0) return true; // 没有设置要检查的包
+  const checkConsistentSpinner = ora('检查package.json文件中包的版本与实际安装的版本是否一致...').start();
+  const inconsistentPackages = await checkNpmVersionConsistent(); // 检查npm包的版本是否一致
+  checkConsistentSpinner.stop();
+  if (inconsistentPackages.length < 1) {
+    console.log('package.json文件中包的版本与实际安装的版本一致', chalk.magenta('不必重新构建'));
+    return true;
+  }
+  const inconsistentPackagesStr = inconsistentPackages.join(',');
+  // package.json中包的版本和实际安装的版本不一致时，重新进行npm install 和 npm 构建
+  console.log(`package.json文件中`, chalk.magenta(`${inconsistentPackagesStr}`), `包的版本与实际安装的版本不同，`, chalk.magenta(`重新进行npm安装和npm构建中，请稍候...`));
+  const installSuccess = await installPackages(packageJSONPath, inconsistentPackages);
+  if (!installSuccess) return; // 依赖没有安装成功直接返回
+  return await packNpmCi({packageJSONPath, miniprogramRoot});
+}
+
+// 安装依赖
+async function installPackages(packageJSONPath, packageNames = []) {
+  return new Promise((resolve) => {
+    const installPackagesOra = ora('npm install 安装依赖中...').start();
+    // 如果package.json文件存在就安装依赖
+    if (existsSync(packageJSONPath)) {
+      const npmInstall = spawnSync(
+        'npm',
+        ['install', ...packageNames],
+        { stdio: 'inherit' }
+      );
+      const { status } = npmInstall;
+      const installSuccess = status === 0;  // 根据实验，status为0的时候安装成功，status为1的时候安装失败
+      if (installSuccess) {
+        installPackagesOra.succeed();
+        printSuccess('依赖安装成功');
+      } else {
+        installPackagesOra.fail('依赖安装失败')
+      }
+      resolve(installSuccess);
+    } else {
+      installPackagesOra.fail('执行失败');
+      console.log(logSymbols.warning, chalk.red('此项目没有package.json文件'));
+      resolve(false);
+    }
+  });
+}
+
+// 处理直播插件
+function handleLivePlugin(pathFile, status = 'add') {
+  return new Promise((resolve, reject) => {
+    liveJsonArr.forEach(item => {
+      readFile(path.join(pathFile, item), 'utf8', (err, data) => {
+        if (err) {
+          reject(err);
+          return
+        }
+
+        const configComponent = JSON.parse(data);
+        let { usingComponents } = configComponent;
+
+        if (!usingComponents) reject(err);
+
+        if (status === 'add') { // 添加
+          if (usingComponents.subscribe) {
+            resolve('已添加！');
+            return;
+          }
+          usingComponents.subscribe = liveUrl;
+        } else { // 删除
+          if (!usingComponents.subscribe) {
+            resolve('已删除！');
+            return;
+          };
+          delete usingComponents.subscribe;
+        }
+        writeFile(path.join(pathFile, item), JSON.stringify(configComponent, null, "\t"), "utf8", (err1) => {
+          if (err1) {
+            reject(err1);
+            return;
+          }
+          resolve(status === 'add' ? '添加成功' : '删除成功');
+        })
+      });
+    });
+  });
+}
+
+async function handleExecFile(filePath) {
+  const { stdout, stderr } = await execFile(filePath, { cwd: '.' });
+  console.log('===================================');
+  console.log(stdout);
+  console.log(stderr);
+  console.log('===================================');
+}
+
+/**
+ * 复制文件夹到目标文件夹
+ * @param {string} src 源目录
+ * @param {string} dest 目标目录
+ * @param {function} callback 回调
+*/
+function handleFolder(independentArr, rootPath) {
+  const copyDir = (src, dest, callback) => {
+    const copy = (copySrc, copyDest) => {
+      fs.readdir(copySrc, (err, list) => {
+        if (err) {
+          callback(err);
+          return;
+        }
+        list.forEach((item) => {
+          const filePath = path.resolve(copySrc, item);
+          fs.stat(filePath, (err, stat) => {
+            if (err) {
+              callback(err);
+            } else {
+              const curSrc = path.resolve(copySrc, item);
+              const curDest = path.resolve(copyDest, item);
+
+              if (stat.isFile()) {
+                // 文件，直接复制
+                fs.createReadStream(curSrc).pipe(fs.createWriteStream(curDest));
+              } else if (stat.isDirectory()) {
+                // 目录，进行递归
+                fs.mkdirSync(curDest, { recursive: true });
+                copy(curSrc, curDest);
+              }
+            }
+          });
+        });
+      });
+    };
+
+    fs.access(dest, (err) => {
+      if (err) {
+        // 若目标目录不存在，则创建
+        fs.mkdirSync(dest, { recursive: true });
+      }
+      copy(src, dest);
+    });
+  };
+  for (let i = 0; i < folderSrc.length; i++) {
+    for (let j = 0; j < independentArr.length; j++) {
+      copyDir(rootPath + folderSrc[i], rootPath + independentArr[j].root + '/' + folderSrc[i], (err) => {
+        console.log('==============');
+        console.log(chalk.red(err));
+        console.log('==============');
+      });
+    }
+  }
+  console.log('==============');
+  console.log(chalk.yellow('复制成功！'));
+  console.log('==============');
+}
+
+module.exports = {
+  isDependentExisted,
+  writeToFile,
+  askUsersInitQuestions,
+  installAndBuild,
+  installPackages,
+  handleLivePlugin,
+  handleExecFile,
+  handleFolder,
+}

package/ci.config.js

@@ -0,0 +1,41 @@
+/*
+ * @Author: wangqi
+ * @Date: 2022-04-29 17:18:33
+ * @LastEditors: wangqi
+ * @LastEditTime: 2022-08-31 17:35:45
+ * @FilePath: /sparrow-ci/ci.config.js
+ * @Description: 全局配置文件
+*/
+
+module.exports = {
+  environment: {
+    DEV: 'DEV', // 开发环境
+    PRO: 'PRO', // 生产环境
+  },
+  miniShopPath: '/Users/wq/Desktop/company/miniapp_shop',
+  // 直播插件地址
+  liveUrl: 'plugin-private://wx2b03c6e691cd7370/components/subscribe/subscribe',
+  // 直播插件数组
+  liveJsonArr: ['subpackages/shop/components/live/index.json', 'independent_shop/shop/components/live/index.json'],
+  // 源目录
+  folderSrc: ['sparrow_utils', 'sparrow_ui'],
+  // 帮助配置
+  helpDescription: `
+    使用方式：cli <command>
+        
+    <command> 是以下选项中的一个：
+
+
+    | 选项            | 简写 | 作用                        |
+    | --------------- | ---- | --------------------------- |
+    | --publish       | -pub | 上传正式代码                |
+    | --upload        | -u   | 上传测试代码                |
+    | --preview       | -p   | 预览                        |
+    | --switch        | -s   | 切换环境                    |
+    | --build-npm     | -b   | npm构建                     |
+    | --help          | -h   | 描述如何使用                |
+    | --edit-live     | -e   | 编辑live直播插件json        |
+    | --git-pull      | -g   | 拉取远端master代码          |
+    | --clone         | -c   | 克隆文件夹                  |
+  `,
+};

package/git.sh

@@ -0,0 +1,15 @@
+###
+ # @Author: wangqi
+ # @Date: 2022-05-06 10:24:20
+ # @LastEditors: wangqi
+ # @LastEditTime: 2022-08-12 15:54:14
+ # @FilePath: /sparrow-ci/git.sh
+ # @Description: git拉取脚本命令
+### 
+
+# 开始拉取远端upstream master
+echo '正在拉取upstream master代码...'
+
+git pull upstream master
+
+echo '执行拉取upstream master命令成功！'

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "sparrow-ci",
+  "version": "1.0.5",
+  "description": "基于miniprogram-ci开发的小程序命令行工具",
+  "main": "",
+  "bin": {
+    "ci": "bin/main.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/dsba/sparrow-ci.git"
+  },
+  "author": "wangqi",
+  "license": "ISC",
+  "dependencies": {
+    "chalk": "^4.1.0",
+    "commander": "^6.1.0",
+    "inquirer": "^7.3.3",
+    "log-symbols": "^4.0.0",
+    "miniprogram-ci": "^1.8.35",
+    "ora": "^5.1.0"
+  }
+}