Skip to content

痛点&目的&基础准备

痛点

  1. 开发过程中发现团队每个人的习惯不同,具体表现在缩进、顺序、以及变量声明、样式类等方面,因这种问题在 commit 时会产生意料之外的冲突,即使解决冲突,但在无形中增加了风险
  2. 存在部分伙伴开发的时候没有校验提示,不能及时意识到错误并改正
  3. 一些错误代码因为没有拦截,会被提交到远程仓库,污染他人代码
  4. 提交信息写的千奇百怪,不方便查找
  5. 包管理工具随心所欲的使用,造成意料之外的问题
  6. 每个人的 vscode 设置不同,带来的效率问题,比如为什么你的保存就格式化之类的

目的

  1. 解决以上痛点
  2. 完成宣讲、并应用实践落地

最终实现效果展示

  1. 开发时错误/不规范的地方要有明显提示(js、样式文件)
  2. 保存自动格式化代码(格式处理、样式顺序处理、import 引入顺序处理)
  3. 提交前,对提交代码进行规范校验,不符合规范拦截,禁止提交
  4. 提交前,对公共配置文件进行修改提示,是否确认要提交相关文件的改动
  5. 提交时限制 commit-msg,不规范禁止提交
  6. 提供交互式提交命令,方便提交(提交更规范)
  7. 统一 vscode 设置(拓展设置、工作区设置)
  8. 限制包管理工具为 pnpm

基础准备

插件篇

  1. 安装插件 Error Lens
  2. 安装插件
  3. 安装插件
  4. 安装插件
  5. 安装插件 - 检查单词拼写

这是在开发时,编辑器能给你错误提示的前提

项目篇

初始化项目完成后

安装并配置 Eslint

安装并配置 Stylelint

  • [x] 安装完插件、配置到此,达成目的 - 编辑器显著提示 error

安装并配置 Prettier

安装并配置 husky、lint-staged、commitlint、cz-git

pre-commit 钩子拓展脚本

统一 vscode 设置

限制包管理器

总结 & 问题记录

made with ❤️ by ankang