@tarojs/plugin-mini-ci 3.3.7

package/README.md

@@ -0,0 +1,232 @@
+# `@taro/plugin-mini-ci`
+
+> Taro 小程序端构建后支持CI（持续集成）的插件， 支持构建完毕后自动打开小程序开发这个工具、上传作为体验版、生成预览二维码. 目前暂时仅支持微信、字节、支付宝、百度小程序
+
+## 使用
+
+### 安装
+```
+npm i @taro/plugin-mini-ci -D
+```
+
+### 使用插件
+`/config/index.js`
+
+```js
+// 示例, 如果你使用 `vs code` 作为开发工具， 你还可以使用注释的语法引入插件包含的声明文件，可获得类似于typescript的友好提示
+/**
+ * @typedef { import("@tarojs/plugin-mini-ci").CIOptions } CIOptions
+ * @type {CIOptions}
+ */
+const CIPluginOpt = {
+    weapp: {
+        appid: "微信小程戏appid",
+        privateKeyPath: "密钥文件相对项目根目录的相对路径，例如 key/private.appid.key"
+    },
+    tt: {
+        email: "字节小程序邮箱",
+        password: "字节小程序密码"
+    },
+    alipay: {
+      appId: "支付宝小程序appId",
+      toolId: "工具id",
+      privateKeyPath: "密钥文件相对项目根目录的相对路径，例如 key/pkcs8-private-pem"
+    },
+    swan: {
+      token: "鉴权需要的token令牌"
+    },
+    // 版本号
+    version: "1.0.0",
+    // 版本发布描述
+    desc: "版本描述"
+}
+const config = {
+  plugins: [
+    [ "@tarojs/plugin-mini-ci", CIPluginOpt ]
+  ]
+}
+```
+
+### 配置命令
+
+`package.json` 的 `scripts` 字段使用命令参数
+
+```json
+{
+    "scripts": {
+            //  构建完后自动 “打开开发者工具”
+           "build:weapp": "taro build --type weapp --open",
+            //  构建完后自动“上传代码作为体验版”
+           "build:weapp:upload": "taro build --type weapp --upload",
+            //  构建完后自动 “上传代码作为开发版并生成预览二维码”     
+           "build:weapp:preview": "taro build --type weapp --preview"
+    },
+    "taroConfig": {
+        "version": "1.0.0",
+        "desc": "上传描述"
+    }
+}
+```
+由上面的示例可知，插件为taro cli命令扩展了3个选项：
+
+- --open
+打开开发者工具，类似于网页开发中自动打开谷歌浏览器
+- --upload
+上传代码作为体验版
+- --preview
+上传代码作为开发版并生成预览二维码
+
+此3个选项在一条命令里不能同时使用
+
+## API
+
+
+### 插件配置
+
+| 参数 | 类型 | 说明 |
+| :--- | :--- | :--- |
+| weapp | Object | 微信小程序CI配置 |
+| tt | Object | 头条小程序配置 |
+| alipay | Object | 支付宝小程序配置 |
+| swan | Object | 百度小程序配置 |
+| version | string | 上传版本号，不传时默认读取package.json下的taroConfig下的version字段 |
+| desc | string | 上传时的描述信息，不传时默认读取package.json下的taroConfig下的desc字段 |
+
+### 微信小程序CI配置
+| 参数 | 类型 | 说明 |
+| :--- | :--- | :--- |
+| appid | string | 小程序/小游戏项目的 appid |
+| privateKeyPath | string | 私钥文件在项目中的相对路径，在获取项目属性和上传时用于鉴权使用|
+| devToolsInstallPath | string | 微信开发者工具安装路径，如果你安装微信开发者工具时选的默认路径，则不需要传入此参数 |
+| projectPath | string | 上传的小程序的路径（默认取的 outputPath ） |
+| ignores | string[] | 上传需要排除的目录(选填) |
+
+官方CI文档[点这里](https://developers.weixin.qq.com/miniprogram/dev/devtools/ci.html)
+
+### 头条小程序CI配置
+
+| 参数 | 类型 | 说明 |
+| :--- | :--- | :--- |
+| email | string | 字节小程序邮箱 |
+| password | string | 字节小程序密码 |
+
+官方CI文档[点这里](https://microapp.bytedance.com/docs/zh-CN/mini-app/develop/developer-instrument/development-assistance/ide-order-instrument)
+
+### 支付宝小程序CI配置
+
+| 参数 | 类型 | 说明 |
+| :--- | :--- | :--- |
+| appId | string | 小程序appId |
+| toolId | string | 工具id，生成方式[查看这里](https://opendocs.alipay.com/mini/miniu/api#%E5%88%9D%E5%A7%8B%E5%8C%96%E9%85%8D%E7%BD%AE%EF%BC%88%E4%B9%8B%E5%89%8D%E7%9A%84%E6%96%B9%E5%BC%8F%EF%BC%8C%E6%8E%A8%E8%8D%90%E4%BD%BF%E7%94%A8%20miniu%20login%EF%BC%89) |
+| privateKeyPath | string | 密钥文件相对项目根目录的相对路径, 支付宝生产的私钥文件名一般是 pkcs8-private-pem |
+| clientType | string | 上传的终端,终端类型见下表（默认值alipay） |
+
+```
+终端类型值及其含义：
+
+alipay: 支付宝
+
+ampe：AMPE
+
+amap：高德
+
+genie：天猫精灵
+
+alios：ALIOS
+
+uc：UC
+
+quark：夸克
+
+taobao：淘宝
+
+koubei：口碑
+
+alipayiot：IoT
+
+cainiao：菜鸟
+
+alihealth：阿里健康
+```
+
+官方CI文档[点这里](https://opendocs.alipay.com/mini/miniu/api)
+
+### 百度小程序CI配置
+
+| 参数 | 类型 | 说明 |
+| :--- | :--- | :--- |
+| token | string | 有该小程序发布权限的登录密钥 |
+| minSwanVersion | string | 最低基础库版本, 不传默认为 3.350.6  |
+
+官方CI文档[点这里](https://smartprogram.baidu.com/docs/develop/devtools/commandtool/)
+
+### ts 接口描述
+```ts
+export interface IOptions {
+  version?: string;
+  desc?: string;
+  weapp?: WeappConfig;
+  tt?: TTConfig;
+  alipay?: AlipayConfig;
+  swan?: SwanConfig;
+}
+
+/** 微信小程序配置 */
+export interface WeappConfig {
+  /** 小程序/小游戏项目的 appid */
+  appid: string;
+  /** 私钥，在获取项目属性和上传时用于鉴权使用(必填) */
+  privateKeyPath: string;
+  /** 微信开发者工具安装路径 */
+  devToolsInstallPath?: string;
+  /** 上传的小程序的路径（默认 outputPath ） */
+  projectPath?: string;
+  /** 类型，默认miniProgram 小程序 */
+  type?: ProjectType;
+  /** 上传需要排除的目录 */
+  ignores?: Array<string>;
+}
+
+/** 头条小程序配置 */
+export interface TTConfig {
+  email: string;
+  password: string;
+}
+
+/** 终端类型 */
+export type ClientType =
+/** 支付宝 */'alipay' |
+/** AMPE */'ampe' |
+/** 高德 */'amap' |
+/** 天猫精灵 */'genie'|
+/** ALIOS */ 'alios'|
+/** UC */'uc'|
+/** 夸克 */ 'quark'|
+/** 淘宝 */ 'taobao'|
+/** 口碑 */'koubei' |
+/** loT */'alipayiot'|
+/** 菜鸟 */'cainiao' |
+/** 阿里健康 */ 'alihealth'
+
+/** 支付宝系列小程序配置 */
+export interface AlipayConfig {
+  /** 小程序appId */
+  appId: string;
+  /** 工具id */
+  toolId: string;
+  /** 工具私钥 */
+  privateKey: string;
+  /** 服务代理地址（可选） */
+  proxy?: string;
+  /** 上传的终端, 默认alipay */
+  clientType?: ClientType;
+}
+
+/** 百度小程序配置 */
+export interface SwanConfig {
+  /** 有该小程序发布权限的登录密钥 */
+  token: string;
+  /** 最低基础库版本, 不传默认为 3.350.6 */
+  minSwanVersion?: string;
+}
+```

package/index.js

@@ -0,0 +1,2 @@
+module.exports = require('./dist/index.js').default
+module.exports.default = module.exports

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@tarojs/plugin-mini-ci",
+  "version": "3.3.7",
+  "description": "Taro 小程序端构建后支持CI（持续集成）的插件",
+  "keywords": [
+    "Taro",
+    "CI/CD"
+  ],
+  "author": "bigMeow <running@vip.163.com>",
+  "homepage": "https://github.com/NervJS/taro#readme",
+  "license": "MIT",
+  "main": "index.js",
+  "typings": "types/index.d.ts",
+  "files": [
+    "dist",
+    "index.js",
+    "types"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/NervJS/taro.git"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w"
+  },
+  "bugs": {
+    "url": "https://github.com/NervJS/taro/issues"
+  },
+  "dependencies": {
+    "minimist": "^1.2.5",
+    "miniprogram-ci": "^1.6.1",
+    "miniu": "^1.20.1",
+    "qrcode-terminal": "^0.12.0",
+    "shelljs": "^0.8.4",
+    "swan-toolkit": "^3.5.58",
+    "tt-ide-cli": "^0.0.24"
+  },
+  "devDependencies": {
+    "@tarojs/service": "^3.3.7"
+  }
+}

package/types/AlipayCI.d.ts

@@ -0,0 +1,8 @@
+import BaseCI from './BaseCi';
+/** 文档地址： https://opendocs.alipay.com/mini/miniu/api */
+export default class AlipayCI extends BaseCI {
+    protected _init(): void;
+    open(): void;
+    upload(): Promise<void>;
+    preview(): Promise<void>;
+}

package/types/BaseCi.d.ts

@@ -0,0 +1,91 @@
+import { IPluginContext } from '@tarojs/service';
+export declare type ProjectType = 'miniProgram' | 'miniGame' | 'miniProgramPlugin' | 'miniGamePlugin';
+/** 微信小程序配置 */
+export interface WeappConfig {
+    /** 小程序/小游戏项目的 appid */
+    appid: string;
+    /** 私钥，在获取项目属性和上传时用于鉴权使用(必填) */
+    privateKeyPath: string;
+    /** 微信开发者工具安装路径 */
+    devToolsInstallPath?: string;
+    /** 上传的小程序的路径（默认 outputPath ） */
+    projectPath?: string;
+    /** 类型，默认miniProgram 小程序 */
+    type?: ProjectType;
+    /** 上传需要排除的目录 */
+    ignores?: Array<string>;
+}
+/** 头条小程序配置 */
+export interface TTConfig {
+    /** 绑定的邮箱账号 */
+    email: string;
+    /** 密码 */
+    password: string;
+}
+/** 终端类型 */
+export declare type ClientType = 
+/** 支付宝 */ 'alipay' | 
+/** AMPE */ 'ampe' | 
+/** 高德 */ 'amap' | 
+/** 天猫精灵 */ 'genie' | 
+/** ALIOS */ 'alios' | 
+/** UC */ 'uc' | 
+/** 夸克 */ 'quark' | 
+/** 淘宝 */ 'taobao' | 
+/** 口碑 */ 'koubei' | 
+/** loT */ 'alipayiot' | 
+/** 菜鸟 */ 'cainiao' | 
+/** 阿里健康 */ 'alihealth';
+/** 支付宝系列小程序配置 */
+export interface AlipayConfig {
+    /** 小程序appId */
+    appId: string;
+    /** 工具id */
+    toolId: string;
+    /** 私钥相对路径 */
+    privateKeyPath: string;
+    /** 服务代理地址（可选） */
+    proxy?: string;
+    /** 上传的终端, 默认alipay */
+    clientType?: ClientType;
+}
+/** 百度小程序配置 */
+export interface SwanConfig {
+    /** 有该小程序发布权限的登录密钥 */
+    token: string;
+    /** 最低基础库版本, 不传默认为 3.350.6 */
+    minSwanVersion?: string;
+}
+export interface CIOptions {
+    /** 发布版本号，默认取 package.json 文件的 taroConfig.version 字段 */
+    version: string;
+    /** 版本发布描述， 默认取 package.json 文件的 taroConfig.desc 字段 */
+    desc: string;
+    /** 微信小程序CI配置, 官方文档地址：https://developers.weixin.qq.com/miniprogram/dev/devtools/ci.html */
+    weapp?: WeappConfig;
+    /** 头条小程序配置, 官方文档地址：https://microapp.bytedance.com/docs/zh-CN/mini-app/develop/developer-instrument/development-assistance/ide-order-instrument */
+    tt?: TTConfig;
+    /** 支付宝系列小程序配置，官方文档地址： https://opendocs.alipay.com/mini/miniu/api */
+    alipay?: AlipayConfig;
+    /** 百度小程序配置, 官方文档地址：https://smartprogram.baidu.com/docs/develop/devtools/commandtool/ */
+    swan?: SwanConfig;
+}
+export default abstract class BaseCI {
+    /** taro 插件上下文 */
+    protected ctx: IPluginContext;
+    /** 传入的插件选项 */
+    protected pluginOpts: CIOptions;
+    /** 当前要发布的版本号 */
+    protected version: string;
+    /** 当前发布内容的描述 */
+    protected desc: string;
+    constructor(ctx: IPluginContext, pluginOpts: CIOptions);
+    /** 初始化函数，会被构造函数调用 */
+    protected abstract _init(): void;
+    /** 打开小程序项目 */
+    abstract open(): any;
+    /** 上传小程序 */
+    abstract upload(): any;
+    /** 预览小程序 */
+    abstract preview(): any;
+}

package/types/QRCode.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 生产二维码输出到控制台
+ * @param url 链接地址
+ */
+export default function generateQrCode(url: string): void;

package/types/SwanCI.d.ts

@@ -0,0 +1,8 @@
+import BaseCI from './BaseCi';
+export default class SwanCI extends BaseCI {
+    private swanBin;
+    protected _init(): void;
+    open(): void;
+    upload(): Promise<void>;
+    preview(): Promise<void>;
+}

package/types/TTCI.d.ts

@@ -0,0 +1,8 @@
+import BaseCI from './BaseCi';
+export default class TTCI extends BaseCI {
+    _init(): Promise<void>;
+    _beforeCheck(): Promise<any>;
+    open(): void;
+    preview(): Promise<void>;
+    upload(): Promise<void>;
+}

package/types/WeappCI.d.ts

@@ -0,0 +1,10 @@
+import BaseCI from './BaseCi';
+export default class WeappCI extends BaseCI {
+    private instance;
+    /** 微信开发者安装路径 */
+    private devToolsInstallPath;
+    _init(): void;
+    open(): Promise<void>;
+    preview(): Promise<void>;
+    upload(): Promise<void>;
+}

package/types/index.d.ts

@@ -0,0 +1,5 @@
+import { IPluginContext } from '@tarojs/service';
+import { CIOptions } from './BaseCi';
+export { CIOptions } from './BaseCi';
+declare const _default: (ctx: IPluginContext, pluginOpts: CIOptions) => void;
+export default _default;