格式化规则

作为一个格式化代码的工具,最重要的就是格式化依据的规则是什么?以及如何配置这些规则。

在官网的 https://prettier.io/docs/en/options.html 页面就可以看到所有的格式化规则。

配置文件

配置文件的作用是做规则自定义。Prettier 提供了多种配置方式,并且多种配置方式之间会有一个优先级(优先级从高到低):

  1. 命令行选项:在 package.json 中配置 script 脚本命令的时候,是可以添加配置参数的
    • "format": "prettier --no-semi --print-width 50 --write ."
  2. 文件中配置:单独创建一个配置文件。正常情况下,一个项目中写一个配置文件就可以了,但是如果不小心有多个配置文件,优先级顺序如下(由高到低):
    • .prettierrc.jsprettier.config.js
    • .prettierrc.yaml.prettierrc.yml
    • .prettierrc.json
    • .prettierrc
  3. pacakge.json 中进行配置:可以在 package.json 文件中添加一个配置选项 prettier 进行配置
  4. 编辑器配置:许多代码编辑器可以安装和 Prettier 相关的插件,之后可以在编辑器的 settings -> extensions 里面进行配置
  5. Prettier 默认配置:默认配置一般优先级是最低,但是却是最常用的,因为这套配置可能是行业最佳实践了。

ignore

类似于 .gitignore,Prettier 也支持 .prettierignore,用来排除一些文件或者目录,也就是说,出现在 .prettierignore 里面的文件或者目录不会被 Prettier 进行处理。

例如:

# 忽略所有 .min.js 结尾的文件
*.min.js

# 忽略整个 build 目录
/build/

# 忽略 node_modules 目录
node_modules/

# 忽略特定文件
my-special-file.js

关于 .prettierignore 具体的路径写法,可以参阅 .gitignore 的写法:https://git-scm.com/docs/gitignore/zh_HANS-CN