upload-miniprogram 0.0.20

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2025-10-22
+
+### Added
+- 初始版本发布
+- 支持微信小程序代码上传
+- 支持预览二维码生成
+- 支持多环境配置
+- 命令行接口和编程接口
+- Jenkins CI/CD集成支持
+- 交互式参数输入

package/README.md

@@ -0,0 +1,111 @@
+# upload-miniprogram
+
+微信小程序CI/CD上传工具，支持自动上传代码和生成预览二维码。
+
+## 功能特性
+
+- ✅ 自动上传小程序代码到微信开发者平台
+- ✅ 生成预览二维码
+- ✅ 支持多环境配置 (开发/测试/预发布/生产)
+- ✅ 支持命令行参数和交互式输入
+- ✅ 集成Jenkins CI/CD环境
+- ✅ 自动获取Git用户信息
+
+## 安装
+
+```bash
+npm install -g upload-miniprogram
+```
+
+或者作为开发依赖安装：
+
+```bash
+npm install --save-dev upload-miniprogram
+```
+
+## 使用方法
+
+### 命令行方式
+
+```bash
+# 基本用法
+upload-miniprogram --appid your-appid --project-path ./dist --version 1.0.0
+
+# 完整参数
+upload-miniprogram \
+  --appid your-appid \
+  --project-path ./dist \
+  --version 1.0.0 \
+  --desc "功能更新" \
+  --user developer@example.com \
+  --env production
+```
+
+### 参数说明
+
+| 参数 | 缩写 | 必填 | 说明 |
+|------|------|------|------|
+| --appid | -a | 是 | 小程序ID |
+| --project-path | -p | 是 | 小程序项目打包后的代码路径 |
+| --version | -v | 是 | 版本号 |
+| --desc | -d | 否 | 版本描述 |
+| --user | -u | 否 | 上传用户 |
+| --env | -e | 否 | 环境变量 (development\|staging\|uat\|production) |
+
+### 编程方式
+
+```javascript
+const uploadMiniprogram = require('upload-miniprogram');
+
+// 使用默认配置
+uploadMiniprogram({
+  appid: 'your-appid',
+  projectPath: './dist',
+  version: '1.0.0',
+  desc: '功能更新',
+  user: 'developer@example.com',
+  env: 'production'
+});
+
+// 或者使用类方式
+const { UploadMiniprogram } = require('upload-miniprogram');
+const uploader = new UploadMiniprogram(options);
+await uploader.run();
+```
+
+## 环境配置
+
+### 私钥配置
+
+工具需要微信小程序的私钥文件才能上传代码。私钥文件应该放在以下位置：
+
+**本地开发环境：**
+```
+./scripts/private.{appid}.key
+```
+
+**Jenkins环境：**
+```
+${WORKSPACE}/../mp-ci-upload-key/private.{appid}.key
+```
+
+### 环境变量
+
+支持以下环境：
+
+| 环境 | 版本后缀 | 机器人 | 描述 |
+|------|----------|--------|------|
+| development | .dev | 1 | 开发环境 |
+| staging | .staging | 2 | 测试环境 |
+| uat | .uat | 3 | 预发布环境 |
+| production | (无) | 5 | 生产环境 |
+
+## Jenkins集成
+
+在Jenkins中配置环境变量：
+
+
+
+## 许可证
+
+MIT

package/bin/upload-miniprogram.js

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+
+const { program } = require('commander');
+const uploadMiniprogram = require('../lib/index');
+
+program
+  .version('1.0.0')
+  .description('微信小程序CI/CD上传工具')
+  .option('-a, --appid <appid>', '小程序ID')
+  .option('-p, --project-path <path>', '小程序项目打包后的代码路径')
+  .option('-v, --version <version>', '版本号')
+  .option('-d, --desc <desc>', '版本描述')
+  .option('-u, --user <user>', '上传用户')
+  .option('-e, --env <env>', '环境变量 (development|staging|uat|production)', 'development')
+  .parse(process.argv);
+
+const options = program.opts();
+
+// 设置环境变量
+if (options.env) {
+  process.env.NODE_ENV = options.env;
+}
+
+uploadMiniprogram({
+  appid: options.appid,
+  projectPath: options.projectPath,
+  version: options.version,
+  desc: options.desc,
+  user: options.user
+});

