📚 项目结构

什么是 Monorepo?

mincu 使用 monorepo 进行多个包与代码仓库管理

我们都知道,Git 可以用来管理代码仓库,一开始我们都是一个项目对应一个代码仓库,换言之,一个代码仓库对应一个项目。 但如果我们存在这样一个问题,一个项目的代码需要另一个项目去复用,比如公共的配置文件、工具函数等,那么像刚刚这种一个仓库对应一个项目的模式是否还能保证我们能管理得好他们呢?因为像这种模式会遇到一些问题,比如在开发调试的时候,我们需要手动去 clone 各个项目的代码仓库到本地,然后还要对依赖进行绑定或链接,十分麻烦。 其实类似这样麻烦事情在这种一个仓库对应一个项目情况下还有很多,在此不一一列举。 为了避免出现如上问题,我们使用 Monorepo 方案来组织包与代码仓库,与之相对的则是 Multirepo,即刚刚提到的那种较为传统的一个代码仓库一个包的方案。

MonorepoMulti-repo
包管理方式一个代码仓库多个包一个代码仓库一个包,n 个代码仓库 n 个包
代码复用简单麻烦
维护成本较高
协作成本很高
调试成本较高

好的方案需要好的工具去落地,那么该如何去落地 Monorepo 方案呢?在社区里,我们能找到许多类似的工具。 比如 lerna (opens in a new tab) / bolt (opens in a new tab) / preconstruct (opens in a new tab) 等,mincu 使用 preconstruct 作为 monorepo 方案开发工具

预设包

我们推荐使用直接预设包来进行老项目迁移到 mincu

它们都可以单独地引入到你的项目中使用,你可以根据你的需求引入所需要的依赖。 当你安装以上的预设包名时,依赖的包也会同时被安装。

包名依赖的包
mincu-reactmincu-core, mincu-data, mincu-event, mincu-network, mincu-ui
mincu-vanillamincu-vanilla, mincu-hooks

依赖列表

包名能力
mincu-core核心逻辑部分,包含了常用的用户数据,提供 web 和 native 的双向通信、调用来自 App 的接口等功能。
mincu-data数据部分,基本上来自于 core 里的 appData,不过加了一层初始化默认值处理。
mincu-debug调试部分,包含了 mincud 和 debugModule,以方便在 WebView 中进行远程调试。
mincu-event封装了一些原生操作函数,包括 openUrl, setShareConfig, showShare, login
mincu-hooks封装了一些适用于 react 的 hooks,包括 useAppReady, useNativeState, useSafeArea。
mincu-lib共享库,包含了 constant 及 utils。
mincu-network基于 axios 封装的网络库,主要增加了请求拦截器,刷新 token 等功能。
mincu-ui封装了与原生界面显示有关的调用,包括 Toast, StatusBar Style, Header 标题栏, toScreen 跳转, exit 退出。
create-mincumincu 模板生成 cli,开箱即用。