F2ELint 是《阿里巴巴前端规约》的配套 Lint 工具,可以为项目一键接入规约、一键扫描和修复规约问题,保障项目的编码规范和代码质量。
它包含了如下四个规范:
| 规约 | Lint 工具 | 规则包 |
|---|---|---|
| 《JavaScript 编码规约》 《TypeScript 编码规约》 《React 编码规约》 《Rax 编码规约》 《Vue 编码规约》 《Node.js 开发规约》 | ESLint | eslint-config-ali |
| 《CSS 编码规约》 | stylelint | stylelint-config-ali |
| 《Git 规约》 | commitlint | commitlint-config-ali |
| 《文档通用规约》 | markdownlint | markdownlint-config-ali |
安装:
tnpm i -g f2elint
使用:
f2elint init:一键接入
在项目根目录执行 f2elint init,即可一键接入规约,为项目安装规约 Lint 所需的依赖和配置。
扫描&自动修复
按照命令行引导安装完成后,可以看到package.json中新增了两条脚本:
- "f2elint-scan": "f2elint scan" —— 扫描当前工程中的lint问题
- "f2elint-fix": "f2elint fix" —— 自动修复lint问题
commit-lint 代码提交时检查
由于 f2elint 也集成了 husky ,你在 commit 时,会自动检查你的commit-msg是否符合规范。 你也可以在 package.json 中手动添加上 pre-commit 时要执行的脚本,像这样:
代码提交时自动执行一遍 lint 扫描。