date
Jul 18, 2023 01:07 AM
type
status
slug
summary
tags
category
updated
Oct 24, 2024 12:52 PM
icon
password
Prettier是什么
Prettier是一个代码格式化工具,它支持JavaScript等编程语言的代码格式化。它是一个“有态度”的代码格式化工具,它支持“Opinionated”的代码格式化,即你必须认同它的观点,按照它说的做。Prettier的特点是:自动化、一致性、可配置性、支持多种语言、易于集成。
Prettier使用
- VSCode
VSCode中下载一个插件
Prettier - Code formatter
插件,安装之后点击设置来进行代码配置- 配置文件
这个需要项目配合,由于我是JS代码开发项目。所以我使用的环境是npm包管理器。需要执行以下命令安装插件
安装完成之后在项目根目录新建
.prettierrc.json
文件,然后写入如下的内容下面给出官方的选项以及可选的配置值
忽略格式化配置文件
在根目录下配置新建
.prettierignore
配置文件。里面写入你不想格式化的文件,格式和.gitignore
类似。配置文件优先级
Prettier使用cosmiconfig来支持配置文件。这意味着你可以通过以下方式配置Prettier(优先级从高到低):
- 在你的package.json文件中的"prettier"键。
- 用JSON或YAML编写的.prettierrc文件。
- .prettierrc.json、.prettierrc.yml、.prettierrc.yaml或.prettierrc.json5文件。
- .prettierrc.js、.prettierrc.cjs、prettier.config.js或prettier.config.cjs文件,使用module.exports导出一个对象。
- .prettierrc.toml文件。
配置文件将从被格式化的文件的位置开始解析,并在文件树中向上搜索,直到找到(或找不到)配置文件。Prettier故意不支持任何形式的全局配置。这是为了确保当一个项目被复制到另一台计算机时,Prettier的行为保持不变。否则,Prettier将无法保证团队中的每个人都能获得相同的一致结果。
常见问题
- 配置不生效
- 重启下VSCode试试
- 查看自己是不是安装了其他的格式化工具。设置Prettier为格式化工具