0

0

怎样在vscode中配置ESLint与代码规范检查【教程】

狼影

狼影

发布时间:2026-01-17 21:31:25

|

488人浏览过

|

来源于php中文网

原创

VS Code 中 ESLint 配置生效需确保本地安装、正确配置文件路径、避免与 Prettier 冲突、验证插件加载配置及区分开发与 CI 检查。

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

VS Code 里配 ESLint 不是装个插件就完事——关键得让 eslint 真正读到你的配置、识别项目规则、并在保存时按需修复。否则你看到的“红色波浪线”可能来自默认规则,和你团队的 .eslintrc.js 完全无关。

确认项目本地已安装 eslint 及对应插件

VS Code 的 ESLint 插件(dbaeumer.vscode-eslint)默认只调用工作区根目录下的本地 eslint,不走全局安装。如果你运行 npx eslint --version 报错,或 node_modules/.bin/eslint 不存在,插件会静默降级为无配置检查。

  • 执行
    npm install eslint --save-dev
    yarn add eslint --dev
    (推荐使用 --save-dev
  • 若用 TypeScript,额外装 @typescript-eslint/parser@typescript-eslint/eslint-plugin
  • 确保 package.json 中有 "eslintConfig" 字段,或项目根目录存在 .eslintrc.js / .eslintrc.cjs / eslint.config.js(ESLint v8.53+ 推荐后者)

避免 VS Code 自动启用 Prettier 冲突 ESLint 修复

很多人同时装了 Prettier 和 ESLint 插件,结果 Ctrl+S 时代码被格式化两次:一次 ESLint 自动 fix,一次 Prettier 强行重排,最终格式混乱甚至报错。

  • settings.json 中禁用 Prettier 的自动格式化:
    "editor.formatOnSave": false
  • 改用 ESLint 自带的格式能力:设置
    "editor.codeActionsOnSave": {"source.fixAll.eslint": true}
  • 如果必须用 Prettier,不要让它接管整个文件——只对非 JS/TS 文件生效,或用 eslint-config-prettier 关闭 ESLint 中与 Prettier 冲突的规则

检查 ESLint 插件是否真正加载了你的配置文件

常见现象:修改了 .eslintrc.js,但 VS Code 里没反应;或者控制台输出 ESLint: Cannot find module 'xxx'。这通常不是插件问题,而是配置路径或解析器没对上。

ListenHub
ListenHub

超真实的AI播客生成器

下载
  • 打开命令面板(Ctrl+Shift+P),运行 ESLint: Show Output Channel,看日志里是否出现 Using configuration from ... 并指向你预期的文件
  • 若提示 Failed to load parser '@typescript-eslint/parser',检查该包是否在 node_modules 中,且 .eslintrc.jsparser 路径写的是 '@typescript-eslint/parser'(不是 './node_modules/@typescript-eslint/parser'
  • 使用 eslint.config.js(ESLint v9+ 新格式)时,确保导出的是 export default [...] 数组,而非 module.exports = {...}

区分开发时检查与 CI 中的严格校验

本地 VS Code 检查可以宽松些(比如忽略某些警告),但 CI 流程(如 GitHub Actions)必须跑完整规则。别让本地“看着没报错”误导你提交违规代码。

  • .eslintignore 中排除构建产物(dist/build/),但不要排除 src/ 下的测试文件(*.test.js)——除非你明确不想检查它们
  • CI 脚本中统一用
    npx eslint . --ext .js,.ts --report-unused-disable-directives
    ,强制报告所有未使用的 // eslint-disable-line
  • VS Code 设置里可开启
    "eslint.probe": ["javascript", "typescript", "vue"]
    ,但别加 "json" ——JSON 文件交给 jsonc 语法检查更合适

最常被忽略的一点:ESLint 配置文件本身也是 JavaScript,一旦 .eslintrc.js 里写了语法错误(比如少了个逗号、用了还没声明的变量),VS Code 插件会直接静默失败,连报错都不显示。遇到“完全没反应”,第一反应应该是手动运行 npx eslint --debug src/index.js 看底层是否崩在配置加载阶段。

相关专题

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

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

556

2023.06.20

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

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

374

2023.07.04

js四舍五入
js四舍五入

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

732

2023.07.04

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

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

477

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

394

2023.09.04

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

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

991

2023.09.04

如何启用JavaScript
如何启用JavaScript

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

657

2023.09.12

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

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

552

2023.09.20

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

43

2026.01.16

热门下载

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

精品课程

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

共42课时 | 6.6万人学习

Vue3.x 工具篇--十天技能课堂
Vue3.x 工具篇--十天技能课堂

共26课时 | 1.4万人学习

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

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