prettier
约 586 字大约 2 分钟
2024-08-13
Prettier 是一种流行的代码格式化工具,它支持多种编程语言,并提供了一组可配置的选项以适应不同的代码风格需求。
printWidth:
- 默认值:
80 - 说明: 指定代码行的最大宽度,超出此宽度时会自动换行。
- 默认值:
tabWidth:
- 默认值:
2 - 说明: 指定每个缩进层级的空格数。
- 默认值:
useTabs:
- 默认值:
false - 说明: 决定是否使用硬制表符(
\t)进行缩进,而不是空格。
- 默认值:
singleQuote:
- 默认值:
false - 说明: 如果设置为
true,则字符串将使用单引号代替双引号,除非是避免转义。
- 默认值:
jsxSingleQuote:
- 注意:这个选项在给出的链接中并不存在,可能是混淆了与
singleQuote的区别。
- 注意:这个选项在给出的链接中并不存在,可能是混淆了与
trailingComma:
- 可选值:
none,es5,all - 默认值:
none - 说明: 控制数组和对象字面量中的尾随逗号。
- 可选值:
bracketSpacing:
- 默认值:
true - 说明: 在对象字面量的花括号内添加空格
{ foo: bar }或移除{foo: bar}。
- 默认值:
jsxBracketSameLine:
- 默认值:
false - 说明: JSX 行尾的
>是否应该放在最后一行参数的同一行或下一行。
- 默认值:
semi:
- 默认值:
true - 说明: 决定语句末尾是否应加上分号。
- 默认值:
singleAttributePerLine:
- 默认值:
false - 说明: 对于多属性的 JSX 元素,每个属性是否应该独占一行。
- 默认值:
arrowParens:
- 可选值:
avoid,always - 默认值:
always - 说明: 箭头函数只有一个参数时是否需要括号。
- 可选值:
endOfLine:
- 可选值:
lf,crlf,cr,auto - 默认值:
lf - 说明: 指定文件结尾的换行符类型。
- 可选值:
ignorePath:
- 默认值:
.prettierignore - 说明: 指定一个文件来定义哪些文件或目录不应该被 Prettier 格式化。
- 默认值:
parser:
- 默认值: 根据文件扩展名自动推断
- 说明: 显式指定 Prettier 应该使用的解析器。
这些选项可以通过配置文件、命令行标志或 IDE 插件设置来应用到你的项目中。Prettier 文档还提供了更多高级配置和用法示例,建议阅读官方文档获取最新和最详细的信息。
常用配置:
.prettierrc
{
"printWidth": 120,
"tabWidth": 4,
"singleQuote": true,
"semi": true,
"useTabs": false,
"bracketSpacing": false,
"jsxBracketSameLine": true,
"trailingComma": "none",
"arrowParens": "avoid"
}.prettierrc.js
module.exports = {
printWidth: 120,
tabWidth: 4,
singleQuote: true,
semi: true,
useTabs: false,
bracketSpacing: false,
jsxBracketSameLine: true,
trailingComma: 'none',
arrowParens: 'avoid',
};