代码规范
杂乱不堪如同屎山般的代码,会让开发者头皮发麻,无从下手,往往更容易诱发 bug。而一个良好的代码规范, 能够修复团队的各个成员间代码格式不统一,有利于维护与审查。
这里主要不是介绍具体的代码规范标准,这些在对应的官方文档中的风格指南可查看。本文主要利用插件工具,在保存代码与上传代码时,根据配置规则来规范代码。
本栏主要针对前端项目的代码规范配置,使用 VSCode 文本编辑器及其插件配置。
📄️ eslint
ESLint 是一种用于识别和报告 ECMAScript/JavaScript 代码中发现的模式的工具,目的是使代码更加一致并避免错误。
📄️ prettier
Prettier 是一个固执己见的代码格式化程序。
📄️ stylelint
stylelint 主要针对 css 样式进行格式化(包括css预处理器),同时对一些属性拼写进行检查。
📄️ editorconfig
Editorconfig 有助于跨各种编辑器和 IDE 为处理同一项目的多个开发人员维护一致的编码样式。
📄️ husky
为了确保只有合格的代码才能够提交到仓库。需要配置自动化脚本,确保代码在提交前通过了代码验证工具的检验。
📄️ npmrc
对于 pnpm 项目,通常会有一个 .npmrc 文件,用于配置npm的一些参数,比如使用pnpm的严格模式等,其内容如下。