VSCode如何使用Prettier代码格式化_VSCode Prettier代码格式化使用实战

梦丽君_5365

梦丽君_5365

2026-04-07

739人浏览

原创

prettier 在 vscode 中需手动设为默认格式化工具并安装本地 prettier 包,否则不生效;eslint 需用 eslint-config-prettier 且置于 extends 末尾以避免冲突;项目级 .prettierrc 配置优先于 vscode 设置。

vscode如何使用prettier代码格式化_vscode prettier代码格式化使用实战

Prettier 在 VSCode 里默认不生效,必须手动配置格式化程序并设为默认,否则按 Shift+Alt+F 或保存时根本不会触发。

安装 Prettier 扩展和依赖

只装 VSCode 插件(如 Prettier - Code formatter)不够,项目级格式化需要本地或全局的 prettier 包支持:

  • 推荐在项目根目录运行 npm install --save-dev prettier(或 yarn add -D prettier),避免不同项目格式不一致
  • 如果全局安装(npm install -g prettier),VSCode 可能因权限或路径问题找不到,尤其在 macOS 或使用 nvm 时
  • 扩展本身不带 Prettier CLI,它只是调用你本地安装的版本;没装包会报错:Failed to load module 'prettier'

设置默认格式化工具为 Prettier

VSCode 默认用内置格式器(比如 JavaScript 的 vscode.typescript-language-features),必须显式指定 Prettier:

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
  • 打开命令面板(Ctrl+Shift+P / Cmd+Shift+P),输入并选择 Format Document With...
  • 选 Configure Default Formatter... → 选 Prettier
  • 或者直接编辑 .vscode/settings.json,加这一行:"editor.defaultFormatter": "esbenp.prettier-vscode"
  • 注意:如果同时启用了 editor.formatOnSave,但没设默认格式器,保存时依然不会走 Prettier

处理 ESLint 和 Prettier 冲突

ESLint 的 eslint-config-prettier 是禁用所有与 Prettier 冲突规则的“补丁”,不是增强插件:

  • 必须安装:npm install --save-dev eslint-config-prettier
  • 在 .eslintrc.js 或 .eslintrc.cjs 中,把它放在 extends 数组**最后**:["plugin:react/recommended", "prettier"]
  • 如果顺序反了(比如 "prettier" 在前),ESLint 会重新启用被覆盖的规则,导致保存后又自动改回不符合 Prettier 的样式
  • VSCode 的 ESLint 扩展(dbaeumer.vscode-eslint)默认不接管格式化,仅校验;想让它“修”代码需额外配 eslint.format.enable: true,但更推荐让 Prettier 负责格式、ESLint 负责逻辑检查

自定义 Prettier 行为的关键配置

VSCode 的 prettier.* 设置项优先级低于项目级 .prettierrc 或 package.json 中的 prettier 字段,后者才是真实生效源:

  • 项目根目录放 .prettierrc(JSON/YAML/JS 格式均可),例如:
    { "semi": false, "singleQuote": true, "tabWidth": 2 }
  • 不要依赖 VSCode 设置里的 prettier.semi 等开关——它们只在没找到项目配置时兜底,容易造成团队配置不一致
  • 对 TypeScript 文件,确保 prettier 版本 ≥ 2.0,并在 .prettierrc 中显式加 "parser": "typescript",否则可能误用 JS parser 导致格式错误
  • 如果某些文件不想被格式化(如生成的 dist/ 或 node_modules/),在 .prettierignore 里写路径,语法类似 .gitignore

最常被忽略的是:Prettier 不处理分号、引号等风格问题以外的逻辑(比如变量命名、import 排序),它只做“打印样式”。想统一代码质量,得配合 ESLint + EditorConfig + Commit Hooks,单靠格式化按钮解决不了深层一致性问题。

相关文章

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

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

下载

相关标签:

vscode

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

相关专题

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

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

2026.02.13

252

17

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

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

2026.02.25

480

17

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

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

2026.03.13

331

19

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

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

2026.06.03

246

29

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

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

2026.06.16

498

8

json数据格式
json数据格式

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

2023.08.07

1995

5

json是什么
json是什么

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

2023.08.23

2782

1

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

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

2023.10.13

956

3

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

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

2025.09.10

3119

7

热门下载

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

精品课程

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