website

Prettier Docs

所属分类:开发者在线工具箱

Prettier 代码格式化工具的安装、配置选项与浏览器版文档

Prettier 文档站说明代码格式化工具 Prettier 的用法。它覆盖 JavaScript、TypeScript、CSS、HTML、Markdown 等多种语言,从安装、配置文件、选项,到编辑器集成和浏览器版本都有独立页面,适合想在团队中统一代码风格的开发者查阅。

Prettier 文档:统一代码格式的安装方法、配置选项与浏览器用法

发布于 2026年10月18日更新于 2026年10月29日

格式化的方式

“What is Prettier?”页面称 Prettier 是一个带有明确风格取向(opinionated)的代码格式化工具,支持的语言包括 JavaScript(含实验性特性)、JSX、Angular、Vue、Flow、TypeScript、CSS、Less、SCSS、HTML、Handlebars、JSON、GraphQL、Markdown、YAML、Lightning Web Components 和 MJML。页面说明,Prettier 会考虑行宽,把解析后的代码从头重新打印,并附有关于个别格式保留情况的脚注。

Prettier 文档“What is Prettier?”页面,左侧为分组目录,右侧列出支持的语言,并附有一段关于重新打印代码的说明

安装与配置文件

安装页面给出的命令是 npm install --save-dev --save-exact prettier@3.9.10,同时列出 yarn、pnpm、bun 和 deno 的写法。随后建议创建内容为 {} 的 .prettierrc,让编辑器和其他工具知道项目使用了 Prettier;再创建 .prettierignore 排除 build、coverage 等产物目录。页面还注明,如果运行目录中已有 .gitignore,Prettier 也会遵循其中的规则。

选项与行宽

选项页面列出的主要选项包括实验性三元表达式(experimentalTernaries)、二元运算符换行位置(experimentalOperatorPosition,可选 start 或 end),以及行宽 printWidth。页面提醒,printWidth 不是严格的最大行长,而是告诉 Prettier 大致希望在哪里换行,并建议不要超过 80 个字符。页面也建议把选项写进配置文件,使命令行和编辑器读取同一套设置。

在浏览器中使用

浏览器页面介绍的是 standalone 独立版本。它不依赖 Node.js,只负责格式化代码,不支持配置文件、忽略文件、命令行,也不会自动加载插件。ES 模块版本 standalone.mjs 自 3.0 起提供,UMD 版本 standalone.js 自 1.13 起提供。调用 prettier.format(code, options) 时必须指定 parser 或 filepath,插件需要通过 plugins 选项手动传入。

Prettier 文档“Browser”页面,左侧为目录,正文说明独立版本的用法,并列出 prettier.format 的必填选项和插件参数

站内导航

左侧目录分为 About、Usage、Configuring Prettier、Editors、Misc 等分组。Usage 下有安装、忽略文件、与 Linter 集成、预提交钩子、插件、CLI 和 API 等页面;Editors 下有编辑器集成、WebStorm 与 Vim 的设置。顶部还有 Playground 在线试用入口。