prettier 配置文件 .prettierrc

格式化整个项目:npx prettier --write .


.prettierrc 是一个配置文件,用于定义 Prettier 的代码格式化规则。这个文件通常放在项目的根目录下,以便 Prettier 在格式化代码时能够找到并使用这些规则。

.prettierrc 文件可以是一个 JSON 文件,其中包含了各种格式化选项。以下是一个 .prettierrc 文件的示例,其中包含了多种语言的格式化规则:

{
  "semi": true,
  "trailingComma": "all",
  "singleQuote": true,
  "printWidth": 80,
  "tabWidth": 2,
  "bracketSpacing": true,
  "jsxBracketSameLine": false,
  "arrowParens": "avoid",
  "endOfLine": "auto",
  "htmlWhitespaceSensitivity": "css",
  "cssDeclarationSortOrder": "alphabetical",
  "tableContentIndentation": "align",
  "vueIndentScriptAndStyle": true,
  "proseWrap": "preserve"
}
在这个示例中,各个选项的含义如下:
  • "semi": true:在语句末尾添加分号。
  • "trailingComma": "all":在对象或数组的最后一个元素后面添加尾随逗号。
  • "singleQuote": true:使用单引号而不是双引号。
  • "printWidth": 80:一行的最大宽度为 80 个字符。
  • "tabWidth": 2:使用两个空格的缩进。
  • "bracketSpacing": true:在对象的大括号之间添加空格 { foo: bar }。
  • "jsxBracketSameLine": false:在 JSX 中,将 > 放在最后一行的结束处,而不是新行上。
  • "arrowParens": "avoid":在只有一个参数的箭头函数中避免使用圆括号。
  • "endOfLine": "auto":自动检测并保留行尾符号(如 \n 或 \r\n)。
  • "htmlWhitespaceSensitivity": "css":在 HTML 中,对空白字符的敏感度与 CSS 相同。
  • "cssDeclarationSortOrder": "alphabetical":将 CSS 声明按字母顺序排序。
  • "tableContentIndentation": "align":对齐表格内容的缩进。
  • "vueIndentScriptAndStyle": true:在 Vue 文件中,对 <script> 和 <style> 标签的内容进行缩进。
  • "proseWrap": "preserve":在 Markdown 中,保持原有的换行符。

你可以根据自己的代码风格和团队约定来调整这些选项。在修改完 .prettierrc 文件后,每次运行 Prettier(例如,通过 npx prettier --write . 命令)时,它都会使用这些规则来格式化你的代码。

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容