Prettier 参数配置

本文详细介绍了Prettier的配置项,包括printWidth、tabWidth、quotes等关键设置,旨在帮助开发者实现代码风格的一致性和可读性。通过调整这些配置,可以优化JSX、箭头函数等语法的格式化效果,提升团队开发效率。
摘要由CSDN通过智能技术生成

prettierrc.js

module.exports = {
  // 一行最多 100 字符
  printWidth: 100,
  // 关闭 tab 缩进
  useTabs: false,
  // 使用 2个tab 缩进
  tabWidth: 2,
  // 行尾需要有分号
  semi: true,
  // 使用单引号
  singleQuote: true,
  // 对象key是否使用引号 <as-needed|consistent|preserve>
  // as-needed 仅在需要的时候使用
  // consistent 有一个属性需要引号,就都需要引号
  // preserve 保留用户输入的情况
  quoteProps: 'preserve',
  // jsx 使用单引号代替双引号
  jsxSingleQuote: false,
  // 末尾不需要逗号 <es5|none|all>
  trailingComma: 'es5',
  // 大括号内的首尾需要空格
  bracketSpacing: true,
  // jsx 标签的反尖括号需要换行
  jsxBracketSameLine: false,
  // 箭头函数,只有一个参数的时候,也需要括号 <always|avoid>
  arrowParens: 'avoid',
  // 每个文件格式化的范围是文件的全部内容
  rangeStart: 0,
  rangeEnd: Infinity,
  // 不需要写文件开头的 @prettier 用于逐步过渡大型项目中未被格式化的代码标识
  requirePragma: false,
  // 不需要自动在文件开头插入 @prettier 用于逐步过渡大型项目中未被格式化的代码标识
  insertPragma: false,
  // 使用默认的折行标准
  proseWrap: 'preserve',
  // 根据显示样式决定 html 要不要折行 <css|strict|ignore>"
  htmlWhitespaceSensitivity: 'css',
  // 换行符使用 lf 结尾  <lf|crlf|cr|auto>
  endOfLine: 'lf',
  embeddedLanguageFormatting: 'off',
};

.prettierignore 排除不编译的文件、也可在对应文件顶部添加注释排除

Prettier一个流行的代码格式化工具,它支持多种编程语言和编辑器。在项目中配置 Prettier 可以通过多种方式进行,包括但不限于配置文件、命令行参数和编辑器插件等。下面是使用 Prettier 的基本配置步骤: 1. 安装 Prettier:可以通过 npm 或 yarn 将 Prettier 安装为项目依赖或全局安装。 ``` npm install --save-dev prettier # 或者 yarn add --dev prettier ``` 2. 创建配置文件:Prettier 会自动查找项目根目录下的 `.prettierrc` 文件,也可以使用其他命名的配置文件,如 `.prettierrc.js`、`.prettierrc.json` 或 `.prettierrc.yaml`。配置文件可以是 JSON、YAML 或 JavaScript 格式。 一个基本的 `.prettierrc` 配置示例如下: ```json { "singleQuote": true, "semi": true, "useTabs": false, "tabWidth": 2, "trailingComma": "none", "printWidth": 80, "endOfLine": "auto" } ``` 3. 使用命令行格式化代码:安装并配置Prettier 后,可以通过命令行使用 `prettier` 命令来格式化文件或目录。 ``` npx prettier --write . ``` 4. 集成编辑器:大多数流行的代码编辑器,如 VSCode、Sublime Text 和 Atom,都有支持 Prettier 的插件,可以通过编辑器的插件市场进行安装。安装插件后,通常需要在编辑器的设置中启用 Prettier配置相应的文件保存时自动格式化。 Prettier配置项有很多,包括但不限于: - `singleQuote`:是否使用单引号。 - `semi`:是否在语句末尾加分号。 - `useTabs`:是否使用制表符进行缩进。 - `tabWidth`:一个制表符代表的空格数。 - `trailingComma`:是否在多行对象或数组末尾添加逗号。 - `printWidth`:一行代码的最大长度。 - `endOfLine`:文件的行结束符。 对于更深入的了解,可以通过查看 Prettier 的官方文档来获得更多的配置选项和使用示例。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值