Skip to content

Prettier

介绍

Prettier 是一个流行的代码格式化工具,旨在确保代码风格的一致性。它支持多种编程语言和文件类型,并且可以与许多编辑器和 IDE 集成。

快速上手

1. 安装

bash
npm i -D prettier

2. 生成配置文件

支持的配置文件
  • .prettierrc
  • .prettierrc.json
  • ...
json
{
  "$schema": "https://json.schemastore.org/prettierrc",
  "htmlWhitespaceSensitivity": "ignore",
  "printWidth": 120,
  "quoteProps": "consistent",
  "semi": false,
  "singleQuote": true
}
配置项说明
  • htmlWhitespaceSensitivity: 设置 HTML 中的空白符敏感度
  • printWidth: 每行代码的最大长度
  • quoteProps: 对象属性的引号使用规则
  • semi: 是否在语句末尾添加分号
  • singleQuote: 使用单引号而不是双引号
  • ...

3. 在 package.json 中配置脚本

json
{
  "scripts": {
    "format": "prettier --write src/**/*.{js,ts,json,css,md}"
  }
}

忽略代码

忽略文件或文件夹

创建或编辑项目根目录下的 .prettierignore 文件,添加你想要忽略的路径。例如:

bash
node_modules
build
dist
src/ignore-this-file.js
*.min.js

忽略代码片段

js
// prettier-ignore
const foo    =      {   bar:    "baz" }

基于 MIT 许可发布