package/lib/index.js

@@ -0,0 +1,194 @@
+const ci = require("miniprogram-ci");
+const { execSync } = require("child_process");
+const inquirer = require("inquirer");
+
+class UploadMiniprogram {
+  constructor(options = {}) {
+    this.options = options;
+    this.WORKSPACE = process.env.WORKSPACE;
+    this.ENV = process.env.NODE_ENV || 'development';
+    
+    this.ENV_MAP = {
+      development: { v: ".dev", desc: "【Dev环境】", robot: 1 },
+      staging: { v: ".staging", desc: "【Staging环境】", robot: 2 },
+      uat: { v: ".uat", desc: "【Uat环境】", robot: 3 },
+      production: { v: "", desc: "【正式环境】", robot: 5 },
+    };
+  }
+
+  // 获取 Git 邮箱
+  getGitEmail() {
+    try {
+      return execSync("git config --global user.email", {
+        encoding: "utf8",
+      }).trim();
+    } catch (error) {
+      console.error("无法获取 Git 邮箱:", error.message);
+      return null;
+    }
+  }
+
+  // 构建私钥路径
+  getPrivateKeyPath(appid) {
+    const isJenkins = Boolean(process.env.BUILD_URL);
+    const template = isJenkins 
+      ? "${WORKSPACE}/../mp-ci-upload-key/private.${APP_ID}.key"
+      : "./scripts/private.${APP_ID}.key";
+    
+    return template
+      .replace("${WORKSPACE}", this.WORKSPACE || "")
+      .replace("${APP_ID}", appid);
+  }
+
+  // 构建预览码路径
+  getPreviewCodePath() {
+    const isJenkins = Boolean(process.env.BUILD_URL);
+    const template = isJenkins 
+      ? "${WORKSPACE}/../mp-ci-qrcode-back"
+      : "./scripts/previewCode";
+    
+    return template.replace("${WORKSPACE}", this.WORKSPACE || "");
+  }
+
+  async executeUpload(options) {
+    const {
+      appid,
+      projectPath,
+      version,
+      desc = "",
+      user = ""
+    } = options;
+
+    const gitEmail = this.getGitEmail();
+    const jenkinsURL = process.env.BUILD_URL ?? "";
+    const isJenkins = Boolean(jenkinsURL);
+
+    const envConfig = this.ENV_MAP[this.ENV];
+    if (!envConfig) {
+      throw new Error(`不支持的env环境: ${this.ENV}`);
+    }
+
+    const fullVersion = `${version}${envConfig.v}`;
+    const fullDesc = `${envConfig.desc} ${desc} upload by ${
+      gitEmail || user || "Jenkins "
+    } ${jenkinsURL ? `from JenkinsURL: ${jenkinsURL}` : ""}`;
+
+    const project = new ci.Project({
+      appid: appid,
+      type: "miniProgram",
+      projectPath: projectPath,
+      privateKeyPath: this.getPrivateKeyPath(appid),
+      ignores: ["node_modules/**/*"],
+    });
+
+    // 上传小程序
+    console.log("========= 运行上传小程序函数 ==========");
+    const uploadResult = await ci.upload({
+      project,
+      robot: envConfig.robot,
+      version: fullVersion,
+      desc: fullDesc,
+      setting: {
+        useProjectConfig: true,
+      },
+    });
+    console.log("上传小程序结果 uploadResult: ", uploadResult);
+
+    // 生成预览二维码
+    console.log("========= 运行预览并生成二维码函数 ==========");
+    const qrCodePath = `${this.getPreviewCodePath()}/code.jpg`;
+    const previewResult = await ci.preview({
+      project,
+      robot: envConfig.robot,
+      desc: `${fullVersion} ${fullDesc}`,
+      setting: {
+        useProjectConfig: true,
+      },
+      qrcodeFormat: "image",
+      qrcodeOutputDest: qrCodePath,
+    });
+    console.log(`二维码路径：${qrCodePath}`);
+    console.log("预览并生成二维码结果 previewResult: ", previewResult);
+
+    console.log("========= 小程序上传结果 ==========");
+    console.log(`由机器人${envConfig.robot}上传`);
+    console.log(`版本：${fullVersion}`);
+    console.log(`描述：${fullDesc}`);
+    console.log("============  end  ==============");
+
+    return {
+      uploadResult,
+      previewResult,
+      qrCodePath
+    };
+  }
+
+  async promptForMissingOptions() {
+    const questions = [];
+
+    if (!this.options.appid) {
+      questions.push({
+        type: "input",
+        name: "appid",
+        message: "请输入小程序ID",
+        validate: input => input ? true : "小程序ID不能为空"
+      });
+    }
+
+    if (!this.options.projectPath) {
+      questions.push({
+        type: "input",
+        name: "projectPath",
+        message: "请输入小程序项目打包后的代码路径",
+        validate: input => input ? true : "项目路径不能为空"
+      });
+    }
+
+    if (!this.options.version) {
+      questions.push({
+        type: "input",
+        name: "version",
+        message: "请输入版本号",
+        validate: input => input ? true : "版本号不能为空"
+      });
+    }
+
+    if (!this.options.desc) {
+      questions.push({
+        type: "input",
+        name: "desc",
+        message: "请输入版本描述",
+        default: ""
+      });
+    }
+
+    if (questions.length > 0) {
+      const answers = await inquirer.prompt(questions);
+      this.options = { ...this.options, ...answers };
+    }
+
+    return this.options;
+  }
+
+  async run() {
+    try {
+      await this.promptForMissingOptions();
+      
+      if (!this.options.appid || !this.options.projectPath || !this.options.version) {
+        throw new Error("缺少必要参数: appid, projectPath, version");
+      }
+
+      return await this.executeUpload(this.options);
+    } catch (error) {
+      console.error("执行失败:", error.message);
+      process.exit(1);
+    }
+  }
+}
+
+module.exports = function uploadMiniprogram(options = {}) {
+  const uploader = new UploadMiniprogram(options);
+  return uploader.run();
+};
+
+module.exports.UploadMiniprogram = UploadMiniprogram;

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "upload-miniprogram",
+  "version": "0.0.20",
+  "description": "chatlabs 集成 微信小程序CI/CD上传工具，支持自动上传代码和生成预览二维码",
+  "main": "lib/index.js",
+  "bin": {
+    "upload-miniprogram": "bin/upload-miniprogram.js"
+  },
+  "scripts": {
+    "start": "node bin/upload-miniprogram.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "miniprogram",
+    "wechat",
+    "ci",
+    "cd",
+    "upload",
+    "qrcode"
+  ],
+  "author": "cynthia",
+  "license": "MIT",
+  "dependencies": {
+    "miniprogram-ci": "^1.9.0",
+    "inquirer": "^8.2.4",
+    "commander": "^9.4.1"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/chatlabs/upload-miniprogram.git"
+  },
+  "bugs": {
+    "url": "https://github.com/chatlabs/upload-miniprogram/issues"
+  },
+  "homepage": "https://github.com/chatlabs/upload-miniprogram#readme",
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/scripts/prepare-publish.js

