.prettierrc.js 3.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. module.exports = {
  2. // 指定换行的行长<int>,默认80
  3. printWidth: 80,
  4. // 指定每个缩进级别的空格数<int>,默认2
  5. tabWidth: 2,
  6. // 用制表符而不是空格缩进<bool>,默认false
  7. useTabs: false,
  8. // 在语句末尾添加分号<bool>,默认true
  9. semi: true,
  10. // 使用单引号而不是双引号<bool>,默认false
  11. singleQuote: false,
  12. // object对象中key值是否加引号<as-needed|consistent|preserve>,默认as-needed
  13. // as-needed-仅在需要时在对象属性周围添加引号
  14. // consistent-如果一个对象中至少有一个属性需要引号,所有属性添加引号
  15. // preserve-保留对象属性中用户输入使用的引号
  16. quoteProps: "as-needed",
  17. // 在 JSX 中使用单引号而不是双引号<bool>,默认false
  18. jsxSingleQuote: false,
  19. // 在多行逗号分隔的句法结构中尽可能打印尾随逗号<es5|none|all>,默认es5
  20. // es5-在 ES5 中有效的尾随逗号(对象、数组等),TypeScript 的类型参数中没有尾随逗号
  21. // none-没有尾随逗号
  22. // all-尽可能以逗号结尾(包括函数参数和调用)。要运行以这种方式格式化的 JavaScript 代码需要一个支持 ES2017(Node.js 8+ 或现代浏览器)或下层编译的引擎。这还会在 TypeScript 的类型参数中启用尾随逗号(自 2018 年 1 月发布的 TypeScript 2.7 起支持)
  23. trailingComma: "es5",
  24. // 对象字面量中括号之间的空格<bool>,默认true
  25. bracketSpacing: true,
  26. // 将>放在多行 HTML(HTML、JSX、Vue、Angular)元素最后一行的末尾,而不是单独放在下一行(不适用于自关闭元素)<bool>,默认false
  27. // true:
  28. // <button
  29. // className="prettier-class"
  30. // id="prettier-id"
  31. // onClick={this.handleClick}>
  32. // Click Here
  33. // </button>
  34. // false:
  35. // <button
  36. // className="prettier-class"
  37. // id="prettier-id"
  38. // onClick={this.handleClick}
  39. // >
  40. // Click Here
  41. // </button>
  42. bracketSameLine: true,
  43. // 在唯一的箭头函数参数周围包含括号<always|avoid>,默认always
  44. // always-始终包含括号
  45. // avoid-尽可能省略括号
  46. arrowParens: "always",
  47. // Prettier 可以限制自己只格式化在文件顶部包含特殊注释(称为 pragma)的文件。这在逐渐将大型、未格式化的代码库过渡到 Prettier 时非常有用<bool>,默认false
  48. requirePragma: false,
  49. // Prettier可以在文件的顶部插入一个 @format 的特殊注释,以表明该文件已经被Prettier格式化过了。在使用 --require-pragma 参数处理一连串的文件时这个功能将十分有用。如果文件顶部已经有一个doclock,这个选项将新建一行注释,并打上 @format 标记<bool>,默认false
  50. insertPragma: false,
  51. // 超过最大宽度是否换行<always|never|preserve>,默认preserve
  52. // always-如果超过最大宽度换行
  53. // never-不要换行
  54. // preserve-按原样显示
  55. proseWrap: "preserve",
  56. // 指定 HTML、Vue、Angular 和 Handlebars 的全局空格敏感度<css|strict|ignore>,默认css
  57. // css-遵循CSS属性的默认值
  58. // strict-所有标签周围的空格(或缺少空格)被认为是重要的
  59. // ignore-所有标签周围的空格(或缺少空格)被认为是无关紧要的
  60. htmlWhitespaceSensitivity: "ignore",
  61. // vue文件script和style标签中是否缩进<bool>,默认false
  62. vueIndentScriptAndStyle: false,
  63. // 行尾换行符<lf|crlf|cr|auto>,默认lf
  64. endOfLine: "lf",
  65. // 控制 Prettier 是否格式化嵌入在文件中的引用代码<off|auto>,默认auto
  66. // auto–如果 Prettier 可以自动识别,则格式化嵌入代码
  67. // off-从不自动格式化嵌入代码
  68. embeddedLanguageFormatting: "auto",
  69. // 在 HTML、Vue 和 JSX 中强制执行每行单个属性<bool>,默认false
  70. singleAttributePerLine: false,
  71. };