npm install
npm run build
# OR 你使用的是 yarn (推荐)
yarn install
yarn build
使用微信开发者工具,导入根目录下的 dist
文件夹即可预览。
项目源码位于 src
目录下,入口文件为 app.js
├── api API 目录
├── app.js 小程序入口文件
├── app.json 小程序配置文件
├── app.scss 小程序全局样式文件
├── assets 静态资源目录
│ ├── images 静态资源/公共图片目录
│ ├── styles 静态资源/公共样式目录
│ └── wxs 静态资源/公共脚本目录
├── components 公共组件目录
├── libs 第三方依赖库
├── packages 分包目录
├── pages 页面目录
│ └── index index 页面目录
│ ├── list-item 与 index 页面强关联的组件目录
│ ├── assets 与 index 页面强关联的静态资源目录
│ ├── index.js index 页面入口文件
│ ├── index.json index 页面配置文件
│ ├── index.wxss index 页面样式文件
│ └── index.wxml index 页面 wxml 文件
├── project.config.json 小程序项目环境配置文件
├── sitemap.json sitemap 文件
└── utils 公共方法库
- 普通文件均为小写字母命名,多单词采用 下划线 连接
- 定义类或构造函数的文件以大写字母开头(如
User
) - 组件文件多单词采用 连字符 连接
参考:Taro JavaScript 书写规范,建议阅读时间:15 min
注意:本项目字符串统一使用双引号,而非推荐中的单引号!
项目采用 prettier 格式化工具,具体配置可查看根目录下的 .prettierrc
文件。
注意:虽然目前没有采用 git-hook 等强制工具,但还是希望大家养成先 format 再 commit 的好习惯
由于目前项目存在老代码尚未更新问题,所以并没有将 Lint 工具加入全局代码的构建过程。需要针对性使用 Lint 工具的同学,可通过 CLI 检测对应的文件。