配置VSCode中ESLint和Prettier需先安装对应扩展及依赖,创建.eslintrc.js和.prettierrc规则文件,设置Prettier为默认格式化工具并开启保存自动修复与格式化,即可实现代码质量与风格统一。

为 VSCode 配置 ESLint 和 Prettier 能帮助你在编码过程中自动检查代码质量和格式,提升团队协作效率。下面介绍如何正确配置它们并协同工作。
安装必要的扩展和依赖
第一步是确保项目中安装了 ESLint 和 Prettier 的相关包,并在 VSCode 中启用对应插件。
• 在 VSCode 扩展市场中搜索并安装:
ESLint(由 Microsoft 提供)
Prettier – Code formatter(由 Prettier 官方提供)
• 在项目根目录运行以下命令安装开发依赖:
npm install --save-dev eslint prettier eslint-config-prettier eslint-plugin-prettier
如果使用 ESLint 与特定框架(如 React、Vue),还需安装对应的插件,例如 eslint-plugin-react。
配置 ESLint 和 Prettier 规则文件
在项目根目录创建或更新配置文件,使 ESLint 和 Prettier 协同工作。
• 创建 .eslintrc.js 文件:
{ "extends": [ "eslint:recommended", "plugin:prettier/recommended" // 启用 Prettier 并避免规则冲突 ], "plugins": ["prettier"], "rules": { "prettier/prettier": "error" }}
• 可选:创建 .prettierrc 文件自定义格式规则:
琅琅配音
全能AI配音神器
208 查看详情
{ "semi": true, "trailingComma": "es5", "singleQuote": true, "printWidth": 80, "tabWidth": 2}
• 建议添加 .prettierignore 忽略不需要格式化的文件:
node_modulesdistbuild
设置 VSCode 默认格式化工具
告诉 VSCode 使用 Prettier 格式化代码,并让 ESLint 修复可修复的问题。
• 打开 VSCode 设置(Ctrl + ,),搜索 Default Formatter,选择 Prettier。
• 启用保存时自动格式化:
"editor.formatOnSave": true
• 让 ESLint 自动修复问题(在 settings.json 中添加):
"editor.codeActionsOnSave": { "source.fixAll.eslint": true}
这样每次保存文件时,ESLint 会先修复问题,Prettier 再统一格式化。
验证配置是否生效
打开一个 JS 或 TS 文件,故意写一些不符合规范的代码,比如缺少分号或引号不一致。
• 如果配置正确,ESLint 会在编辑器中标记错误。
• 保存文件后,Prettier 应自动格式化代码。
• 若出现红色波浪线但未自动修复,检查终端是否有 ESLint 报错,或确认插件是否启用。
基本上就这些。只要依赖安装完整、配置文件正确、VSCode 设置到位,ESLint 和 Prettier 就能无缝协作,帮你保持代码整洁。
以上就是如何为VSCode配置ESLint或Prettier?的详细内容,更多请关注创想鸟其它相关文章!
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/425892.html
微信扫一扫
支付宝扫一扫