0

0

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

幻影之瞳

幻影之瞳

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

|

600人浏览过

|

来源于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 文件会直接跳过——除非你在配置里明确告诉它怎么解析。

  • 推荐使用 .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 或构建产物,但默认它可能照扫不误。

IBM Watson
IBM Watson

IBM Watson文字转语音

下载
  • 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 configCannot read property 'rules' of undefined
  • 检查当前打开的文件是否在 ESLint 配置的 filesignorePatterns 范围内(比如 .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 窗口(或至少重新打开文件),否则旧规则还在内存里跑。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

557

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

416

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

756

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

479

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

514

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

1091

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

659

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

554

2023.09.20

c++空格相关教程合集
c++空格相关教程合集

本专题整合了c++空格相关教程,阅读专题下面的文章了解更多详细内容。

0

2026.01.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 4万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.0万人学习

React核心原理新老生命周期精讲
React核心原理新老生命周期精讲

共12课时 | 1万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号