模块开发方案

[TOC]

Tms框架专注于解决大型小程序开发问题， 提供一种通用的模块化开发方案。

何为模块化开发呢。 即通过脚手架或平台， 将统一的项目模版和业务模块动态组装成一个小程序。

开发者无需关心搭建项目，处理模版以及各种配置信息，

只需要专注自己的模块中的逻辑就可以了。

除此之外。Tms框架还提供一系列通用的工具方法供开发人员使用。

模块化开发提供两种标准化的接入方式。多模块仓库和单模块仓库

1. 多模块仓库

多模块仓库即一个代码仓库中存在多个模块。

这种组织方式适用于多个模块采用统一的代码检查，同一部门维护的情况。

组织方式如下：

# 代码仓库
├── module1                        # 模块1
		├── module.config.json     # 模块1配置文件
├── module2                        # 模块2
		├── module.config.json     # 模块2配置文件
├── module3                        # 模块3
		├── module.config.json     # 模块3配置文件
├── .git					             # git信息
├── README.md                      # 文档

模块配置信息module.config.json (opens new window)

2. 单模块仓库

单模块仓库即一个仓库就是一个模块

组织方式如下：

# 代码仓库
├── pages				 # 单模块仓库的页面集合
├── components	         # 组件目录
├── module.config.json	 # 模块配置信息
├── .git				 # git信息
├── README.md            # 文档

模块配置信息module.config.json (opens new window)

3. 模块开发

如果需要对模块进行开发，需要全局安装脚手架工具，

脚手架工具可以帮助你一键生成本地的开发环境。

1. 安装脚手架

   sudo npm i @tmsfe/tmskit -g
   

2. 创建本地开发环境

   tms create <moduleName>
   

3. 根据提示，选择需要开发的模块

4. 等待项目创建完成。 生成的项目目录如下：

   ├── modules           # 模块开发目录， 需要到此目录下面去提交代码
   ├── config            # 环境配置信息
   ├── app.json					# 小程序入口文件
   ├── README.md         # 文档
   

5. 使用开发工具打开目录就可以进行开发啦

6. 提交代码时需要进入到modues目录下对应的模块仓库下面进行代码提交