fix(修复提交工具): 更改git-cz 配置文件

白唯 · 白唯 · commit 372391f79e17 · 2020-09-04T14:19:13.000+08:00
diff --git a/.czrc b/.czrc
@@ -0,0 +1,58 @@
+{
+  "path": "cz-conventional-changelog",
+  "disableScopeLowerCase": false,
+  "disableSubjectLowerCase": false,
+  "maxHeaderWidth": 100,
+  "maxLineWidth": 100,
+  "defaultType": "",
+  "defaultScope": "",
+  "defaultSubject": "",
+  "defaultBody": "",
+  "defaultIssues": "",
+  "types": {
+    "feat": {
+      "description": "新功能",
+      "title": "新增"
+    },
+    "fix": {
+      "description": "bug 修复",
+      "title": "修复"
+    },
+    "style": {
+      "description": "UI相关",
+      "title": "UI"
+    },
+    "refactor": {
+      "description": "代码重构",
+      "title": "重构"
+    },
+    "docs": {
+      "description": "文档更新",
+      "title": "文档"
+    },
+    "build": {
+      "description": "构建系统或者包依赖更新",
+      "title": "构建系统或者包依赖更新"
+    },
+    "ci": {
+      "description": "CI/CD,自动构建,持续集成相关",
+      "title": "CI/CD"
+    },
+    "test": {
+      "description": "测试用例相关",
+      "title": "测试"
+    },
+    "perf": {
+      "description": "优化",
+      "title": "优化"
+    },
+    "chore": {
+      "description": "非src或者测试文件的更新",
+      "title": "非 src 或者 测试文件的更新"
+    },
+    "revert": {
+      "description": "回到上一个版本",
+      "title": "回溯"
+    }
+  }
+}
diff --git a/.gitignore b/.gitignore
@@ -23,4 +23,5 @@ pnpm-debug.log*
 *.sw?
 
 # local docs
-todo-list.md
+todo-list.md
+*todo-list*.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,13 @@
+## 0.1.2 (2020-09-03)
+
+
+### Features
+
+* **基础代码架构:** 项目基础代码初始化,目前只有vue 全家桶 d4e8514
+* **项目搭建:** 初步完成除了UI 库以外的基础配置 f3da208
+
+
+
 ## 0.1.1 (2020-09-03)
 
 
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "vue3",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "private": true,
   "scripts": {
     "serve": "vue-cli-service serve",
@@ -75,63 +75,6 @@
     "not dead"
   ],
   "config": {
-    "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog",
-      "disableScopeLowerCase": false,
-      "disableSubjectLowerCase": false,
-      "maxHeaderWidth": 100,
-      "maxLineWidth": 100,
-      "defaultType": "",
-      "defaultScope": "",
-      "defaultSubject": "",
-      "defaultBody": "",
-      "defaultIssues": "",
-      "types": {
-        "feat": {
-          "description": "新功能",
-          "title": "新增"
-        },
-        "fix": {
-          "description": "bug 修复",
-          "title": "修复"
-        },
-        "style": {
-          "description": "UI相关",
-          "title": "UI"
-        },
-        "refactor": {
-          "description": "代码重构",
-          "title": "重构"
-        },
-        "docs": {
-          "description": "文档更新",
-          "title": "文档"
-        },
-        "build": {
-          "description": "构建系统或者包依赖更新",
-          "title": "构建系统或者包依赖更新"
-        },
-        "ci": {
-          "description": "CI/CD,自动构建,持续集成相关",
-          "title": "CI/CD"
-        },
-        "test": {
-          "description": "测试用例相关",
-          "title": "测试"
-        },
-        "perf": {
-          "description": "优化",
-          "title": "优化"
-        },
-        "chore": {
-          "description": "非src或者测试文件的更新",
-          "title": "非 src 或者 测试文件的更新"
-        },
-        "revert": {
-          "description": "回到上一个版本",
-          "title": "回溯"
-        }
-      }
-    }
+    "commitizen": {}
   }
 }
diff --git a/src/api/apiList.ts b/src/api/apiList.ts
@@ -2,27 +2,50 @@
 
 import { Method, ResponseType } from 'axios'
 
