首页 > 开发工具 > VSCode > 正文

在VSCode中配置Prettier与ESLint,实现代码自动格式化

P粉986688829
发布: 2025-12-18 20:01:02
原创
839人浏览过
VSCode中配置Prettier与ESLint协同工作,需安装对应扩展及项目依赖(eslint、prettier、eslint-config-prettier、eslint-plugin-prettier),在.eslintrc.js中extend 'plugin:prettier/recommended',并通过.vscode/settings.json启用保存时ESLint自动修复和格式化,确保二者不冲突、分工明确。

在vscode中配置prettier与eslint,实现代码自动格式化

在 VSCode 中配置 Prettier 与 ESLint 实现自动格式化,关键不是装插件,而是让两者协同工作、不打架——Prettier 负责统一代码样式(缩进、引号、换行等),ESLint 负责代码质量与规范检查(如未定义变量、禁止 var 等),二者分工明确才能真正提效。

安装必要扩展和依赖

先确保本地项目和编辑器都装对了东西:

  • VSCode 扩展:安装 Prettier(官方,作者:esbenp)和 ESLint(官方,作者:dbaeumer)
  • 项目依赖(推荐本地安装,避免团队环境差异):
    npm install --save-dev eslint prettier eslint-config-prettier eslint-plugin-prettier
    其中 eslint-config-prettier 关闭 ESLint 中与 Prettier 冲突的规则,eslint-plugin-prettier 把 Prettier 当作 ESLint 的一条规则来运行(推荐方式)

配置 ESLint 使用 Prettier

在项目根目录创建或修改 .eslintrc.js(或其他格式),确保包含以下核心配置:

module.exports = {
  extends: [
    'eslint:recommended',
    'plugin:prettier/recommended' // 这行会自动启用 eslint-plugin-prettier 并关闭冲突规则
  ],
  plugins: ['prettier'],
  rules: {
    'prettier/prettier': 'error' // 把 Prettier 错误作为 ESLint 错误提示
  }
};
登录后复制

⚠️ 注意:plugin:prettier/recommended 已内置 eslint-config-prettier,无需再单独 extend 它。

设置 VSCode 自动保存时格式化

打开 VSCode 设置(Ctrl+,Cmd+,),搜索并勾选:

  • Format On Save:保存时自动格式化
  • Default Formatter:设为 esbenp.prettier-vscode(但注意:若同时启用了 ESLint 的“自动修复”功能,优先用 ESLint 驱动格式化更稳妥)

更推荐的方式是:在项目根目录添加 .vscode/settings.json,精准控制当前项目行为:

Playground AI
Playground AI

AI图片生成和修图

Playground AI 108
查看详情 Playground AI
{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },
  "eslint.validate": ["javascript", "typescript", "vue"]
}
登录后复制

这样保存时先由 ESLint 自动修复(含 Prettier 格式化),再触发格式化动作,逻辑更可靠。

可选:添加 .prettierrc 配置文件

如果需要自定义 Prettier 行为(比如单引号、分号、箭头函数括号),在根目录加 .prettierrc

{
  "singleQuote": true,
  "semi": false,
  "arrowParens": "avoid",
  "tabWidth": 2
}
登录后复制

该文件会被 Prettier 和 eslint-plugin-prettier 共同读取,保持一致。

基本上就这些。配置完成重启 VSCode,打开 JS/TS 文件,保存即生效。不复杂但容易忽略的是:别让 Prettier 和 ESLint 规则互相覆盖,靠 eslint-plugin-prettier 统一入口最稳。

以上就是在VSCode中配置Prettier与ESLint,实现代码自动格式化的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

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