规范化工具清单

本文最后更新于:6 个月前

介绍前端开发规范化这个领域内常见到的一些工具和名词

规范化工具清单

工具概览

描述 使用方式
ESLint 检查JS语法 + 代码风格化 插件、CLI
eslint-plugin-prettier 使prettier规则优先级更高,避免ESLint和Prettier之间的冲突
eslint-config-prettier 共享配置文件,解决ESLint和Prettier部分不兼容的问题
eslint-plugin-vue Vue的ESLint插件,检查Vue语法
Stylelint CSS代码检查器,规避CSS语法错误,并统一风格 插件、CLI
stylelint-config-prettier 共享配置文件,解决Stylelint和Prettier部分规则冲突的问题
Prettier 纯粹的统一代码风格的工具 插件、CLI
husky 增强git hooks工具,使用该模块,可以用更便捷的方式定义hooks脚本(而不用到.git/hooks/目录下去定义)
lint-staged 作用是将lint命令等自定义脚本的范围限制在git add这部分代码文件中,定位只是辅助工具,需要与husky、各种linters结合使用
commitzen 流程化的message填写工具,帮助统一message结构(从过程中杜绝不规范行为
commitlint 约束commit message内容规范的工具,填写完message后进行检查(出错后才杜绝
EditorConfig 用于定义编码样式的文件.editorconfig,用于覆盖IDE默认配置
如果使用了Prettier,EditorConfig规则会被自动转换为Prettier中的规则来发挥作用

关于 ESLint 和 Prettier 的区别,在 Prettier 的文档中很好地解释了:

Linters中包含两类规则:格式化规则(Formatting rules)、代码质量规则(Code-quality rules)。对于前者,Prettier可以提供很好的辅助;对于后者,Prettier没有提供任何帮助

所以 Prettier 可以视作纯粹的风格化工具


规范化工具清单
http://timegogo.top/2023/06/16/效率/规范化:规范化工具清单/
作者
丘智聪
发布于
2023年6月16日
更新于
2023年9月9日
许可协议