Prettier 配置生成器

可视化调整 13 项官方选项,一键生成 .prettierrc / .prettierrc.yaml / package.json 配置

在线 Prettier 配置生成器:所有选项默认值与 Prettier 3 官方文档一致(printWidth 80、tabWidth 2、trailingComma all、endOfLine lf 等), 支持一键套用「常见前端团队」「无分号风格」预设;可切换「精简(只含非默认项)」与「完整(显式全部键)」两种输出口径,同步生成 .prettierrc、 .prettierrc.yaml 与 package.json 内嵌片段三种载体,并附 npm 安装、npx --write 格式化命令、.prettierignore 片段及与 ESLint 协作的提示。 全部在浏览器本地生成,不上传任何数据。

预设(一键填充)

选项(默认值 = Prettier 3 官方默认)

默认 80
80
默认 2

代码风格

默认 as-needed
v3 默认 all · v2 es5

括号与箭头

默认 always

文本与换行

默认 preserve
默认 lf

Windows Git 用户注意:开启 core.autocrlf 时检出文件是 CRLF,endOfLine=lf 会让 prettier 改写整份文件行尾。建议仓库加 .gitattributes(* text=auto eol=lf),或把 endOfLine 设为 auto。

默认 css

早期版本的 jsxBracket(单参组件箭头括号)已在 Prettier 2.0 移除,行为并入 arrowParens,本工具不再提供该选项。

当前所有选项均为 Prettier 官方默认值:精简模式将输出空对象 {},完整模式会显式列出全部默认键。

配置输出

保存为项目根目录的 .prettierrc(或 .prettierrc.json)
{}

当前全部为官方默认值,精简模式输出 {}——空对象也是合法配置,Prettier 会按默认值运行。

安装与格式化命令

npm i -D prettier
npx prettier --write .

npm i -D prettier 把 Prettier 装为开发依赖;npx prettier --write . 按当前配置格式化整个项目,node_modules 与 dist 默认不碰(配合下方 .prettierignore)。

.prettierignore

保存为项目根目录的 .prettierignore,语法与 .gitignore 一致;下面片段覆盖最常见的误格式化场景(构建产物、依赖目录、锁文件)。

# 构建产物与锁文件不参与格式化
dist/
node_modules/
pnpm-lock.yaml

与 ESLint 协作:安装 eslint-config-prettier 并放到 ESLint flat config 数组最后一项,它会关闭所有与 Prettier 冲突的格式规则(引号、分号、尾逗号等);之后格式化统一交给 Prettier,ESLint 只负责代码质量检查,两者互不打架。

#Prettier 配置生成器是什么?

Prettier 配置生成器是一款在线 .prettierrc 生成工具。它把 Prettier 的 13 项官方选项做成可视化表单——printWidth(每行最大列数)、tabWidth(缩进空格数)、 useTabs、semi(分号)、singleQuote(单引号)、quoteProps、trailingComma(尾逗号)、bracketSpacing、bracketSameLine、arrowParens、proseWrap、 endOfLine(行尾符)与 htmlWhitespaceSensitivity——每项默认值都与 Prettier 3 官方文档一致并在旁标注。你可以在左侧实时调整, 右侧同步生成三种载体:独立的 .prettierrc(JSON)、 .prettierrc.yaml,以及 package.json 的 "prettier" 字段内嵌片段; 每种格式都支持「精简(只含非默认项)」与「完整(显式全部键)」两种口径,并附安装命令、.prettierignore 片段与 ESLint 协作提示。纯浏览器本地生成。

prettier 和 eslint 的分工

ESLint 是代码质量工具:未使用变量、未定义引用、hooks 依赖这类「写了会出 bug」的问题归它管;Prettier 是代码格式化工具:引号、缩进、换行、尾逗号这类「长什么样」的问题归它管。 两者的交集是一小撮格式规则(quotes、semi、comma-dangle 等),同时启用就会出现「ESLint 要求双引号、Prettier 格式化成单引号」的互相打架。 标准做法是安装 eslint-config-prettier,并把它放到 ESLint 配置数组最后一项,关闭全部冲突规则;格式化统一交给 Prettier,ESLint 回归质量检查。

.prettierrc 放哪?支持哪些文件名

