前端项目规范化2:prettier所有配置项详细介绍(基于最新版2.8.7)

prettier的配置文件支持很多种格式,prettier的编辑器插件如vscode-prettier插件,会优先使用配置文件,如果没有,再使用插件本身的prettier配置

如下是一个.prettierrc.js,列出了目前所有支持的prettier配置属性

module.exports = {
  // 指定prettier将换行的行长<int>,默认80
  printWidth: 80,

  // 指定每个缩进级别的空格数<int>,默认2
  tabWidth: 2,

  // 用制表符而不是空格缩进行<bool>,默认false
  useTabs: false,

  // 在语句末尾添加分号<bool>,默认true
  semi: true,

  // 使用单引号而不是双引号<bool>,默认false
  singleQuote: true,

  // object对象中key值是否加引号<as-needed|consistent|preserve>,默认as-needed
  // as-needed-仅在需要时在对象属性周围添加引号
  // consistent-如果一个对象中至少有一个属性需要引号,所有属性添加引号
  // preserve-保留对象属性中用户输入使用的引号
  quoteProps: 'as-needed',

  // 在 JSX 中使用单引号而不是双引号<bool>,默认false
  jsxSingleQuote: false,

  // 在多行逗号分隔的句法结构中尽可能打印尾随逗号<es5|none|all>,默认es5
  // es5-在 ES5 中有效的尾随逗号(对象、数组等),TypeScript 的类型参数中没有尾随逗号
  // none-没有尾随逗号
  // all-尽可能以逗号结尾(包括函数参数和调用)。要运行以这种方式格式化的 JavaScript 代码需要一个支持 ES2017(Node.js 8+ 或现代浏览器)或下层编译的引擎。这还会在 TypeScript 的类型参数中启用尾随逗号(自 2018 年 1 月发布的 TypeScript 2.7 起支持)
  trailingComma: 'all',

  // 对象字面量中括号之间的空格<bool>,默认true
  bracketSpacing: true,

  // 将>多行 HTML(HTML、JSX、Vue、Angular)元素放在最后一行的末尾,而不是单独放在下一行(不适用于自关闭元素)<bool>,默认false
  // true:
  // <button
  //   className="prettier-class"
  //   id="prettier-id"
  //   onClick={this.handleClick}>
  //   Click Here
  // </button>
  // false:
  // <button
  //   className="prettier-class"
  //   id="prettier-id"
  //   onClick={this.handleClick}
  // >
  //   Click Here
  // </button>
  bracketSameLine: true,

  // 在唯一的箭头函数参数周围包含括号<always|avoid>
  // always-始终包含括号
  // avoid-尽可能省略括号
  arrowParens: 'always',

  // Prettier 可以限制自己只格式化在文件顶部包含特殊注释(称为 pragma)的文件。这在逐渐将大型、未格式化的代码库过渡到 Prettier 时非常有用<bool>
  requirePragma: false,

  // Prettier可以在文件的顶部插入一个 @format的特殊注释,以表明改文件已经被Prettier格式化过了。在使用 --require-pragma参数处理一连串的文件时这个功能将十分有用。如果文件顶部已经有一个doclock,这个选项将新建一行注释,并打上@format标记<bool>,默认false
  insertPragma: false,

  // 超过最大宽度是否换行<always|never|preserve>,默认preserve
  // always-如果超过最大宽度换行
  // never-不要换行
  // preserve-按原样显示
  proseWrap: 'preserve',

  // 指定 HTML、Vue、Angular 和 Handlebars 的全局空格敏感度<css|strict|ignore>,默认css
  // css-遵循CSS属性的默认值
  // strict-所有标签周围的空格(或缺少空格)被认为是重要的
  // ignore-所有标签周围的空格(或缺少空格)被认为是无关紧要的
  htmlWhitespaceSensitivity: 'css',

  // vue文件script和style标签中是否缩进<bool>,默认false
  vueIndentScriptAndStyle: false,

  // 行尾换行符<lf|crlf|cr|auto>,默认lf
  endOfLine: 'lf',

  // 控制 Prettier 是否格式化嵌入在文件中的引用代码<off|auto>,默认auto
  // auto–如果 Prettier 可以自动识别,则格式化嵌入代码
  // off-从不自动格式化嵌入代码
  embeddedLanguageFormatting: 'auto',

  // 在 HTML、Vue 和 JSX 中强制执行每行单个属性<bool>,默认false
  singleAttributePerLine: true
};

  • 1
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值