From 441bccb5c90971aaf86ee035cc7dc3f52ec4494c Mon Sep 17 00:00:00 2001 From: saatana <1041367524@qq.com> Date: Wed, 23 Mar 2022 15:15:17 +0800 Subject: [PATCH] doc: readme --- .eslintcache | 1 - .gitignore | 3 +- README.md | 144 ++++++++++++++++++++++++++++++++++++++++++- TODO.md | 5 +- commitlint.config.js | 4 +- src/assets/logo.png | Bin 9176 -> 0 bytes 6 files changed, 149 insertions(+), 8 deletions(-) delete mode 100644 .eslintcache delete mode 100644 src/assets/logo.png diff --git a/.eslintcache b/.eslintcache deleted file mode 100644 index de63735..0000000 --- a/.eslintcache +++ /dev/null @@ -1 +0,0 @@ -[{"F:\\vue\\shop-admin\\src\\main.js":"1","F:\\vue\\shop-admin\\src\\App.vue":"2","F:\\vue\\shop-admin\\src\\icons\\index.js":"3","F:\\vue\\shop-admin\\src\\store\\index.js":"4","F:\\vue\\shop-admin\\src\\router\\index.js":"5","F:\\vue\\shop-admin\\src\\plugins\\index.js":"6","F:\\vue\\shop-admin\\src\\store\\modules\\demo.js":"7","F:\\vue\\shop-admin\\src\\store\\modules\\layout.js":"8","F:\\vue\\shop-admin\\src\\store\\modules\\auth.js":"9","F:\\vue\\shop-admin\\src\\store\\modules\\local.js":"10","F:\\vue\\shop-admin\\src\\store\\modules\\system\\user.js":"11","F:\\vue\\shop-admin\\src\\router\\demo.js":"12","F:\\vue\\shop-admin\\src\\router\\modules\\system.js":"13","F:\\vue\\shop-admin\\src\\configs\\index.js":"14","F:\\vue\\shop-admin\\src\\plugins\\element-plus.js":"15","F:\\vue\\shop-admin\\src\\plugins\\global-api.js":"16","F:\\vue\\shop-admin\\src\\api\\auth.js":"17","F:\\vue\\shop-admin\\src\\api\\system\\user.js":"18","F:\\vue\\shop-admin\\src\\utils\\request.js":"19","F:\\vue\\shop-admin\\src\\layouts\\default.vue":"20","F:\\vue\\shop-admin\\src\\views\\system\\user\\index.vue":"21","F:\\vue\\shop-admin\\src\\layouts\\components\\main.vue":"22","F:\\vue\\shop-admin\\src\\layouts\\components\\aside.vue":"23","F:\\vue\\shop-admin\\src\\layouts\\components\\menu.vue":"24","F:\\vue\\shop-admin\\src\\layouts\\components\\header.vue":"25","F:\\vue\\shop-admin\\src\\layouts\\components\\tabs.vue":"26","F:\\vue\\shop-admin\\src\\layouts\\components\\footer.vue":"27","F:\\vue\\shop-admin\\src\\components\\TableList.vue":"28","F:\\vue\\shop-admin\\src\\components\\extra\\ElInput.vue":"29","F:\\vue\\shop-admin\\src\\components\\extra\\ElDropdown.vue":"30","F:\\vue\\shop-admin\\src\\components\\extra\\ElButton.vue":"31","F:\\vue\\shop-admin\\src\\components\\extra\\ElImage.vue":"32","F:\\vue\\shop-admin\\src\\layouts\\components\\view.vue":"33","F:\\vue\\shop-admin\\src\\components\\extra\\ElIcon.vue":"34","F:\\vue\\shop-admin\\src\\layouts\\components\\logo.vue":"35","F:\\vue\\shop-admin\\src\\layouts\\components\\title.vue":"36","F:\\vue\\shop-admin\\src\\layouts\\components\\menu-item.vue":"37","F:\\vue\\shop-admin\\src\\layouts\\components\\breakcrumb.vue":"38","F:\\vue\\shop-admin\\src\\layouts\\components\\profile.vue":"39","F:\\vue\\shop-admin\\src\\layouts\\components\\operation.vue":"40","F:\\vue\\shop-admin\\src\\components\\extra\\ElDialog.vue":"41","F:\\vue\\shop-admin\\src\\components\\extra\\ElRadioGroup.vue":"42","F:\\vue\\shop-admin\\src\\components\\extra\\ElTable.vue":"43","F:\\vue\\shop-admin\\src\\views\\system\\user\\form.vue":"44","F:\\vue\\shop-admin\\src\\components\\extra\\ElUploadImage.vue":"45"},{"size":296,"mtime":1647912669488,"results":"46","hashOfConfig":"47"},{"size":662,"mtime":1648009242359,"results":"48","hashOfConfig":"47"},{"size":72,"mtime":1647912669459,"results":"49","hashOfConfig":"50"},{"size":1676,"mtime":1647912669493,"results":"51","hashOfConfig":"47"},{"size":5460,"mtime":1647999198730,"results":"52","hashOfConfig":"47"},{"size":267,"mtime":1647912669489,"results":"53","hashOfConfig":"47"},{"size":378,"mtime":1647912669494,"results":"54","hashOfConfig":"47"},{"size":2330,"mtime":1647937447465,"results":"55","hashOfConfig":"47"},{"size":4204,"mtime":1647999150874,"results":"56","hashOfConfig":"47"},{"size":526,"mtime":1647912669495,"results":"57","hashOfConfig":"47"},{"size":2420,"mtime":1648008829876,"results":"58","hashOfConfig":"47"},{"size":957,"mtime":1647937631999,"results":"59","hashOfConfig":"47"},{"size":1949,"mtime":1648004326412,"results":"60","hashOfConfig":"47"},{"size":394,"mtime":1647943242423,"results":"61","hashOfConfig":"47"},{"size":826,"mtime":1647912669489,"results":"62","hashOfConfig":"47"},{"size":458,"mtime":1647936508332,"results":"63","hashOfConfig":"47"},{"size":860,"mtime":1647912669448,"results":"64","hashOfConfig":"47"},{"size":2217,"mtime":1648008527834,"results":"65","hashOfConfig":"47"},{"size":2091,"mtime":1648008377687,"results":"66","hashOfConfig":"47"},{"size":1416,"mtime":1647945572403,"results":"67","hashOfConfig":"47"},{"size":4645,"mtime":1648008936701,"results":"68","hashOfConfig":"50"},{"size":1120,"mtime":1648008492949,"results":"69","hashOfConfig":"47"},{"size":2891,"mtime":1647944953099,"results":"70","hashOfConfig":"47"},{"size":2610,"mtime":1648008492949,"results":"71","hashOfConfig":"47"},{"size":1441,"mtime":1647944973602,"results":"72","hashOfConfig":"47"},{"size":6084,"mtime":1648008492949,"results":"73","hashOfConfig":"47"},{"size":593,"mtime":1648008805484,"results":"74","hashOfConfig":"47"},{"size":21846,"mtime":1647912697030,"results":"75","hashOfConfig":"50"},{"size":1313,"mtime":1648008763695,"results":"76","hashOfConfig":"47"},{"size":1806,"mtime":1647912669455,"results":"77","hashOfConfig":"47"},{"size":561,"mtime":1647912669454,"results":"78","hashOfConfig":"47"},{"size":2368,"mtime":1648009016471,"results":"79","hashOfConfig":"50"},{"size":494,"mtime":1647937512421,"results":"80","hashOfConfig":"47"},{"size":1704,"mtime":1648008492948,"results":"81","hashOfConfig":"47"},{"size":755,"mtime":1648008492948,"results":"82","hashOfConfig":"47"},{"size":1168,"mtime":1648008815841,"results":"83","hashOfConfig":"47"},{"size":2133,"mtime":1647943954155,"results":"84","hashOfConfig":"47"},{"size":945,"mtime":1647912669483,"results":"85","hashOfConfig":"47"},{"size":921,"mtime":1648008954708,"results":"86","hashOfConfig":"47"},{"size":1189,"mtime":1647912669486,"results":"87","hashOfConfig":"47"},{"size":3483,"mtime":1647912669455,"results":"88","hashOfConfig":"50"},{"size":1859,"mtime":1647912669457,"results":"89","hashOfConfig":"47"},{"size":10387,"mtime":1647914304818,"results":"90","hashOfConfig":"50"},{"size":4226,"mtime":1648008492949,"results":"91","hashOfConfig":"47"},{"size":6783,"mtime":1648009137102,"results":"92","hashOfConfig":"47"},{"filePath":"93","messages":"94","suppressedMessages":"95","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"1ultby",{"filePath":"96","messages":"97","suppressedMessages":"98","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"99","messages":"100","suppressedMessages":"101","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"usedDeprecatedRules":"102"},"v8rxji",{"filePath":"103","messages":"104","suppressedMessages":"105","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"106","messages":"107","suppressedMessages":"108","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"109","messages":"110","suppressedMessages":"111","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"112","messages":"113","suppressedMessages":"114","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"115","messages":"116","suppressedMessages":"117","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"118","messages":"119","suppressedMessages":"120","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"121","messages":"122","suppressedMessages":"123","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"124","messages":"125","suppressedMessages":"126","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"127","messages":"128","suppressedMessages":"129","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"130","messages":"131","suppressedMessages":"132","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"133","messages":"134","suppressedMessages":"135","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"136","messages":"137","suppressedMessages":"138","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"139","messages":"140","suppressedMessages":"141","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"142","messages":"143","suppressedMessages":"144","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"145","messages":"146","suppressedMessages":"147","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"148","messages":"149","suppressedMessages":"150","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"151","messages":"152","suppressedMessages":"153","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"154","messages":"155","suppressedMessages":"156","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"usedDeprecatedRules":"157"},{"filePath":"158","messages":"159","suppressedMessages":"160","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"161","messages":"162","suppressedMessages":"163","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"164","messages":"165","suppressedMessages":"166","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"167","messages":"168","suppressedMessages":"169","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"170","messages":"171","suppressedMessages":"172","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"173","messages":"174","suppressedMessages":"175","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"176","messages":"177","suppressedMessages":"178","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"usedDeprecatedRules":"157"},{"filePath":"179","messages":"180","suppressedMessages":"181","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"182","messages":"183","suppressedMessages":"184","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"185","messages":"186","suppressedMessages":"187","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"188","messages":"189","suppressedMessages":"190","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"usedDeprecatedRules":"157"},{"filePath":"191","messages":"192","suppressedMessages":"193","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"194","messages":"195","suppressedMessages":"196","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"197","messages":"198","suppressedMessages":"199","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"200","messages":"201","suppressedMessages":"202","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"203","messages":"204","suppressedMessages":"205","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"206","messages":"207","suppressedMessages":"208","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"209","messages":"210","suppressedMessages":"211","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"212","messages":"213","suppressedMessages":"214","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"215","messages":"216","suppressedMessages":"217","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"usedDeprecatedRules":"157"},{"filePath":"218","messages":"219","suppressedMessages":"220","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"221","messages":"222","suppressedMessages":"223","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"usedDeprecatedRules":"157"},{"filePath":"224","messages":"225","suppressedMessages":"226","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"227","messages":"228","suppressedMessages":"229","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"F:\\vue\\shop-admin\\src\\main.js",[],[],"F:\\vue\\shop-admin\\src\\App.vue",[],[],"F:\\vue\\shop-admin\\src\\icons\\index.js",[],[],[],"F:\\vue\\shop-admin\\src\\store\\index.js",[],[],"F:\\vue\\shop-admin\\src\\router\\index.js",[],[],"F:\\vue\\shop-admin\\src\\plugins\\index.js",[],[],"F:\\vue\\shop-admin\\src\\store\\modules\\demo.js",[],[],"F:\\vue\\shop-admin\\src\\store\\modules\\layout.js",[],[],"F:\\vue\\shop-admin\\src\\store\\modules\\auth.js",[],[],"F:\\vue\\shop-admin\\src\\store\\modules\\local.js",[],[],"F:\\vue\\shop-admin\\src\\store\\modules\\system\\user.js",[],[],"F:\\vue\\shop-admin\\src\\router\\demo.js",[],[],"F:\\vue\\shop-admin\\src\\router\\modules\\system.js",[],[],"F:\\vue\\shop-admin\\src\\configs\\index.js",[],[],"F:\\vue\\shop-admin\\src\\plugins\\element-plus.js",[],[],"F:\\vue\\shop-admin\\src\\plugins\\global-api.js",[],[],"F:\\vue\\shop-admin\\src\\api\\auth.js",[],[],"F:\\vue\\shop-admin\\src\\api\\system\\user.js",[],[],"F:\\vue\\shop-admin\\src\\utils\\request.js",[],[],"F:\\vue\\shop-admin\\src\\layouts\\default.vue",[],[],"F:\\vue\\shop-admin\\src\\views\\system\\user\\index.vue",[],[],[],"F:\\vue\\shop-admin\\src\\layouts\\components\\main.vue",[],[],"F:\\vue\\shop-admin\\src\\layouts\\components\\aside.vue",[],[],"F:\\vue\\shop-admin\\src\\layouts\\components\\menu.vue",[],[],"F:\\vue\\shop-admin\\src\\layouts\\components\\header.vue",[],[],"F:\\vue\\shop-admin\\src\\layouts\\components\\tabs.vue",[],[],"F:\\vue\\shop-admin\\src\\layouts\\components\\footer.vue",[],[],"F:\\vue\\shop-admin\\src\\components\\TableList.vue",[],[],"F:\\vue\\shop-admin\\src\\components\\extra\\ElInput.vue",[],[],"F:\\vue\\shop-admin\\src\\components\\extra\\ElDropdown.vue",[],[],"F:\\vue\\shop-admin\\src\\components\\extra\\ElButton.vue",[],[],"F:\\vue\\shop-admin\\src\\components\\extra\\ElImage.vue",[],[],"F:\\vue\\shop-admin\\src\\layouts\\components\\view.vue",[],[],"F:\\vue\\shop-admin\\src\\components\\extra\\ElIcon.vue",[],[],"F:\\vue\\shop-admin\\src\\layouts\\components\\logo.vue",[],[],"F:\\vue\\shop-admin\\src\\layouts\\components\\title.vue",[],[],"F:\\vue\\shop-admin\\src\\layouts\\components\\menu-item.vue",[],[],"F:\\vue\\shop-admin\\src\\layouts\\components\\breakcrumb.vue",[],[],"F:\\vue\\shop-admin\\src\\layouts\\components\\profile.vue",[],[],"F:\\vue\\shop-admin\\src\\layouts\\components\\operation.vue",[],[],"F:\\vue\\shop-admin\\src\\components\\extra\\ElDialog.vue",[],[],"F:\\vue\\shop-admin\\src\\components\\extra\\ElRadioGroup.vue",[],[],"F:\\vue\\shop-admin\\src\\components\\extra\\ElTable.vue",[],[],"F:\\vue\\shop-admin\\src\\views\\system\\user\\form.vue",[],[],"F:\\vue\\shop-admin\\src\\components\\extra\\ElUploadImage.vue",[],[]] \ No newline at end of file diff --git a/.gitignore b/.gitignore index 5d50172..aedec16 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,4 @@ -.idea -.DS_Store +.elintchache node_modules dist *.local diff --git a/README.md b/README.md index ff1e7e0..fdf3d70 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,143 @@ -# shop-admin +# 马士兵严选管理平台 -马士兵严选后台管理 \ No newline at end of file +## 技术架构 + +- vite + > 新兴主流项目编译构建工具，与 webpack 相比构建速度极快 +- vue3 + > vue 最新版本，声明式 API，组件内各功能点代码耦合性低，易扩展维护 +- vue-router + > SPA 路由系统 +- vuex + > 数据状态管理，规范组件之间数据传递，更好得监测数据状态变化 +- axios + > AJAX 请求封装库，用于调用 API 接口 +- element-plus + > 基础组件库 + +## 插件 + +- jsx + > javascript & react 语法，封装组件时编码更加灵活方便，功能开发时不推荐使用 +- svg-icon + > 根据自定义 svg 文件生成 icon +- auto-import + > 编译时自动引入依赖 +- components + > 编译时自动局部注册 ElementPlus 组件和 src/components 目录下的自定义组件 +- style-import + > 编译时按需引用 ElementPlus 样式文件 +- global-style + > 编译时自动注入全局样式和变量 +- remove-console + > 打包时自动移除 console 语句 +- legacy + > 浏览器兼容处理 +- eslint + > 不影响 HMR 编译速度的情况下异步进行 eslint 代码校验 +- husky + > git hooks 管理 +- lint-staged + > git commit 时仅对提交部分代码进行 eslint 校验 +- commitlint + > git commit 时对提交信息进行规范校验 + +## 规范约束 + +- 使用 VS Code 进行开发，并安装项目推荐的插件 +- 不允许修改 src 目录以外的（项目配置）文件 +- 有需要优化解决的问题记录到 TODO.md 文件中，包括技术方面的踩坑记录和业务方面的 BUG 记录 +- 按照当前项目结构进行功能开发，不允许随意改变项目文件结构 + +## 项目结构 + +| SRC 目录 | 用途描述 | +| ---------- | ---------------------------- | +| api | API 接口定义 | +| assets | 资源文件，按功能模块分文件夹 | +| components | 自定义通用组件 | +| configs | 项目框架配置 | +| icons | 图标库，svg 图标文件 | +| layouts | 页面框架布局 | +| plugins | 全局插件模块 | +| router | 本地路由模块 | +| store | 数据状态模块 | +| styles | 全局样式模块 | +| utils | 工具类库模块 | +| views | SFC 模块，页面文件 | + +## 开发须知 + +### 通用组件 + +- 文件规范命名，使用简单易懂的单词概括组件的功能 +- 写好 Props 参数注释 +- 具有良好的扩展性和通用性 +- 优化、修复问题时考虑向下兼容，尽可能不影响已有代码 +- 使用 setup script 语法糖和 jsx 语法 +- 有数据绑定功能的必须支持 v-mdoel 语法 + +### 路由页面 + +- 严格遵循既定的项目模块结构 +- 单个功能页面之间通用组件应单独在页面目录创建 components 文件夹，而不是全部都放进 src/components +- 必须使用 defineComponent 包裹组件定义，并定义好具有唯一性的 name +- 不允许使用 this，严禁滥用 getCurrentInstance()，proxy 对象只用于访问全局方法 +- 规范使用 ref、reactive、toRefs、unref 等响应式 API，访问响应式数据时应使用 unref 包裹而不是访问 .value +- 各个功能点应区分代码块并写好注释，不允许延续 vue2 编码思想将各个功能点代码耦合在一起，特别复杂逻辑应代码分块并单独创建文件引入使用 +- 不允许以任何形式直接修改 props 传入的值，包括对象中的属性和数组中的元素，如需双向绑定应使用触发事件 update:propsName 的方式 +- 页面根元素应包含 \*-container 的 class，无特殊情况使用单根元素，多根元素会影响动画过渡效果 + +### 工具类库 + +- 项目已集成 lodash、dayjs，不要重复造轮子 +- 全局方法应在 plugins/global-api.js 中注册，而不是写成工具类到处引用 +- 注释中应有完善的功能说明、入参出参说明、注意事项等 +- 新增工具类后应及时通知所有项目开发者知悉 +- 优化修复工具类应向下兼容确保不会影响已有代码，改动较大应召集相关人员商讨解决方案 +- 应进行完善的逻辑测试和性能测试，确保不会影响项目稳定性，谨慎使用 setTimeout、setInterval 等循环\递归操作 + +### 状态管理 + +- 每个功能模块都要对应一个数据状态管理模块 +- 必须通过 mutations 修改 state 中的数据 +- 字典数据应全部存放在 state 中统一管理 +- 接口调用及后续数据逻辑处理应在 actions 中进行，保证多处调用时行为统一 + +### 样式相关 + +- 参考 src/styles/gobalVariables.module.less，颜色、字号、边距、圆角尽可能复用已有的变量 +- 没有特殊需求不允许写全局样式，stlye 标签必须加 scoped +- 深度选择器使用 :deep(<selector>){} 语法，>>> 、/deep/、v-deep:都已弃用 +- 没有特殊需求不允许定义或使用 ID 选择器、属性选择器 + +### 分支管理 + +- 分支命名：父分支-功能描述-创建日期-创建人；例如：beta-userManagement-0323-xwk +- 紧急修复应基于 dev 分支创建，功能分支应基于 beta 分支创建 +- 提测前先将 beta 分支合并到功能分支解决冲突，再将功能分支合并到 test 分支，严禁将 test 分支合并进其他任何分支 +- 测试通过后先将 beta 分支合并到功能分支解决冲突，再通过提 push request 通知负责人进行代码审查，审查通过后由负责人合并代码 +- 预发通过后先将 dev 分支合并到 beta 分支解决冲突，再将 beta 分支合并到 dev 分支，此操作只能由负责人进行 +- 解决冲突时如涉及其他开发者代码，应跟当事人确认无误后再合并 + +### 提交代码 + +- 提交前确认项目能正常运行，改动部分功能正常 +- 严格遵循 eslint、prettier 代码规范 +- 严禁使用 git commit --no-verify -m "xxx" 强制提交代码 +- 规范提交信息 + + | 前缀 | 使用场景 | 示例 | + | -------- | ------------------------------ | -------------------------- | + | feat | 新增功能点、模块 | feat: 用户管理 | + | fix | 修复 BUG | fix: 用户管理分页异常 | + | doc | 文档、注释更新 | doc: README | + | style | 样式、不影响逻辑的代码格式更新 | style: 用户管理标题字号 | + | refactor | 重构功能点、模块 | refactor: 路由模块逻辑重构 | + | test | 测试 | test: 测试工具类 | + | revert | 撤回提交 | revert: 有文件漏提交 | + | build | 编译打包 | build: 编译用户管理 | + | merge | 合并分支 | merge: beta into dev | + | perf | 性能、体验、逻辑优化 | pref: 路由模块解析性能 | + | conf | 配置更新 | conf: 项目 base 路径 | + | chore | 其他 | chore: 其他 | diff --git a/TODO.md b/TODO.md index b724286..fe68954 100644 --- a/TODO.md +++ b/TODO.md @@ -1 +1,4 @@ -- 自定义 SVG 图标颜色显示异常，初始颜色不对，鼠标移入颜色闪烁 +| 问题描述 | 作者 | 记录时间 | 状态 | 解决时间 | +| ------------------------------------------------------------- | ---- | --------- | -------- | -------- | +| 自定义 SVG 图标颜色显示异常，初始颜色不对，鼠标移入颜色闪烁 | xwk | 2022.3.22 | _待解决_ | +| perttier 保存时不会自动格式化属性排序、需要执行命令才能格式化 | xwk | 2022.3.23 | _待解决_ | diff --git a/commitlint.config.js b/commitlint.config.js index 724f695..2d880dc 100644 --- a/commitlint.config.js +++ b/commitlint.config.js @@ -4,8 +4,8 @@ module.exports = { 'type-enum': [ 2, 'always', - // 新增、修复、文档、不影响逻辑的代码格式、重构、测试、回滚、编译、持续集成、优化、配置、其他 - ['feat', 'fix', 'doc', 'style', 'refactor', 'test', 'revert', 'build', 'ci', 'perf', 'conf', 'chore'], + // 新增、修复、文档、不影响逻辑的代码格式、重构、测试、回滚、编译、合并、优化、配置、其他 + ['feat', 'fix', 'doc', 'style', 'refactor', 'test', 'revert', 'build', 'merge', 'perf', 'conf', 'chore'], ], }, }; diff --git a/src/assets/logo.png b/src/assets/logo.png deleted file mode 100644 index 5800f2e73d009742f815065b21332733285ce7c2..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 9176 zcmbVSWm6o!*WHE1-HW?haf-XUJEgcg6koKk#fn>Daf%kFc#A`U#oghDLxEjr(TD$6 zcwQuDGMPy-$(_u-=bQu`EoB@`3QPb1fTOCSp!bTY|7+-|ul=FYZpSMCef5;(0QFN; z#{d8wKvhB3;G@;KC0e$jVb=3hnBtVqenB)SfiQ!KZUy$i$$ahjt)w?1C1+v7b<*$7 zZ%r$I74Sv|#H4~xLZCw+3sNYtOQphMtKO7s?hU&rwjx2CY>-{l7!UQh+R*#&z1v!G z{N#CA2T_{p09Bcxr+9(VXn>YguVXHx)NFX`4$2NXUSjp*utLU^(nEAtZY6EJg31U3?jO)LDv1d>LmP>yO^(P<&+PBpGyQ zOB`>vC`czhvPFpwq+>QfW<`a>#*XdeuGKE>X;}*(@nt1>kXDr}uKxNu@r~TqQs()H z5Z|;G-HCYnqx8R*1zH1oa40aIurh$Viu9k%;jIpL9+nOqLD}DWdaX>BQ`8YU^!Otf zhm8l7Y6J|CMlo1W6N?30W6>G5Cj+O!QaT%50CzLsB!&FJfvj~WWJGQ z?td@p#?S@}K51Snq}P>SCi6Fq0w)27`_4y}A;p2`(Ndwr z9Tos$Qi|=XUXcF6%71bIW)!**et!n6iaeo62Tf>aU=)QE$mO?JDd&(lq_lrXU5W7N zBgK7}BrLyAh_L#PgR><2T_iCQ8#7?YO5t-NVVM$*!9!brD$onP1Q-SuYb8=o7dV98 z(Z*~(Aj6Y4U|W|0V#IfCDus>vK4dDd4~v?Lz|!SVw6v{5oT4~BvaPHttdP$2Mnx~p zrZJ`lT=2=PwvGT2(vpLXJ)+n^I!XZIuGX>Jib!GZ9StfR$7@ljzIcRM6Wi8M|Cc=& zWpC8Oq}EZGG~kejLRI0EyB+*`yi!1u2qS)#jEFPn@HwQICLd#=w^bV7G$EiAU-TpK z#cGn5^cGTqCOUsz{SWZkYf$bd-YUn%b!ZJ{ZK&<_MqgTJS5y61hd`_nxyzBnnO@@ zYyR`1iNK%Q=aXr!=yg0?On|dfi(>>%1iW7`>j()4c#s}MjnN{hu#82;u?VyF=pt9$ zx`P+F2bZGFTCuZ^M&1R|+z+PoH_|2{4q&Agk(a|Bjy+wB*ZD=VI9=ih?y7AHK}1Q4 zl)xH=C2;=p-^cNHasZ5v=u}#AYl}J?;`09I=zcDE%m5drtjq#s^#t?Lt8|z&74Vjp z@Wz}aEz3w^BZja{%Ux7k3WPZFt9m3Z(@6|3zoU+MhWmC<_9FeIS=5`5iofsz%?nA!bBk@=4yTM*IkI`%lHylhF>oK zxtTeCHkOO{Vfc&5v;}tY7C<2Js9(b}UsdeoAVoLh_l2twtzB3xDNiVIze5jjSEuN; z6prgS_`d3xD6x>(HFCzK%Zq?V^W2_R&hudktD8_pH>g6uMzElg2G|*Ri-#}msAPFW zi!0A-j(k@-4Zh*}XE){^?vZ-^E)XA#PQ}rTI7uM(4(G=?si!#z3BdA{yWGSp5JMKK zqJ>q_!yzdIVF&Ij6QxzPu%mq zZwFSE91bnEj%IWlpW zjDcUY7s8H8gM?|Rw~vO+vURz@8kvlVnAky`f#rxN_2^wC(Mq6RpaXI+RPFzylb)^ ztX&w_^)a@aSF1?C_A47SpQ4HrC^L^{wlDAR=K07jT_`LjhreqyY7L+e22)6@b^nA! zPAU+o0>ZkmE+YB>VcT@DAIJr=Va3xH;LVnWkCESqZ=~GK6L=0ZsCm1gF?U+-C23ud zZOLGyi!Sw@`W1i$rbgowKe*fQ+iFV`g(Ov#`Pvbd-|&}BXV!HO_it|A7FQOr1>4;c zjrH@(1UmYcWC=U!1w=Ai=dllur?9m^^0|(8Un5o(hU*SjZCPhs>l`#<1Z+z{I=;Kx z!omBZC6`>ndN;Eqj0yZ9cH}alL0WIejH4e0g05wuN;pT8YtX(`me4nEyM8+Gd+mCZ z&Su2L* zCHRLl-Xs_ZDy9^IvL4o%KC0PMnD?&D5|JnS9rg zU~YR*&H#14`0F-l-msD5Ey@!SZF$78&E`M2sgoG#kNab<{lGbny-Tk4Jgk`eH`F=3Pm76OBC0jN>Z{9IIt?!UOBf>=PiwKhMi02N7rxhi0nbdRkH_Z;dl86&V` z)$HO)iea3Si!JJ{)`pb}h>EvC!hM|lV5({sl|cc)d^fop?4KkwUoT`ZUC)AuV+r6O zjYolPIm&ykIa5U@T*#BjKHYm=bSZQ3>|CVYXt3@NP4q9+^b7H(Bpzmw)WP3v&&x5LaEP5Q~P$C%T1miCF!j>>6b5_#)gCSm}J2sl4>xN=}?sh*vv@;X1hPwBdjN$#uC6bZ29 zvlz@3w$>*yeI>BnNLt>(@nH^X+hod_SI|V5b+}lEywD~Dt0OWf^3eGzjx?E14*r)} zpZK-T3hnOeU9ol{QbzWlBRsaNscHqlRi?!0XDM&o%E;+5rSfr{r zdK-R;A?WPJ#+smkAgWBXZ`&m*rO`Pl4>aHhbKx@(RMC7brg_785&l-JFd3xksgtPH z7DQPR@sVabU_9Xl8R}PLK7+_A7%s|aLY(GuciEa(MLt2}aARD)z7Huaz3P(mvJO+$ zORxi0icDo<(}}-d#8Y4p`x=JrbuaWII!6!}9@l{XwBZZT&wTPAlI>RiVN{R}WRTsF zfGYY{@lY3|B4RrO-xyThUTwwvTteh;_g>X|7nLakuQ2F1&7v)0ElgV+C`9-pwT6=} zE?hHQrSFwlSX0#Q^ZetVkL?*xd~swNx5nM;m*>#dTH^%1)4mOb4*pS4=I}h@v5tLM zl>IzJsUEOUmJ~Mn#;_^tXE8Wh+K$w@NAClcl+w<`ux~#Z$bGm-L$5$LZX=?R(14cGI2q|9%YD$yzVZUwOr0 zcS!!$GeN%_nBJZ;1yD(OFd1I2pMU_nH0GtK^P}`Sq1zSi!vvX0+_B)+f`W=9O_D?c z`EBeoSJY@d`ngN`{YESpR`!5p_xRtUD66+)QA{)cj8?LKOc0Tl2{OYalxkhS(txbm_ z$M-D(=L+&CFL&7uat#((fzNtJd#pb1$~zuCcRgflAZZGIYI|-Z%@O-LV`=uY;3GeY zY^xLAc82>CiTBe|FVFR9m8<~#(kZ*yr%+N@GbOyb)nPg@STXHUTQk^k_Qf{St-jhp z(_Y13SFd|nA%dZS78{{)KLiZ7&qd8 z`^euq4{T$f*CFDOQ}ry6@-vrDHr`g17XHueWz#FdB%hT8S8o;%=MR#)`!{pSYGvaw z0D&?3#P7l8rX$g(aN3fHAe8qmX)hdfQolczwAmnwzQ8+*trQs2&`83)G;R(shQa|Ng^U?0p#U|NquBfyhU$o3O+m!<8)B=#aVs-ZNhEe%-784 zCubRJmm${olzH|rM)f-niYPV?3s&dT{_mc{nnAH%R98}rQSP(j$rCf4Lu2H0UtHH8$_vqXkU{A zwL|=)Z#<>7c@8B`)Wn(|?j^jd$eFSj<(di5G@d8Y`+nWWQY?xzDn(UUU(POa`qSV4 z{IAE;i7WBmSRz{rFlczfi}TD$7@;A~EEp_A1`r^*_YKo2Nv@}!g^pL2$jHEwzg z24~uhTRRXRc)V_@;1|egIm(=x%bptcZEI#t#Yoy1223-}+Cv#vUQYhZ`8dI?GQarN ze+?2)bcH3XPzuqfIXVEJLh>PGiAKKWxcm*0xkDLazCCB8er{-v!%WRxf>mgNJ8FBI z+XW*jDa;sjsJgC;X~AMseG+@q-XkrfSvT!H^vOm1$G`VUSNw99Ra@dx57Z|}N8$T% zgkfY>u=wH%!qBF5I*w^H+<~W?iC0>IPb^td0%OFfHKT-5lIs2l!zs!gD;?|eqxugG zEid5qOO%PSndBAe>e}p&U13tZ`wXW0)2bUiw|kb`~c20QEwFLcvUZ}Zr0o#c@h}i#&z#*8ZvS-sQThYRWy`hH5(~6*g%WtJV>7O_vQ^G-| zOt>v^@0iTta|y3%_#&nH@vrrou|2y#In*aS7Qnz64tZ~tGd$JvSf6u_d)GL!_ znE^Cfa;uO3f^{$fyUJ^5U&`QfpP+0cX^zdgJB(1#NWBkB1|OIF!2E)8?1Qy)24$Kn zV_)FM8(tAFBDVBu)yaW`#&0J2ykxN{(Vtex^!T+H=2otq50G+d31r8#rTlA1y-aH% zzp;2q)>4Rpb_k;SRg61&epd=utG>r6x-nMFDN)$5<~BTc_8zZ&x*};u;tC2jB|g)4 ztTuMzA_x2MHRCdICcz*T5Z&I)dz9R>Vs2XQ__(++v11Aa<>?pRCnaa3_=m~K4`ZnYL`w3Sl%5cZ{k$I& z=dKSt9WQrr-@Z}tE`9AJN8|o?7BilI1T8${Ma|&>ckcq{ZF2BGUh0VAB?`ncagKZA zos{lvWba@3ThrZFW&=1bt{y2CU9G5htyakQumSPBE}6WG?Z+#VqNQ;g?yI(kzg!&7 zT(39=4jp1spz?$?lV#)0ltj^QI6eVH_N`uat zw+)1a_0sq1PGg)gbvFJ5lsZa)8RykS_{TmaAU{w zC@_Hd;n^Y+TSwRh1V6U9uem#7m`yNjLrO;tMRTxldo)w)Qk^3Dnw|i8Th4#0cd3KS zZLSs&Z{SKoGh?W`xpCkM4LlnQmvi9QN?R8)1*H0msae{OWIVB^e6m-$N2CpVRNIGN z`@ax|u@!|}Agzo1HxL%#FJqo0tpmuH^funvQnpuqFn-hs>-y%r0#i7(da7Q0p@ z4Yg-mjzF2lBBwPKAFpqt{Gt7jik9VIzs&VO#ha~&59W`+ebP>M){>WxYX*CegD1NW z%aU0v<#{Lbq%PM_EFwvfn@ws0`K`5&3LSg1bUZ4|Qbb$-z0jDV>eQCFpE9M-{k9^U zyeT$O@aea7sIi^VxOdenA4<#nw~6MpW$wYzTVb3~15Y(;N5RT%X5d<*{x0U)?9*@C zAmOW}Ht~aVkz!F+r!(heYn;FVt`voMxrn zan}R-eh*9-GtKEm{54hOjP?7Z0kO(6U^uQ3bAz&f{q>%obI`~yRb)!9%Tteb&GykY zypMU~4)@|-4ONFL^>3hgWORSEwRII0goV#lIvwEgkb7T6SDf;Keuo#44xuDpA^fM6 z_|#a1oL`$ri84gRnYE5+X1=;_CflAW#0&h1_TL2Oj7S!}#sNBb{DFd((dbc_D`=@c z$?koXl%zU%(8-&MmD<*7M!FCC`)sJ#fi+i^^Uua6#lB51C0tY`+*q|XUL|khi&?y# z-rMA26(+6q377<0Kt2_!j+>^_^TzFTm8ClRlUwQpw*p66lT6Ur&+X%^^LVM3PWma< znv69!EnYS4z-W1~^KD>%JblHianl`~iHj26>AQKuu^nOwLCW9i_beCya6Fv1uLG^T zy%zyzGm1?Z^WSAZ{M<-Wa^t_A#QheOE(mrb&bw;5M{K96iHAbz|1|$n6e~xdpUIDG zH$^9FR@Scu>yRMna6t#(9k;5zFFwDz`b|D-eIj`4nk3`n^9G?e~D#ULCXw!I8!up}P3dcP4_1RqSR|kaF zQUFGy;;)4Bo|+wU{7SneR2!40EJ0MF8OucHnP7eF1_{Xt6EmP@y;aLEw!idXJ<}+l zr96h72}tNessX-kPgj0cN<%MBk3-K`e>@sGWft^yKN==7m2i<2~TyJ_s6DbBISK0 z*;tt6xv;XZq}k^q^@>j3*O&PlHSkacI6W^pmfM%j%RW0v!XG%xD?5+W?FEQVmtqG3 zR0UY`NOQyM+6;Pk&)#+1Wc{@K{`<(Gm?UeQEqEy-n)4nfM23~TIf8=&=`_E3Pk_ggO)<4<}z~PUlHf4bEeXF znXws^S)~v%gzeD^Yokrms#A3M)G|t@m3%WlP%a>^!eh&5Elm0@Vg}}M{L^F2OjNaf z{H0O^N@9K9>D7J_2h#}M1iCPZAtKgcenSk4i#?6dy$A6o$ z$lbqD@ipN^@-#O$+8<%>#t^FNV@DP1h`2bY)Qz;dA&0x(Xvq4~9ILFK0hu?`kx)~) z&s6v{wLSJ;|DwDpX|7w9p-eo!%lGt8DXv-wySr*H{I2rp-$%?tfe^Pz?z4m-*Kj}#4a6!GUrhl)j7*XPC(WuE#o z-$R^lZa;nY%CLb3xc%-heV<8j6;_8PY?7c~OqP6t+krmE_71wBsDw$mICUsIZou5l1R#Q^U-q;)$wh(tB`Uni=B6qxLl?!9F~%g}~(5CV`e?WNQVD zM*u`u(t9no*1K$B13 z`f2Zkp49E}PxU$Sm9#%RuCMt`?SCl(j+(i>C*F1d8NCEKWaN8>U*RNf?8I2uX10Q+ zrb-uTk$f{49V&x4aKHa%7)rI-v^YyRBp2=IFQh?tDZCUEt~x7?nF1=#NTYkW0={yR z|Dea%Zl_2yzj-=vdt4g?{pQLHzQg)8^R~D)Ce&(!P-O&fR;JS{r1T42VLx-S^A`=$ zh|0;8Y>?C2NpqWm{Gb&kOoC&|j(c!Hpk2+c$0cdKB8A~HYoQ) z^vz+?OU3+=^Bh%{-)XU}c)H1QUrKSBkv*O6eP|!v#mi)zLqI&-uymfp$K3;#nbsx8eyO4hY;jB}RVs8wBpY5&tmENMwgwUa+&Qs1Nua^AgCSrXxyF0V}_ z8DD}fJI$z{XB@%7E$4mFE$!kCyUbX5sKkJleE6ooa?XNwM@GXxX3n)=M&80y$&%YC zx+rlsTbPT*vTj%L2Uav_He)ynxAzYZE*!cp!K*n5DV+GlivtL1JEtuJju;-MChMuQXU)Yl^ub7N9#$skz#I4g48!n zuR*tvty;O-#rw(#m*YTtE;Jx7V%p>#>Zm*VTGO1>KpFh#~Jt$>rc$HG}m%*P= z#qySIvGpO&?cUa9m7;3e8;FQ6JJRUw1axdtYitQi^HgPRiro;()H&r!!-+zsV*d3l zYPI^qdLCVXw1cKg1#d*}5ZjCFRSi*+@t;0zBAI#Rlci{fQ@|}nwiG*1{9T#auqGIu zG;^2JTlBksl%(fq)qiEYd}KK@>O@DTnBh$YI-M4SIr2gcmZr19n7-B444pAx%--L1 zp!mbnAA^|`HN*?%^~%-7WVqe$utxg0H~;`S?tfl@hzr9Rj2hkFoCD@2XXkEy5^LcU z69INSOB-S3lH~$r5sy5O6~H`#vMEz}B_(lKpXgLoZ_IneR+cdaQAWb@Q? zZYPn#EQplib8xRH*{h@)*I*Eq=_sykNG0=#ePWr|^<`1*zdhTzSEvDqXl_m}0Bz zFPnej|Bd3E8*y%L7(2O2qs%G8;ctygB9Cezt!l z@Q&VH{(Q14HEt^(ceMEXQ%4Atx{#0qG_Q#}p5U`(pbE%#Fw>QR)P2XbE(`JjsN6nVBAbtov&4sZHn1QrMZx;Pk&p7)Olg?UFHbBE4D|&+rkyG~R*%(hzP& z9gp_v87$Ik7)ONJg1@_5RsBl3hY4HZiw`}RA8$#mi;)>gp7wW^J%)JNe9qXo(E+*7 zZDXhg9B-Nu&(E-8hebp+5DemAPI4>y9G8ZfG&8URKl%_{CLqAH5d9;0>r4S27=dCk zcrx_|=-u)vPp-hwdX`#UB5ZYEwyQ0>32<{h~Y;Y!B{caWf3wi)onLyVGAeh(A|avLy|LdxhwJ8NG;nh z38DXL8oyArcMT^cwR{LbZx0EK{N~Hv$dq~1&xyz#zNGJBj4@;*l z1G}C1@)8t3Y1{n%hky)`xE(z>&FrW#)86)!IEZ*lJO=sIFTf6qVKo*+dbOuqeOW}0 z0jRnD{q&i-oE0jMf!Db&lokNQ7AriPmU