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

星晨姑娘_9445

星晨姑娘_9445

2026-01-17

508人浏览

原创

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'。这通常不是插件问题,而是配置路径或解析器没对上。

Git Pro
Git Pro

Git高级操作:smart-commit、rebase、bisect、worktree、reflog、冲突解决、子模块、PR流程

下载
  • 打开命令面板(Ctrl+Shift+P),运行 ESLint: Show Output Channel,看日志里是否出现 Using configuration from ... 并指向你预期的文件
  • 若提示 Failed to load parser '@typescript-eslint/parser',检查该包是否在 node_modules 中,且 .eslintrc.js 中 parser 路径写的是 '@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 看底层是否崩在配置加载阶段。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2026.02.13

332

17

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

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

2026.02.25

540

17

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

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

2026.03.13

391

19

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

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

2026.06.03

306

29

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

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

2026.06.16

718

8

json数据格式
json数据格式

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

2023.08.07

2255

5

json是什么
json是什么

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

2023.08.23

3662

1

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

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

2023.10.13

1216

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

4219

7

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
uni-app快速上手
uni-app快速上手

共0课时 | 0人学习

Vue 教程
Vue 教程

共42课时 | 17.4万人学习

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

共26课时 | 2.6万人学习