@@ -0,0 +1,51 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+console.log('🚀 准备发布 upload-miniprogram npm 包...');
+
+// 检查 package.json
+const packageJsonPath = path.join(__dirname, '..', 'package.json');
+const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+
+console.log('📦 包信息:');
+console.log(`   名称: ${packageJson.name}`);
+console.log(`   版本: ${packageJson.version}`);
+console.log(`   描述: ${packageJson.description}`);
+
+// 检查必要的文件是否存在
+const requiredFiles = [
+  'package.json',
+  'README.md',
+  'CHANGELOG.md',
+  'bin/upload-miniprogram.js',
+  'lib/index.js'
+];
+
+console.log('📁 检查必要文件:');
+requiredFiles.forEach(file => {
+  const filePath = path.join(__dirname, '..', file);
+  if (fs.existsSync(filePath)) {
+    console.log(`   ✅ ${file}`);
+  } else {
+    console.log(`   ❌ ${file} - 文件缺失`);
+    process.exit(1);
+  }
+});
+
+// 检查 .npmignore 配置
+const npmignorePath = path.join(__dirname, '..', '.npmignore');
+if (fs.existsSync(npmignorePath)) {
+  console.log('📋 .npmignore 配置检查: ✅');
+} else {
+  console.log('📋 .npmignore 配置检查: ⚠️ 文件缺失，建议创建');
+}
+
+console.log('\n🎯 发布命令:');
+console.log('   npm publish --access public');
+console.log('\n📚 测试安装命令:');
+console.log('   npm pack');
+console.log('   npm install -g upload-miniprogram-1.0.0.tgz');
+
+console.log('\n✅ 发布准备完成！');

