跳到正文

我所理解的 Lint 最佳实践

页面可以导入另一个页面的私有模块,两个工具类也可以在同一个选择器里各写一遍内边距。这些代码往往能正常构建。等到模块重构或样式覆盖结果变了,才发现约定已经悄悄失效。

我把常用的检查分成三种。只看当前源码就能判断的约定交给 ESLint 或 Stylelint。需要框架信息的规则,先读取生成声明或项目配置。涉及全仓调用关系时,单独建图再检查。

  1. 《把项目约定写成 ESLint 护栏》。从目录边界的一个错误 import 讲起,判断哪些项目约定值得写成规则,以及怎样从编辑器提醒走到 CI。
  2. 《使用 Stylelint 而不是 @eslint/css 检查样式》。比较两套样式检查的解析、规则 API 和实际耗时,再区分 CSS-in-JS 的模板字符串和样式对象。
  3. 《用 ESLint 约束 Nuxt 的自动导入》。以 Nuxt 生成的组件名为依据,检查冗余的组件和 Vue API 导入,给合法的模块留出边界。
  4. 《用 ESLint 判断 Vue 组件的根 Block》。从被检查文件所在的项目出发,决定 Vue 根 Block 应使用路径名还是 Nuxt 的组件注册名。
  5. 《用 ESLint 守住 Composable 的模块边界》。检查公开入口、私有子模块和上下文 API 的调用位置。
  6. 《给 Nuxt 模块级 Composable 补上 SSR 护栏》。从服务端模块被多个请求复用的问题出发,检查本该留在客户端的模块级状态。
  7. 《用组件调用图检查可选 props》。先建全仓组件调用图,再检查只有一个调用方的组件怎样定义 props。
  8. 《用 ESLint 检查源码文件的目录归属》。用 Marker 的渲染层目录说明怎样从语法选择器迁到文件放置规则,以及哪些路径应由项目声明。
  9. 《让 Lint 规则覆盖所有适用的代码位置》。用 Vue 脚本和模板里的同一段表达式,说明如何接入各自的语法树、核对变量来源,并用对照样例验证覆盖范围。

有些规则要跟原问题一起读。字符截断的规则依赖 Unicode 字符边界,正则检查的范围取决于引擎和输入,UnoCSS 工具类的冲突则取决于实际生成的 CSS。