跳到正文

我所理解的 JavaScript 最佳实践(17):控制文件行数

我所理解的 JavaScript 最佳实践

  1. 使用现代化工具
  2. 尽量去掉只用一次的中间变量
  3. 遍历的起点决定按 ID 取数的顺序
  4. 不用 reduce
  5. 按遍历任务选择循环和数组方法
  6. 异步遍历按任务依赖选择并发或串行
  7. 卫语句让主流程保持平直
  8. 用函数给可复用的业务规则命名
  9. 让顺序无关的代码按名称排列
  10. 正确写注释
  11. 一行代码只做一件事
  12. 给函数起合适的名字
  13. 用空值合并运算符更好地控制默认值生效逻辑
  14. 用队列串行处理偏好更新,避免修改互相覆盖
  15. 确认弹窗关闭时,让等待中的 Promise 得到结果
  16. 用独立的预期值捕获实现错误
  17. 控制文件行数(当前)
  18. 控制函数圈复杂度和认知复杂度
  19. 使用工具函数进行类型判断
  20. 会演进的函数用对象参数
  21. 使用改进的原生 API
  22. 使用模板字符串优化多行文字展示
  23. 用查表取值,用 switch 分派动作
  24. 正确使用纯函数和副作用
  25. 避免数组空位
  26. 把条件写在可选元素和字段旁边
  27. 让独立条件各自表达

我给一个 Markdown 阅读器换了 Prettier 配置。入口 App.vue 从 2094 行变成了 1825 行,74 个顶层变量声明和 99 个模板元素节点却原样保留。格式化让文件更短了,读到「复制路径」时,仍要在窗口外观、目录树和阅读标签的代码之间找它的焦点处理和定时器。

我会用行数找这种文件。看到告警之后,先找一项能独立描述和验证的职责,连同它的状态、入口和清理逻辑一起搬。光改换行就能让数字变小,接手的人还是要读同一批代码。

普通脚本和 Vue 区块分开计数

ESLint 的 max-lines 计算文件的物理行数,默认上限是 300,空行和注释都计入。skipBlankLines 可以跳过空行,skipComments 只跳过整行注释,带行尾注释的代码仍占一行。团队可以先决定要衡量读者需要翻多少内容,还是代码本身的规模,再用同一套配置比较改动前后的结果。

Vue 单文件组件把脚本、模板和样式放在一起,我更愿意分开看这三个区块。满是说明文字的模板和注册了多个订阅的脚本,需要处理的事情不同。上游 vue/max-lines-per-block 只检查显式配置了上限的区块。下面给各区块设 300 行作为试跑值,把这段配置放在已有 parser 和 eslint-plugin-vue 配置之后。

export default [
  {
    files: ['**/*.{js,jsx,mjs,cjs,ts,tsx,mts,cts}'],
    rules: { 'max-lines': 'warn' },
  },
  {
    files: ['**/*.vue'],
    rules: { 'vue/max-lines-per-block': ['warn', { script: 300, template: 300, style: 300 }] },
  },
];

两类规则使用不同的文件范围,打开 Vue 文件时就能直接知道是哪一块超限。生成的客户端、数据快照和第三方代码可以用项目的 ignore 范围排除。手写的数据表如果是一个完整定义,可以按具体路径放宽上限,保留数据在同一处的好处。

顺着实际修改任务找拆分点

我会拿一个小需求来读超限文件。例如,要改目录树的键盘导航,先找到行选择、焦点移动和滚动位置,再看这些操作是否一直围着同一组 DOM 节点。这样的逻辑可以交给侧栏组件。若要改系统明暗模式,应该能从监听注册追到 CSS 变量更新、保存回滚和卸载清理,这些工作适合跟着窗口外观的 composable 走。

顶层变量数和模板标签数受换行影响较小,适合当第二眼的线索。常量表里的十个变量和十份会变化的状态,维护成本差很多。静态列表有许多标签,两个互相影响的表单区域也可能只有几个标签。比起总数,我更关心变量由谁写、变化时触发哪些副作用,以及模板里的事件分支是否集中在一个区域。组件边界见《正确拆分组件》。

存量项目先单独跑一遍

已有 lint 使用 --max-warnings=0 时,加一条 warn 也会让原命令退出失败。可以另建一份配置,先复用项目当前规则,再追加行数检查,用 pnpm exec eslint --config eslint.quality.config.mjs . 跑一次。读报告时先区分手写模块、生成内容和长数据表,然后挑一个本来就需要改的区域来验证边界。一个文件缩短之后,从调用处追到实现也应该更直接。