前端规范指南,让团队代码如出一辙!ESLint + Prettier + husky + lint-staged

大家好,我是王天,这篇文章从两个方向出发:1、git提交规范;2、代码风格统一


假如团队中的小伙伴在提交代码时没有遵循规范要求,例如只写了一个"修改"或"更新,这会给团队中其他小伙伴造成困扰呢,不得不花时间查看代码和推测逻辑。


不仅会浪费了时间和精力,可能会导致以下问题:


  1. 可读性差
  2. 维护困难
  3. 变更历史不透明
  4. 自动化工具的不兼容


如何统一代码风格,规范提交呢呢? 推荐使用 ESLint + Prettier + husky + lint-staged


1、eslint 代码检测工具,检测并提示错误或警告信息

2、 husky Git hooks 工具, 可以在执行 git 命令时,执行自定义的脚本程序

3 、 lint-staged 对暂存区 (git add) 文件执行脚本 检测 校验

4、 prettier 代码自动化格式化工具,更好的代码风格效果

5、 Commitizen 生成符合规范化提交信息的工具

6、commitlint 定义提交规则, 并检测内容是否符合定义的规范!

文中包含大量的代码片段,为了更好的阅读体验,建议大家移步 语雀文档 https://www.yuque.com/itwangtian/ycsiao/pe1n3uneypxse0fq?singleDoc

0个评论
点击登录,快来和大家讨论吧~
表情
图片
暂无评论
管一诺
下载 APP