跳至主要內容

prettier配置说明

Mr.Dylin...大约 2 分钟13.代码提交规范和代码规范

Prettier 是一个强大的代码格式化工具,它支持多种编程语言,并能自动调整代码格式以保持一致的代码风格。以下是关于 prettier配置的详细说明:

1. 配置文件

Prettier 的配置可以通过多种方式实现,包括 .prettierrc、.prettierrc.json、.prettierrc.yml、.prettierrc.js 或 prettier.config.js 文件。这些文件通常位于项目的根目录。

2. 配置选项

以下是一些常用的配置选项及其描述:

  • printWidth :整数类型,指定一行的最大宽度,超过该宽度则换行。默认值为 80。
  • tabWidth :整数类型,设置缩进的空格数。默认值为 2。
  • useTabs :布尔类型,确定是否使用 tab 进行缩进。默认为 false,即使用空格进行缩进。
  • semi :布尔类型,决定是否在语句末尾加上分号。默认为 true)。
  • singleQuote :布尔类型,设定是否使用单引号。默认为 false,即使用双引号。但在某些配置中,默认为 true。
  • trailingComma :字符串类型,规定是否在对象或数组的最后一项后面添加逗号。可选值为 “none”、“es5” 和“all”。
  • bracketSpacing :布尔类型,决定在对象字面量的括号内是否添加空格。默认为 true。
  • arrowParens :字符串类型,控制箭头函数参数括号的添加方式。可选值为 "always"、"avoid"。
  • jsxSingleQuote :布尔类型,在 JSX 中使用单引号而不是双引号。默认为 false,但在某些配置中可能不同。
  • bracketSameLine :布尔类型,控制 HTML 或 JSX 元素的开始和结束标签是否在同一行。默认为 false但在某些配置中可能不同。
  • endOfLine :字符串类型,指定文件的结尾换行符。可选值为 "crlf"、"lf" 和 "auto"。

3. 配置文件示例

以下是一个 .prettierrc.cjs 配置文件的示例:

module.exports = {
  printWidth: 120,
  semi: true,
  vueIndentScriptAndStyle: true,
  singleQuote: true,
  trailingComma: "all",
  proseWrap: "never",
  htmlWhitespaceSensitivity: "strict",
  endOfLine: "lf",
};

4. 注意事项

Prettier 的配置应尽可能简洁,避免过度配置。 配置时应根据团队或项目的代码风格规范进行设置。

上次编辑于:
贡献者: zddbic