讲师中心 微信公众号
AI工具推荐 视频效率加速

怎样在VSCode中配置ESLint实现代码规范检查【教程】

大婷酱_9076

大婷酱_9076

发布时间:2026-01-24 11:12:48

|

660人浏览过

|

来源于php中文网

原创

VSCode中ESLint需本地安装、正确配置parser及插件、设置验证语言和自动修复,并排查配置路径、文件范围与环境兼容性问题。

怎样在vscode中配置eslint实现代码规范检查【教程】

VSCode 里配 ESLint 不是装个插件就完事,关键得让编辑器真正读到你的规则、识别项目结构、并和你用的 JavaScript/TypeScript 版本对齐。否则你会看到 ESLint: Cannot find module 'eslint-plugin-react' 或者修改代码后毫无反应。

确认项目已安装 ESLint 及对应插件

VSCode 的 ESLint 插件(dbaeumer.vscode-eslint)只是“显示器”,真正干活的是你项目本地的 eslint 包。全局安装的 ESLint 基本无效,尤其在多项目、多 Node 版本环境下。

  • 运行 npm install eslint --save-dev(或 yarn add eslint -D),确保 node_modules/.bin/eslint 存在
  • 按需安装插件,比如 React 项目要加 eslint-plugin-react,TypeScript 项目必须有 @typescript-eslint/eslint-plugin 和 @typescript-eslint/parser
  • 检查 package.json 中的 devDependencies 是否包含这些包,缺失会导致“找不到 plugin”错误

配置 .eslintrc.* 文件并指定 parser

ESLint 默认只认 JS,遇到 .ts 或 .jsx 文件会直接跳过——除非你在配置里明确告诉它怎么解析。

React Wrap
React Wrap

React UI?—— JavaScript?

下载
  • 推荐使用 .eslintrc.js(比 JSON 更灵活,支持注释和条件判断)
  • TypeScript 项目必须设置 parser: '@typescript-eslint/parser',且 parserOptions.project 指向 tsconfig.json 路径(否则类型相关规则如 @typescript-eslint/no-explicit-any 不生效)
  • React 项目需启用 ecmaFeatures.jsx: true 并加入 plugins: ['react', 'react-hooks']
  • 避免把 env 设成 browser: true 后又在 Node 脚本里用 require——ESLint 会报 require is not defined

在 VSCode 设置中启用自动修复与作用域控制

VSCode 默认不会自动修复,也不区分文件类型——比如你不希望 ESLint 去检查 node_modules 或构建产物,但默认它可能照扫不误。

  • 在 settings.json 中添加:
    "eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact"]
    ,漏掉 typescriptreact 就无法校验 .tsx 文件
  • 开启保存时修复:
    "editor.codeActionsOnSave": {"source.fixAll.eslint": true}
    ,但注意:这仅触发“可自动修复”的规则(如分号、引号),缩进或复杂逻辑问题仍需手动处理
  • 用 "eslint.options": {"overrideConfigFile": "./.eslintrc.js"} 显式指定配置路径,防止工作区嵌套时加载错配置
  • 通过 "eslint.workingDirectories" 支持 monorepo,例如:
    "eslint.workingDirectories": [{"mode": "auto"}]
    让 ESLint 自动向上查找每个子包的 .eslintrc

排查常见“没反应”场景

代码改了但红波浪线不出现,或者右键“Fix all auto-fixable problems”点完没变化——大概率不是插件坏了,而是环境链断了。

  • 打开命令面板(Ctrl+Shift+P),运行 ESLint: Show Output Channel,看输出里是否报 Failed to load config 或 Cannot read property 'rules' of undefined
  • 检查当前打开的文件是否在 ESLint 配置的 files 或 ignorePatterns 范围内(比如 .eslintignore 里写了 src/**/*.test.js,那测试文件就不会被检查)
  • 如果用了 PnP(Yarn Berry)或 pnpm,需额外配置 "eslint.packageManager": "pnpm" 或手动指定 "eslint.runtime" 路径
  • TSX 文件报 Parsing error: Cannot use JSX unless the '--jsx' flag is provided?说明 parserOptions.project 没指向含 "jsx": "preserve" 的 tsconfig.json

最常被忽略的一点:VSCode 的 ESLint 插件不会自动监听 .eslintrc 文件变更,改完配置必须重启 VSCode 窗口(或至少重新打开文件),否则旧规则还在内存里跑。

热门AI工具

更多
VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

312

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

520

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

371

2026.03.13

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

286

2026.06.03

TypeScript Node.js 全栈工程化与Monorepo架构实践
TypeScript Node.js 全栈工程化与Monorepo架构实践

本专题围绕 TypeScript 在 Node.js 全栈开发中的工程化实践展开,系统讲解 Monorepo 架构设计、包管理策略、模块复用机制以及服务端与前端统一类型系统的构建方法。通过真实项目案例,帮助开发者提升大型全栈项目的可维护性与协作效率。

658

2026.06.16

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2195

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

3442

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

1156

2023.10.13

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

120

2026.10.22

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn