1.3.2 • Published 2 months ago

miniprogram-helper-cli v1.3.2

Weekly downloads
1
License
MIT
Repository
-
Last release
2 months ago

微信小程序CI助手工具

version downloads NPM

微信小程序CI自动化命令行助手工具,无需扫码登录,一键上传发布,方便快捷,解放双手,告别打包侠!

支持微信小程序/游戏代码上传和预览等功能。可以和JenkinsGitHub ActionsGitlab Ci结合使用,实现持续集成自动化发布。

特性

  • 无需扫码登录,秘钥验证
  • 自动读取项目project.config.json中appid、setting等配置信息

功能

  • 上传代码,对应小程序开发者工具的上传
  • 预览代码,对应小程序开发者工具的预览
  • 构建 npm,对应小程序开发者工具的: 菜单-工具-构建npm
  • 上传云开发云函数代码,对应小程序开发者工具的上传云函数能力
  • 代理,配置网络请求代理方式
  • 支持获取最近上传版本的 sourceMap

安装

// 全局安装
$ npm install miniprogram-helper-cli -g

// 本地安装
$ npm install miniprogram-helper-cli --save-dev

使用

Commands:
  upload  [options] [workspace]  上传代码
  preview [options] [workspace]  预览代码
默认值说明
option同下项目配置
workspace默认命令执行当前目录项目目录

上传Upload

// 本地方式
$ Usage:   miniprogram-cli upload [options] [workspace]
$ Example: miniprogram-cli upload ./dist --ver "1.*.*" --desc "描述" --robot 5

// npx方式
$ Usage:   npx miniprogram-helper-cli upload [options] [workspace]
$ Example: npx miniprogram-helper-cli upload ./dist --ver "1.*.*" --desc "描述" --robot 6 

上传代码:

Options:
  --env [value]     环境
  --appid [value]   小程序appid
  --type [value]    类型
  --ver [value]     版本号
  --desc [value]    简介
  --pkp [value]     私钥文件所在路径
  --robot [value]   指定CI机器人
类型默认值说明
env属性dev小程序环境配置 devstgprod
appid属性project.config.json中appid小程序appid
type属性miniProgram项目的类型,有效值 miniProgram/miniProgramPlugin/miniGame/miniGamePlugin
ver属性0.0.0项目版本号
pkp属性private.${项目appId}.key私钥路径
robot属性1指定使用哪一个 ci 机器人,可选值:1 ~ 30

默认值显示规则优先级:

version版本号规则优先级:

  1. 获取传入的版本号参数: --ver
  2. 获取项目目录下的 package.json 文件中version值

desc备注规则优先级:

  1. 获取传入的简介参数: --desc
  2. 组合: env: ${env} ${desc || 获取项目(git)最新commitmessage+ hash}显示
  3. 显示:暂无简介

pkp私钥优先级:

  1. 读取传入的私钥路径参数: pkp 路径
  2. 读取项目下private.${项目appId}.key文件

npx --no-install cross-env appId="wx733dda9d282a7da0" workspace="/e/web/mini-programs-resident" miniprogram-cli-init

初始默认文件

此处依赖cross-env插件

// 本地方式
$ Usage: cross-env [options] miniprogram-cli-init
$ Example: cross-env appId="123456" workspace="/e/web/wx-project" miniprogram-cli-init

// npx方式
$ Usage: npx cross-env [options] miniprogram-cli-init
$ Example: npx cross-env appId="123456" workspace="/e/web/wx-project" miniprogram-cli-init

Options:
  appId = ""      小程序appId,必填项
  workspace = ""  工作目录,默认当前目录

注意事项

使用前需要使用小程序管理员身份访问"微信公众平台-开发-开发设置"后下载代码上传密钥,并配置 IP 白名单,才能进行上传、预览操作。