微信小程序 MobX 构建版使用教程
mobx 项目地址: https://gitcode.com/gh_mirrors/mob/mobx
1. 项目目录结构及介绍
wechat-miniprogram/mobx/
├── docs/
├── packages/
├── scripts/
├── website/
├── .editorconfig
├── .eslintrc.js
├── .gitignore
├── .prettierignore
├── .prettierrc
├── .watchmanconfig
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SECURITY.md
├── jest.base.config.js
├── jest.config.js
├── lerna.json
├── mobx-miniprogram-publish.sh
├── package.json
├── sponsors.md
├── tsconfig.json
├── tsconfig.test.json
└── yarn.lock
目录结构介绍
- docs/: 存放项目的文档文件。
- packages/: 存放项目的各个包文件。
- scripts/: 存放项目的脚本文件。
- website/: 存放项目的网站相关文件。
- .editorconfig: 编辑器配置文件。
- .eslintrc.js: ESLint 配置文件。
- .gitignore: Git 忽略文件配置。
- .prettierignore: Prettier 忽略文件配置。
- .prettierrc: Prettier 配置文件。
- .watchmanconfig: Watchman 配置文件。
- CODE_OF_CONDUCT.md: 行为准则文件。
- CONTRIBUTING.md: 贡献指南文件。
- LICENSE: 项目许可证文件。
- README.md: 项目介绍文件。
- SECURITY.md: 安全指南文件。
- jest.base.config.js: Jest 基础配置文件。
- jest.config.js: Jest 配置文件。
- lerna.json: Lerna 配置文件。
- mobx-miniprogram-publish.sh: MobX 小程序发布脚本。
- package.json: 项目依赖和脚本配置文件。
- sponsors.md: 赞助商介绍文件。
- tsconfig.json: TypeScript 配置文件。
- tsconfig.test.json: TypeScript 测试配置文件。
- yarn.lock: Yarn 锁定文件。
2. 项目启动文件介绍
项目的主要启动文件是 package.json
中的 scripts
部分。以下是一些常用的启动命令:
{
"scripts": {
"start": "node scripts/start.js",
"build": "node scripts/build.js",
"test": "jest"
}
}
启动命令介绍
- start: 启动开发服务器,通常用于开发环境。
- build: 构建项目,生成生产环境的代码。
- test: 运行测试用例。
3. 项目配置文件介绍
3.1 .eslintrc.js
ESLint 配置文件,用于定义代码风格和规则。
module.exports = {
extends: ['eslint:recommended'],
rules: {
// 自定义规则
}
};
3.2 tsconfig.json
TypeScript 配置文件,用于定义 TypeScript 编译选项。
{
"compilerOptions": {
"target": "ES6",
"module": "commonjs",
"strict": true,
"esModuleInterop": true
}
}
3.3 jest.config.js
Jest 配置文件,用于定义测试框架的配置。
module.exports = {
testEnvironment: 'node',
testMatch: ['**/__tests__/**/*.js?(x)', '**/?(*.)+(spec|test).js?(x)']
};
3.4 lerna.json
Lerna 配置文件,用于管理多包项目。
{
"packages": ["packages/*"],
"version": "0.0.0"
}
通过以上配置文件,可以对项目的代码风格、编译选项、测试框架和多包管理进行详细的配置。