package/upload-miniprogram.js

@@ -0,0 +1,191 @@
+/* eslint-disable import/no-commonjs */
+// https://www.npmjs.com/package/miniprogram-ci
+
+const ci = require("miniprogram-ci");
+const { execSync } = require("child_process");
+const inquirer = require("inquirer");
+
+const WORKSPACE = process.env.WORKSPACE;
+
+let APP_ID = ""; // 小程序ID
+let PROJECT_PATH = ""; // 小程序项目打包后的代码路径
+
+const PRIVATE_KEY_PATH_JENKINS =
+  "${WORKSPACE}/../mp-ci-upload-key/private.${APP_ID}.key".replace(
+    "${WORKSPACE}",
+    WORKSPACE
+  ); // 小程序私钥路径（需要存在Jerkin服务器，不要存在项目文件里）
+const PREVIEW_CODE_PATH_JENKINS = "${WORKSPACE}/../mp-ci-qrcode-back".replace(
+  "${WORKSPACE}",
+  WORKSPACE
+); // 小程序预览Code的路径
+const PRIVATE_KEY_PATH_LOCAL = "./scripts/private.${APP_ID}.key"; // 小程序私钥路径（需要存在Jerkin服务器，不要存在项目文件里，如不需要本地执行，可以忽略该配置）
+const PREVIEW_CODE_PATH_LOCAL = "./scripts/previewCode"; // 本地预览二维码路径（本地运行命令时才会用到，也要配置本地的IP，如不需要本地执行，可以忽略该配置）
+const PREVIEW_CODE_FILE_NAME = "code.jpg"; // 预览二维码文件名 "code-${version}.jpg"
+
+const ENV = process.env.NODE_ENV;
+const ENV_MAP = {
+  development: { v: ".dev", desc: "【Dev环境】", robot: 1 },
+  staging: { v: ".staging", desc: "【Staging环境】", robot: 2 },
+  uat: { v: ".uat", desc: "【Uat环境】", robot: 3 },
+  production: { v: "", desc: "【正式环境】", robot: 5 },
+};
+
+const env_argv = process.argv;
+console.log("argvs", env_argv);
+
+let v_in_argv, d_in_argv, u_in_argv;
+
+env_argv.forEach((item) => {
+  if (item.includes("version")) {
+    v_in_argv = item.split("=")[1];
+  }
+  if (item.includes("desc")) {
+    d_in_argv = item.split("=")[1];
+  }
+  if (item.includes("user")) {
+    u_in_argv = item.split("=")[1];
+  }
+  if (item.includes("appid")) {
+    APP_ID = item.split("=")[1];
+  }
+  if (item.includes("project-path")) {
+    PROJECT_PATH = item.split("=")[1];
+  }
+});
+
+// 获取 Git 邮箱
+function getGitEmail() {
+  try {
+    return execSync("git config --global user.email", {
+      encoding: "utf8",
+    }).trim();
+  } catch (error) {
+    console.error("无法获取 Git 邮箱:", error.message);
+    return null;
+  }
+}
+
+const executeUploadMPCode = async () => {
+  const gitEmail = getGitEmail();
+  const JerkinsURL = process.env.BUILD_URL ?? "";
+  const isJerkin = Boolean(JerkinsURL);
+
+  const version = `${v_in_argv}${ENV_MAP[ENV].v}`;
+  const desc = `${d_in_argv || ""}`;
+  const fullDesc = `${ENV_MAP[ENV].desc} ${desc} upload by ${
+    gitEmail || u_in_argv || "Jenkins "
+  } ${JerkinsURL ? `from JerkinsURL:  ${JerkinsURL}` : ""} `;
+
+  const project = new ci.Project({
+    appid: APP_ID,
+    type: "miniProgram",
+    projectPath: PROJECT_PATH,
+    privateKeyPath: isJerkin
+      ? PRIVATE_KEY_PATH_JENKINS.replace("${APP_ID}", APP_ID)
+      : PRIVATE_KEY_PATH_LOCAL.replace("${APP_ID}", APP_ID),
+    ignores: ["node_modules/**/*"],
+  });
+
+  // 上传小程序
+
+  console.log("========= 运行上传小程序函数 ==========");
+  const uploadResult = await ci.upload({
+    project,
+    robot: ENV_MAP[ENV].robot,
+    version: version,
+    desc: fullDesc,
+    setting: {
+      useProjectConfig: true,
+    },
+    // onProgressUpdate: console.log,
+  });
+  console.log("上传小程序结果 uploadResult: ", uploadResult);
+
+  console.log("========= 运行预览并生成二维码函数 ==========");
+  const qrCodePath = `${
+    isJerkin ? PREVIEW_CODE_PATH_JENKINS : PREVIEW_CODE_PATH_LOCAL
+  }/${PREVIEW_CODE_FILE_NAME.replace("${version}", version)}`;
+  const previewResult = await ci.preview({
+    project,
+    robot: ENV_MAP[ENV].robot,
+    desc: `${version} ${fullDesc}`,
+    setting: {
+      useProjectConfig: true,
+    },
+    qrcodeFormat: "image",
+    qrcodeOutputDest: qrCodePath, // 服务器链接，可以定期清除，这个是必填字段
+    // onProgressUpdate: console.log,
+  });
+  console.log(
+    `二维码路径：${qrCodePath} （可能不生效或无权限，建议直接从小程序助手进入查看）`
+  );
+  console.log("预览并生成二维码结果 previewResult: ", previewResult);
+
+  console.log("========= 小程序上传结果 ==========");
+  console.log(`由机器人${ENV_MAP[ENV].robot}上传`);
+  console.log(`版本：${version}`);
+  console.log(`描述： ${fullDesc}`);
+  console.log("============  end  ==============");
+};
+
+(async () => {
+  if (!ENV_MAP[ENV]) {
+    console.error("env is not supported: ", ENV);
+    return;
+  }
+
+  if (!v_in_argv || !APP_ID || !PROJECT_PATH) {
+    console.error("version is required");
+
+    const questions = [];
+
+    if (!APP_ID) {
+      questions.push({
+        type: "input",
+        name: "appid",
+        message: "请输入小程序ID",
+      });
+    }
+
+    if (!PROJECT_PATH) {
+      questions.push({
+        type: "input",
+        name: "projectPath",
+        message: "请输入小程序项目打包后的代码路径",
+      });
+    }
+
+    if (!v_in_argv) {
+      questions.push({
+        type: "input",
+        name: "version",
+        message: "请输入版本号",
+      });
+    }
+    if (!d_in_argv) {
+      questions.push({
+        type: "input",
+        name: "desc",
+        message: "请输入版本描述",
+      });
+    }
+
+    inquirer.prompt(questions).then(function (answers) {
+      let { version = "", desc = "", appid = "", projectPath = "" } = answers;
+
+      v_in_argv = version;
+      if (desc) d_in_argv = desc;
+      if (appid) APP_ID = appid;
+      if (projectPath) PROJECT_PATH = projectPath;
+      if (version) {
+        executeUploadMPCode();
+      } else {
+        console.log("版本号不能为空");
+      }
+    });
+    return;
+  } else {
+    executeUploadMPCode();
+  }
+})();