TMSKIT

小程序多模块合流编译构建工具

快速上手 →

合流构建

支持多个小程序复用模块代码,不同小程序可以集成不同的模块

单模块开发

全量启动小程序模块时,微信开发者工具的编译速度慢,本构建工具支持单模块开发小程序

增加编译

支持小程序代码增强和代码转义功能

# 快速上手

# 安装
npm install -g @tmsfe/tmskit --registry=https://registry.npmjs.org/

# 使用
tmskit -v

## 创建项目 (只需创建一次,如果有人已创建项目直接拉去相应代码, 省略create命令)
tmskit create <appName>
cd <appName>

## 启动项目
tmskit run dev -m <module> # -m 指定启动的模块,多模块[,]分割 tmskit run dev -m home,aggre4s; 没有指定-m参数时,默认全量启动
微信开发者工具打开<appName>

1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 简述功能

  • 本构建工具致力于将大型小程序项目拆分成多个模块,支持开发者单模块或多模块开发, 解决微信开发者工具编译缓慢,构建预览码时间长,严重影响开发效率问题
# 代码仓库
├── module1                        # 模块1
		├── module.config.json     # 模块1配置文件
├── module2                        # 模块2
		├── module.config.json     # 模块2配置文件
├── module3                        # 模块3
		├── module.config.json     # 模块3配置文件
├── tms.config.js                  # 项目的配置信息(eg:小程序项目集成模块配置)
1
2
3
4
5
6
7
8
  • 本构建工具支持编译能力, 通过编译插件 (opens new window)对源码进行代码转义,输出到编译目录(默认dist);
  • 本构建工具支持跨团队开发小程序,不同团队维护不同模块,支持小程序集成其他仓库的代码,解决小程序拉取第三方仓库的权限问题;
  // tms.config.js集成第三方仓库 > modules > all 
  {
    // 模块名称
    moduleName: "home",
    // 模块支持集成第三方git仓库代码
    repoInfo: {
      httpRepoUrl: "https://git.woa.com/**.git",
      buildGitTag: "master", // 拉取远程仓库的分支
      path: 'package' // 模块源码在远程仓库的某个路径下,可以配置此字段,默认为空
    },
    // 模块源码路径,第三方代码下载路径
    path: "./modules/home/ccmhome",
  }
1
2
3
4
5
6
7
8
9
10
11
12
13

构建工具构建项目包含2个配置文件,构建工具会根据配置文件将模块构建小程序。模块的描述文件-module.config.json,在模块的根目录存放此文件,描述了模块包含分包信息等;项目描述文件-tms.config.js, 该文件描述了一个项目包含哪些模块等信息。

# 功能实现