VSCode怎样配置ESLint进行代码规范检查【教程】

12次阅读

ESLint在vscode不生效主因是未运行而非配置错,需检查eslint.enable是否启用、配置文件是否存在、本地eslint依赖是否安装,以及新格式eslint.config.js需手动开启flatConfig支持。

VSCode怎样配置ESLint进行代码规范检查【教程】

VSCode 里 ESLint 不生效?先确认插件和配置是否真在起作用

ESLint 在 VSCode 中不报错,大概率不是配置写错了,而是它根本没运行起来。常见原因包括:eslint.enable 被设为 false、工作区没识别到 .eslintrc.jspackage.json 中的 eslintConfig、或者项目里压根没装 eslint 依赖(仅装了 VSCode 插件不够)。

实操建议:

  • 打开命令面板(Ctrl+Shift+P / Cmd+Shift+P),输入并执行 ESLint: Show Output channel,看输出里有没有报错,比如 Failed to load config "eslint:recommended" —— 这说明本地 eslint 包缺失
  • 检查 VSCode 设置中 eslint.enable 是否为 true(推荐在工作区设置里配,避免影响其他项目)
  • 确保项目根目录下有 ESLint 配置文件,且文件名是 .eslintrc.js.eslintrc.cjs.eslintrc.jsonpackage.json 中含 eslintConfig 字段
  • 如果用的是 eslint.config.js(ESLint v8.22+ 的新格式),VSCode 当前稳定版(截至 1.85)默认不支持,需手动启用:在设置中搜索 eslint.experimental.useFlatConfig 并设为 true

为什么保存后没自动修复?eslint.autoFixOnSave 已被弃用

VSCode 旧教程常提的 eslint.autoFixOnSave 在 ESLint 扩展 v2.2.0+ 后已彻底移除。现在修复行为由 VSCode 的通用格式化机制接管,必须同时满足三个条件才触发自动修复:

  • 文件语言模式正确(如 javascripttypescriptvue),VSCode 右下角显示的语言标识要对
  • 该语言的默认格式化工具设为 ESLint:在设置中搜 editor.defaultFormatter,找到对应语言(如 [javascript]),值设为 dbaeumer.vscode-eslint
  • editor.formatOnSave 开启(全局或工作区)

注意:eslint.codeAction.showDocumentation 这类设置只影响右键菜单,不影响自动修复逻辑。

Vue / TypeScript 项目里 ESLint 报错“Parsing Error: Cannot find module ‘xxx’”

这类错误通常不是代码写错了,而是 ESLint 解析器没配对。Vue 单文件组件需要 @typescript-eslint/parser + vue-eslint-parser 协同;TypeScript 项目若只用默认 espree 解析器,会直接报语法错误。

关键配置点:

  • .eslintrc.js 中明确指定 parser:Vue + TS 项目应设为 '@typescript-eslint/parser',并加 parserOptions.parser 子项指向 vue-eslint-parser(针对 .vue 文件)
  • 确保安装了对应解析器包:npm install -D @typescript-eslint/parser vue-eslint-parser
  • 若用 eslint.config.js 新格式,languageOptions.parserlanguageOptions.parserOptions.parser 必须分层配置,漏一层就会退回到 espree

想让 ESLint 只检查保存的文件,而不是整个工作区

默认情况下,VSCode 的 ESLint 扩展会监听所有打开的 JS/TS 文件,容易卡顿。可通过 eslint.workingDirectories 精确控制作用域

推荐写法(放在 .vscode/settings.json 中):

"eslint.workingDirectories": [   "./src",   { "mode": "auto" } ]

这样 ESLint 只会在 src 目录下查找配置并执行检查;"mode": "auto" 表示对其他文件夹按就近原则找配置(比如 packages/foo 下有自己的 .eslintrc 就用那个)。不建议用 ["./"],它会让 ESLint 递归扫描 node_modules。

另外,eslint.run 设为 onType 时响应最快,但可能误报;设为 onSave 更稳,适合 CI 前最后把关。

text=ZqhQzanResources