放在项目根目录(与 package.json 同级)。Prettier 会从被格式化文件所在目录向上逐级查找配置,因此 monorepo 里也可以在子包再放一份覆盖根配置。 可识别的配置载体有:package.json 的 "prettier" 字段、.prettierrc(JSON 或 JSON5)、.prettierrc.json、.prettierrc.yaml / .prettierrc.yml、 .prettierrc.toml、prettier.config.js / .mjs / .cjs 等多种文件名,选一种即可(多个并存时按官方文档的优先级取用)。 本工具生成的 JSON、YAML 与 package.json 片段对应其中最常用的三种载体。

精简配置和完整配置哪个好

精简配置(只写非默认项)更短、升级友好——Prettier 升级改进默认值时你能自动受益,但读者需要「心中翻译」哪些键是默认值; 完整配置(显式全部键)自解释性强,新人不查文档就能看到所有生效值,但默认值演进可能被显式写死的旧值锁住。 团队口径建议:作为团队规范分发用完整配置(可读、可评审、可归档),个人项目或脚手架模板用精简配置(短、低维护)。 本工具两种模式一键切换,对比后定稿即可。

trailingComma 的 v2 / v3 差异

trailingComma 控制多行结构的末尾是否补逗号,可选 all / es5 / none。Prettier 3 起默认 all——函数调用与参数列表也补尾逗号, git diff 更干净、增删参数不再连带修改上一行;Prettier 2 默认 es5——只给对象、数组等 ES5 结构补,函数参数不补。 es5 的价值主要是兼容不支持「尾逗号参数」的老运行时(如 IE)。新项目建议跟随官方默认 all; 老项目从 v2 升级到 v3 后若不想让函数参数出现尾逗号,可显式写 es5。

endOfLine 在 Windows 的坑

endOfLine 默认 lf。Windows 下 Git 若开启 core.autocrlf=true,检出文件行尾会被替换成 CRLF,而 Prettier 按 lf 校验就会提示「整份文件行尾都要改」, 同事之间互相「修行尾」。两个解法:一是在仓库加 .gitattributes 写 * text=auto eol=lf,统一入库存 lf; 二是把 endOfLine 设为 auto——Prettier 按每个文件第一行的现有行尾保持原样,行尾混搭的仓库用 auto 最省事。

怎么跑格式化?npx 一条命令

不装编辑器插件也能直接跑:先 npm i -D prettier 安装依赖, 再执行 npx prettier --write .,Prettier 会按当前配置格式化项目里所有支持的文件, 并遵守 .prettierignore 与 .gitignore。只想检查不改文件,用 npx prettier --check . (CI 里常用,存在不合规文件时以非零退出码失败)。VS Code 用户再装 Prettier 官方扩展并开启「保存时格式化」,日常体验最顺。

#常见问题 (FAQ)

prettier 和 eslint 会不会冲突?

会有一小部分格式规则重叠。安装 eslint-config-prettier 并放到 ESLint 配置数组最后一项,关闭全部冲突规则即可;之后格式化交给 Prettier,ESLint 只管代码质量。

.prettierrc 支持哪些文件名?

常见的有 .prettierrc(JSON/JSON5)、.prettierrc.json、.prettierrc.yaml / .prettierrc.yml、.prettierrc.toml、prettier.config.js / .mjs / .cjs,以及 package.json 的 "prettier" 字段。放项目根目录,选一种即可。

trailingComma 应该选 all 还是 es5?

Prettier 3 默认 all(函数参数也补尾逗号),Prettier 2 默认 es5(仅对象、数组等 ES5 结构)。新项目跟随默认 all;需要兼容不支持尾逗号参数的老运行时再选 es5。

Windows 上 endOfLine 报错怎么解决?

通常是 Git 的 core.autocrlf 把检出文件改成 CRLF,而 Prettier 默认 lf 导致。在仓库加 .gitattributes(* text=auto eol=lf)统一行尾,或把 endOfLine 设为 auto 保持各文件原样。

相关工具推荐

Spine动画编辑器

专业的Spine动画预览和编辑工具,支持多引擎导出

热门 新品 本地

SQL查询优化器

分析SQL查询并提供优化建议

热门 新品 本地

JVM启动参数配置

可视化配置Java虚拟机启动参数,支持内存、GC、性能等选项

热门 新品 本地

代码片段转换

不同编程语言间代码片段转换(如Python↔JavaScript)

热门 新品 本地

IP地址查询

查询IP地址的地理位置、运营商、ASN等信息,支持IPv4和IPv6

热门 新品 本地

JSON转TypeScript接口

根据JSON数据自动生成TypeScript类型定义

热门 新品 本地

相关教程