熟练掌握相关代码规范,产出《编码规范文档》

  1. 前端代码规范
  2. 后端代码规范
  3. git flow规范
    1. commit 规范
    2. Git Flow 规范
  4. 代码规范,针对单个文件的书写格式
    1. 变量命名规范
    2. 组件命名规范
  5. 项目结构规范,针对项目文件,以怎样的标准进行命名和管理

前端代码规范

https://www.yuque.com/gkiq5r/ch0byb/xwff1p

  1. eslint规范js, ts代码风格,解决多人协作,风格各异的编码风格,维护和扩展困难
    1. 代码质量
    2. 代码风格
  2. Prettier规范
  3. eslint + Prettier一起使用会有冲突,用 eslint-config-prettier 解决
    1. 禁用所有的和 Prettier冲突的 eslint代码格式规则
    2. 将所有的 Prettier的规则和修改导入 Eslint中

vscode配置

通过安装 eslint,Prettier, Vscode配置实现本地代码规范,
通过保存时,编辑器自动 format on save规范代码

后端代码规范

git flow 提交规范

  1. git hooks
  2. pre-commit 检测提交时代码规范
  3. lint-staged 自动修复格式错误

husky 检测 git hooks钩子

通过插件完成配置

  1. 约定式提交规范
  2. commitizen git提交规范化工具
  3. commitlint 检查提交信息
  4. pre-commit git hooks钩子
  5. lint-staged检查本次更新的代码,自动修复错误,并推送

好的项目规范

http://www.manyanu.com/new/82392ecdf0de412d9eb9f319d724cd1c

一团乱麻的电线

如果你不想做好项目规范,那请看下下面的电线
image.png
image.pngimage.png

规范的项目

image.png
image.png
image.png