项目说明
NPM 任务
| 任务 | 命令 |
|---|---|
| 本地启动 Demo | yarn dev |
| 构建 Demo | yarn demo:build |
| 本地启动文档 | yarn docs:dev |
| 构建文档 | yarn docs:build |
| 构建库 | yarn build |
| 生成更新日志 | yarn changelog |
| 代码风格检查并修复 | yarn lint |
项目结构
fdd-contract
├─ demo (Demo 实例)
│ ├─ assets (资源)
│ │ ├─ css (样式)
│ │ └─ img (图片)
│ ├─ components (组件)
│ ├─ dist (Demo 打包输出目录)
│ ├─ utils (工具函数)
│ ├─ views (视图组件)
│ ├─ App.vue (页面入口)
│ ├─ index.html (HTML 入口)
│ ├─ main.ts (入口文件)
│ ├─ router.ts (路由配置)
│ ├─ shims-vue.d.ts
│ └─ vite.config.ts (Vite 配置)
├─ dist (库打包输出目录)
├─ docs (文档)
│ ├─ .vuepress (VuePress)
│ │ ├─ dist (文档打包输出目录)
│ │ └─ config.ts (VuePress 配置)
│ ├─ api (API 参考)
│ ├─ component (组件)
│ ├─ guide (指南)
│ │ └─ changelog.md (更新日志)
│ ├─ package.json (文档项目包信息，单独构建)
│ └─ README.md (文档首页)
├─ src (库目录)
│ ├─ components (组件)
│ ├─ css (样式)
│ ├─ font (字体)
│ ├─ models (数据模型)
│ ├─ types (TypeScript 类型)
│ ├─ utils (工具函数)
│ ├─ widgets (控件)
│ ├─ config.ts (组件全局配置)
│ └─ index.ts (库入口)
├─ scripts (脚本)
│ └─ verifyCommit.js (Git 提交消息校验)
├─ .browserslistrc (浏览器兼容)
├─ .eslintrc.js (eslint 代码检测配置)
├─ .prettierrc.js (prettier 代码风格配置)
├─ .stylelintrc.js (stylelint 样式检测配置)
├─ package.json (项目包信息)
├─ README.md (项目说明文档)
├─ tsconfig.json (TypeScript 语言服务功能选项)
├─ vite.config.ts (Vite 打包配置)
└─ yarn.lock (yarn 依赖包锁定，依赖更新后需要提交新生成的)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
开发规范
组件命名规范
FaComponentName组件 class-name 规范
fa-component-name
开发工具
编辑器
Visual Studio Codeopen in new window
插件
Visual Studio Code
- Volar: Vue 3 官方支持
- Sass: Scss 支持
- prettier: 代码格式化
- ESlint: 代码检查
- Stylelint: 样式检查
- Gitlens: Git 增强，查看每行代码历史
- Git Graph: Git 分支历史图形查看
- Code Spell Checker: 拼写检查
- Commit Message Editor: Git 规范提交