跳到正文

代码规范检查

Lint

中级通用

代码规范检查(Lint)是用工具按预设规则扫描代码,找出可疑写法和不符合团队约定的地方。它能让你在提交前发现未使用的变量、遗漏的依赖等问题,减少 AI 生成代码带来的低级疏漏。

你可能会说:「帮我看看 AI 写的这些代码有没有明显问题,顺便统一一下团队的写法。」

读之前建议先了解

动手看看

UserPanel.jsx
ESLint · 团队规则
const draft = "草稿";
useEffect(() => {
console.log(userId);
}, []);
// 已删除未使用的 draft
useEffect(() => {
console.log(userId);
}, [userId]);
尚未检查打开“运行检查”,按团队规则扫描当前代码。
发现 2 个问题
第 1 行:draft 声明后未使用
第 4 行:依赖数组缺少 userId
检查通过 · 0 个问题当前片段符合已启用的规则,可以继续提交前的测试。
no-unused-vars:识别未使用变量。react-hooks/exhaustive-deps:检查 Hook 依赖是否遗漏。
运行检查
代码版本
显示规则说明

切换“运行检查”看标记如何出现,再选“修复版本”对比结果。这里用开关模拟运行检查,不会真的执行代码。

draft 没被使用;Effect 读取了 userId,却没把它放进依赖数组。启用对应规则后,Lint 能在提交前提醒这些疏漏。

要点

  1. 1

    按项目规则扫描代码

    Lint 工具读取代码和项目配置,再逐条检查规则。比如你做后台页面时,它可能指出一个变量声明后从未使用。规则由项目决定,所以同一段代码在不同项目里可能得到不同结果。

  2. 2

    区分提示与实际故障

    有些提示指向可能的错误,有些只是写法不统一。你看到 AI 交付代码后有 Lint 报告,可以先看规则、位置和原因,再决定怎么改;检查通过也不代表页面功能一定正确。

  3. 3

    让检查融入协作流程

    我们可以在编辑器里边写边看提示,也可以在提交代码或持续集成时运行检查。这样做的好处是,AI Agent 和人写的代码会经过同一套规则,问题更容易在合并前暴露。

容易混淆的地方

Lint 和代码格式化容易混淆:格式化主要调整缩进、换行等排版,Lint 还可能指出未使用变量或有风险的写法;有些工具会同时提供两类能力。它也不是测试:测试通过实际执行来验证特定行为,Lint 通常靠静态分析,无法证明一个功能符合产品需求。

什么时候用

适合用

  • AI Agent 刚生成一批前端组件,你想在合并前检查可疑写法,以及代码是否符合项目约定。
  • 多人维护同一个后台项目,你想让每次提交都接受相同的代码规则检查,减少反复讨论写法。

不适合用

  • 你想确认下单后库存是否真的扣减;这需要覆盖业务行为的测试,Lint 无法验证结果。
  • 你只有一份产品需求文档,还没有代码可检查;先梳理验收标准,比配置 Lint 更有用。

练一练

AI Agent 为网站新增了登录表单。页面能打开,但你想在合并前发现代码中的可疑写法,并确认登录行为正常。你会怎么安排?

让 AI 帮你做

请先查看这个项目现有的 Lint 配置和运行命令,对你修改的代码运行检查。修复与你的改动相关的问题,不要为了消除提示而随意关闭规则;最后告诉我检查结果,以及仍需通过测试验证的行为。

接下来学什么