VSCode插件让js代码书写符合工程规范

落萱姑娘_6882

落萱姑娘_6882

2026-09-22

473人浏览

原创

vscode默认不格式化javascript,必须安装prettier或eslint插件并显式配置"[javascript]": {"editor.defaultformatter": "esbenp.prettier-vscode"},同时启用editor.formatonsave和editor.codeactionsonsave,配合.vscode/settings.json、.prettierrc、.eslintrc.js及.editorconfig统一提交,才能实现可靠自动格式化。

vscode插件让js代码书写符合工程规范

VSCode 默认不格式化 JavaScript,必须手动指定格式化器

VSCode 自带的 JavaScript 格式化能力极弱,javascript.format.* 系列设置早已被弃用,实际生效的是你装的插件和 editor.defaultFormatter 配置。不明确指定,保存时根本不会动你的 JS 代码——哪怕你开了 editor.formatOnSave

常见错误现象:保存后缩进没变、单引号没转双引号、行尾分号没加/没删,甚至报错“没有可用的格式化程序”。这是因为 VSCode 找不到能处理 javascript 语言的格式化器。

  • 必须安装 Prettier - Code formatter(ID:esbenp.prettier-vscode)或 ESLint(ID:dbaeumer.vscode-eslint)之一
  • settings.json 中显式设置:"[javascript]": {"editor.defaultFormatter": "esbenp.prettier-vscode"}"[javascript]": {"editor.defaultFormatter": "dbaeumer.vscode-eslint"}
  • 不要只设全局 editor.defaultFormatter,JS 文件类型优先级高于全局,不单独声明会 fallback 到空

ESLint 和 Prettier 职责不能混,否则格式越修越乱

ESLint 的 source.fixAll.eslint 动作和 Prettier 的 format 动作本质不同:前者修逻辑问题(如 no-unused-vars),后者只调格式(如换行、引号)。强行让 ESLint 去格式化,会触发它内置的旧格式规则(比如强制加分号),跟 Prettier 冲突。

典型症状:保存一次,引号变了;再保存一次,分号又加回来;第三次又没了——反复横跳。

  • 如果用 Prettier 做格式主力,关掉 ESLint 的格式化能力:"eslint.formatEnable": false
  • 启用 ESLint 的修复动作仅限于规则类问题:"editor.codeActionsOnSave": {"source.fixAll.eslint": true}
  • 必须安装 eslint-config-prettier 并在 .eslintrc.jsextends: ["eslint:recommended", "prettier"],否则冲突无法消除

项目级配置比用户级配置更可靠,.vscode/settings.json 必须提交

团队里有人格式正常、有人一团糟,大概率是有人依赖自己的全局设置,而项目没提供统一入口。VSCode 读配置的优先级是:文件夹级(即 .vscode/settings.json) > 用户级 > 默认值。只配用户级,新人 clone 仓库后完全无效。

jm-jsjkxyjs02-pzl-803
jm-jsjkxyjs02-pzl-803

查询全球任意城市的实时天气和未来天气预报

下载

容易踩的坑:把 .vscode 加进 .gitignore,或者误以为“装了插件就万事大吉”。

  • .vscode/settings.json 应该和 .prettierrc.eslintrc.js 一起提交到 Git
  • 内容至少包含:editor.formatOnSave[javascript] 语言块、editor.codeActionsOnSave 三项
  • 别漏掉 "eslint.validate": ["javascript", "javascriptreact"],否则 .tsx 或 JSX 文件里的 ESLint 提示不触发

EditorConfig 是跨编辑器底线,不是可选项

即使你不用 Prettier 或 ESLint,只要团队里有人用 WebStorm、Vim 或 Sublime,.editorconfig 就是唯一能保住基础一致性的手段。它管的是缩进风格、换行符、空格/Tab 这些底层行为,VSCode 插件全靠它打底。

没它的话,Windows 用户回车变成 CRLF,别人 git diff 里全是 ^M;有人用 4 空格缩进写 Vue,别人打开直接错位。

  • 根目录建 .editorconfig,内容至少含:indent_styleindent_sizeend_of_linecharsettrim_trailing_whitespace
  • VSCode 需要安装 EditorConfig for VS Code 插件(ID:editorconfig.editorconfig)才识别该文件
  • 注意:[*.js] 这种写法无效,EditorConfig 不支持按语言匹配,只能用通配符 [*] 或扩展名 [*.json]

真实项目里最常被忽略的,是 .editorconfig.vscode/settings.json 的协同失效:一个管缩进,一个管格式化,但两者参数打架(比如一个设 2 空格,Prettier 设 4),结果谁也救不了谁。

相关文章

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

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

下载

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

相关专题

更多
js正则表达式
js正则表达式

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

2023.06.20

3756

8

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.07.28

1195

5

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1518

5

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

2023.08.17

9183

11

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

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

2023.09.01

820

4

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

2184

5

Js中concat和push的区别
Js中concat和push的区别

Js中concat和push的区别:1、concat用于将两个或多个数组合并成一个新数组,并返回这个新数组,而push用于向数组的末尾添加一个或多个元素,并返回修改后的数组的新长度;2、concat不会修改原始数组,是创建新的数组,而push会修改原数组,将新元素添加到原数组的末尾等等。本专题为大家提供concat和push相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.14

1409

5

js截取字符串的方法介绍
js截取字符串的方法介绍

JavaScript字符串截取方法,包括substring、slice、substr、charAt和split方法。这些方法可以根据具体需求,灵活地截取字符串的不同部分。在实际开发中,根据具体情况选择合适的方法进行字符串截取,能够提高代码的效率和可读性 。

2023.09.21

3689

3

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

JavaScript生成随机数的方法,包括使用Math.random()方法生成指定范围内的随机整数、生成随机字符串和生成随机颜色。根据具体需求,可以选择适合的方法来生成随机数,以实现各种功能 。

2023.09.25

2035

5

热门下载

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

精品课程

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