# 使用指南
# 安装脚手架
npm install @tmsfe/tmskit -g --registry=https://registry.npmjs.org/
tmskit -v
1
2
3
2
3
# 创建小程序项目
tmskit create <appName> // (只需创建一次，如果有人已创建项目直接拉去相应代码, 省略create命令)
cd <appName>
1
2
3
2
3
# 创建模块
1. tmskit create <moduleName>
2. 在小程序项目中tms.config.js注册新的模块
module.exports = () => ({
modules: {
all: [
...
{ // 新增你的模块
moduleName: <moduleName>,
path: './modules/main', // 相对于项目的模块路径
},
]
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
# 本地开发
cd <appName>
tmskit run dev -m <module>
1
2
3
2
3
| 参数 | 说明 | 示例 | 备注 |
|---|---|---|---|
| -m | 指定模块名，单模块或多模块开发; 启动多个模块时[,]分割; 不使用tms.private.config.js 配置指定启动特定模块时,默认启动全量模块; | tmskit run dev -m home,index (指定home index 2个模块) | 模块名对应 项目配置 modules的name字段 |
| -e | 环境变量 | tmskit run dev -e test | 环境变量会传给扩展钩子,钩子可以做相关环境变量的处理 |
| -noCache | 不使用缓存启动dev | tmskit run dev --noCache |
- 如何定义一个"模块", 详见模块配置
- 项目要集成哪些模块以及不同项目可以做哪些编译处理，详见项目配置
- 构建工具获取到上面的命令参数后会集成到
cmdOptions对象上传给扩展钩子，钩子可以获取命令参数可以进一步业务操作
# 生产编译
cd <appName>
tmskit run build -m <module>
# 参数详解见上
1
2
3
2
3
# 安装依赖
安装项目根目录及模块里package.json使用依赖，并构建最新的miniprogram_npm
cd <appName>
tmskit run install
1
2
2
# 预览二维码
tmskit run preview
// 参数信息
'-f, --qrcodeFormat': '二维码的格式，选项terminal, image, base64。默认terminal',
'-o, --qrcodeOutputDest ': '二维码会被输出到给定路径',
'-i, --info-output': '相关信息会被输出到给定路径',
1
2
3
4
5
6
2
3
4
5
6
# 小程序上传
tmskit run upload --verion 2022.28.3
// 参数信息
'--version': '上传代码版本，version 指定版本号，必填',
'-d, --desc': '上传代码时的备注',
'-i, --info-output': '相关信息会被输出到给定路径',
'-r, --robot': '指定使用哪一个 ci 机器人，可选值：1 ~ 30',
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
# 云函数
可以将tms.config.js声明的云函数源码拷贝到编译目录 (如果你的云函数源码、编译目录不在一起时可以使用此功能)
cd <appName>
tmskit run cloud-dev
1
2
3
2
3
在tms.config.js>cloudModules>all 字段中声明你的所有云函数
在[tms.config.js>cloudModules>include]((/tmskit-config/config.html#tms-config-js) 字段中你要监听的云函数