0

0

如何配置vscode的linting与代码格式化【教程】

紅蓮之龍

紅蓮之龍

发布时间:2026-01-23 17:31:05

|

866人浏览过

|

来源于php中文网

原创

VS Code 的 linting 和格式化需按语言和项目显式配置工具链,否则仅启用内置简单规则;必须安装项目级依赖(如 eslint、prettier)、正确配置 .eslintrc.* 和 .prettierrc、启用 @typescript-eslint/parser 并指定 tsconfig.json 路径、避免规则冲突,并用 "editor.codeActionsOnSave": { "source.fixAll.eslint": true } 替代已废弃的 autoFixOnSave。

如何配置vscode的linting与代码格式化【教程】

VS Code 的 linting 和格式化不是开箱即用的“一键开关”,必须按语言、按项目显式配置工具链,否则你看到的所谓“自动修复”大概率是 VS Code 自带的简单规则,和团队或工程实际要求完全脱节。

确认当前语言是否已安装对应 Linter 和 Formatter

比如写 TypeScript,eslintprettier 都得是项目级依赖(devDependencies),不能只靠全局安装或 VS Code 插件“假装存在”。插件(如 ESLint 扩展)只是桥梁,真正执行的是你项目里 node_modules/.bin/eslint 这个二进制。

  • 检查 package.json 是否有 "eslint""prettier"(或 "@typescript-eslint/eslint-plugin" 等)
  • 运行 npx eslint --versionnpx prettier --version,确认能执行且版本兼容
  • 如果用 Prettier 处理 TS,必须装 prettier-plugin-ts 或升级到 Prettier 2.8+(原生支持)

配置 .eslintrc.* 和 .prettierrc 的位置与加载逻辑

ESLint 默认从当前工作目录向上查找最近的 .eslintrc.js(或 .eslintrc.cjs.eslintrc.json),但 VS Code 的 ESLint 插件默认只监听打开的文件所在文件夹——如果你在多根工作区(multi-root workspace)中,每个文件夹需独立配 .eslintrc.*,否则 lint 规则不生效。

Figstack
Figstack

一个基于 Web 的AI代码伴侣工具,可以帮助跨不同编程语言管理和解释代码。

下载
  • .prettierrc 同理:它不会跨文件夹继承,prettier.config.js 中的 require() 路径也以配置文件自身为基准,不是工作区根目录
  • TS 项目务必在 eslint.config.js(或旧式 .eslintrc.cjs)中启用 @typescript-eslint/parser,且 parserOptions.project 指向正确的 tsconfig.json 路径,否则类型相关规则(如 no-unused-vars)会误报
  • 避免在 .eslintrc.* 里写 "extends": "prettier" 却没装 eslint-config-prettier——这会导致规则冲突,VS Code 可能静默跳过整个配置

VS Code 设置中关键项:不要全勾“format on save”

盲目开启 "editor.formatOnSave" 会让 Prettier 在保存时格式化,但它不等同于“先 lint 再 fix 再格式化”。ESLint 的自动修复(eslint --fix)和 Prettier 的格式化是两套机制,顺序错乱会导致代码反复被改写甚至破坏语义。

  • 推荐关闭 "editor.formatOnSave",改用 "editor.codeActionsOnSave": { "source.fixAll.eslint": true }
  • 确保 "eslint.autoFixOnSave" 已废弃(VS Code 1.8x+),必须用上面的 codeActionsOnSave 方式
  • 如果项目同时用 ESLint + Prettier,应在 eslint.config.js 中通过 prettier/@typescript-eslint 等组合配置统一入口,而不是让两个工具各自运行
  • 某些场景(如 Markdown 中嵌入代码块)需要禁用特定语言的格式化:"[markdown]": { "editor.formatOnSave": false }

最常被忽略的一点:VS Code 的“默认 formatter”设置(editor.defaultFormatter)只影响手动触发格式化的语言行为,不影响 codeActionsOnSave;而 ESLint 插件能否识别某个文件,取决于该文件的 languageId(比如 .tsxtypescriptreact,不是 typescript),配错 parser 或 extensions 就直接不 lint。

相关专题

更多
json数据格式
json数据格式

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

417

2023.08.07

json是什么
json是什么

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

533

2023.08.23

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

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

310

2023.10.13

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

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

76

2025.09.10

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

679

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

431

2024.06.27

require的用法
require的用法

require的用法有引入模块、导入类或方法、执行特定任务。想了解更多require的相关内容,可以阅读本专题下面的文章。

466

2023.11.27

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

510

2023.06.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号