最近在做团队内部代码规范的事情,有一些经验与大家分享一下。在阅读本文期间,如果你觉得某些地方考虑不妥,或者有更好的方案,欢迎留言告诉我,非常感谢。
文库前端发展10余年,经历的技术栈换了一波又一波,你应该能够想到前端代码的历史包袱有多重。由于前端模块有 30+ 个,各个模块使用的 ESLint 配置并不统一,有些模块使用的都不是 ESLint,导致各个模块的代码规范并不一致。
先说结论,经过一系列处理后可做到:
1、团队内部所有的模块采用统一的代码规范;
2、规范配置集成到脚手架工具中,创建项目后自动采用统一的 ESLinit 配置;
3、配合 ESLint VSCode 插件,实时发现问题,保存代码自动解决代码规范问题;
4、与代码托管平台使用的规范一致,开发时即可发现问题;
如何做到?ESLint 是什么?
ESLint 是一个静态分析工具,可以帮助你发现并解决 JavaScript 代码中的问题。也就是说它既能发现代码中的规范问题,以此来保证团队内部代码规范一致,也能够找出代码中的缺陷,提前发现代码中的 bug。
关于更多 ESLint 的知识可以直接到 ESLint 官网中学习
https://eslint.org/docs/user-guide/getting-started
安装规则集
由于内部代码托管平台采用的百度自己开源的 @ecomfe/eslint-config 规则集,为了统一,在前端模