-interface ApiListItem {
-  [key: string]: Array<{ url: string; method?: Method; resType?: ResponseType }>
+interface ApiListItemType {
+  url: string
+  method: Method
+  resType: ResponseType
 }
+
+/** API 模块名  */
+type ApiModuleKey = 'user' | 'article'
+
+/** 模块名下的属性名  */
+type UserModuleKey = 'login' | 'register' | 'logout'
+type ArticleModuleKey = 'list'
+
+type ApiListItem = {
+  user: { [key in UserModuleKey]: ApiListItemType }
+  article: { [key in ArticleModuleKey]: ApiListItemType }
+}
+
+/** 以对象的方式,对智能提示更好  */
 const ApiList: ApiListItem = {
-  user: [
-    {
+  user: {
+    login: {
       url: '/login',
       method: 'post',
       resType: 'json'
     },
-    {
-      url: '/login',
-      method: 'get',
+    register: {
+      url: '/register',
+      method: 'post',
+      resType: 'json'
+    },
+    logout: {
+      url: '/register',
+      method: 'post',
       resType: 'json'
     }
-  ],
-  other: [
-    {
-      url: 'fd'
+  },
+  article: {
+    list: {
+      url: '/list',
+      method: 'get',
+      resType: 'json'
     }
-  ]
+  }
 }
 
 export default ApiList
diff --git a/src/api/user.ts b/src/api/user.ts
@@ -1,4 +1,8 @@
-import API from './request'
+import API from './axios'
+import ApiList from './apiList'
+
+const { user } = ApiList
+
 interface HttpParams {
   coinName: string
   cashName: string
@@ -13,12 +17,12 @@ export interface UserApi {
  * @todo Get the exchange rate of the current currency
  */
 class User {
-  register() {
-    /*     return API.get<{ data: string | { error: string } }>(`/market/${targetCoin}/${param.cashName.toLowerCase()}`, {
-       params: {
-         t: new Date().getTime()
-       }
-     }).then(({ data }) => data) */
+  async register(): Promise<any> {
+    return await API({
+      method: user.register.method,
+      url: user.register.url,
+      responseType: user.register.resType
+    })
   }
 }
 
diff --git a/todo-list-today.md b/todo-list-today.md
@@ -0,0 +1,80 @@
+# 基于 vue2.x | vue3 的项目基础架构搭建
+
+说明: [x] 已完成 [ ] 未完成
+
+#### 主要用到的库
+
+- vue 全家桶 vue3 + vue-router + vuex + typescript
+- http 请求:axios
+- ui 库:ant-design-vue.
+- 提交规范:git cz commitizen,版本更改历史: changelog
+- 文档工具:typedoc
+- 代码检查:eslint+eslint-typescript,格式化:prettier.
+- 测试用例:mocha,ts-node
+
+#### 代码基础架构说明
+
+- <b>api</b> http 请求相关文件夹
+- <b>assets</b> 静态资源文件,未经压缩的,会走 webpack 压缩流程
+- <b>public</b> 静态资源文件,根目录,不会经过 webpack 压缩打包,存放已经处理好的第三方资源,会原样输出
+- ...
+
+#### 组件编写
+
+- [x] 支持 tsx 方式编写页面,在.tsx 文件或者 class-component 里写 tsx.
+- [x] 支持 class-component 写法.
+- [x] 同时支持(.vue|.tsx.|.ts) 编写页面,defineComponent 以及 class-componnet 都支持智能提示.
+
+#### 样式配置
+
+> 均通过 webpack 实现.
+
+- [x] 自动注入全局样式
+- [x] 配置全局 less 变量
+- [x] 支持自定义 UI 库的主题颜色
+
+#### 网络请求
+
+- [x] 基于 axios 封装脱离具体业务逻辑的网络请求,支持编写脱离浏览器环境的测试用例.(跟业务无关)
+- [ ] 基于具体业务逻辑再次封装网络请求 (跟业务相关,此项需要依据具体后台应用接口编写)
+
+#### 数据状态管理
+
+- [x] 建立应用数据状态管理
+- [x] 编写更加建议读取的方法,并完善 type
+- [x] 支持多个模块,以及自动装载模块
+- [ ] 支持持久化 (vue3 暂不支持)
+
+#### UI 库
+
+- [ ] 添加 ant-design-vue,支持按需加载
+- [ ] 将 UI 库部分功能如 message 添加到根目录
+
+#### 插件与常用工具函数
+
+- [ ] 引用常用工具函数
+
+#### 配置
+
+- [ ] 配置 webpack,分离开发/测试/生产环境配置.
+- [ ] 添加 webpack 常用插件,优化打包配置.
+- [x] 根据环境配置 vue-cli 环境变量(环境相关)
+- [x] 配置应用全局静态常量(业务相关)
+- [x] 完成 tsconfig 相关配置
+- [x] 增加编辑器配置
+
+#### 开发工具
+
+- [x] eslint 代码检查,配置 prettier 格式化工具,使检查规则和格式化规则一致
+- [x] 新增提交规范 git cz commitizen,统一代码提交规范
+- [x] 在提交规范的基础上,增加版本更改历史,自动生成 changelog
+- [ ] 为没有 type 的库和变量添加 shims
+
+#### 文档
+
+- [ ] 使用 TYPEDOC 搭建项目文档应用 (typescript4 暂时有 bug)
+- [x] 配置 http-server 启动文档应用
+
+#### 测试用例
+
+- [ ] 支持编写 js,ts 的测试用例
diff --git a/todo-list.png b/todo-list.png
