快速上手 章节,在 pacakge.json 里面做了一个命令行的配置:

"scripts": {
    // ...
    "format": "prettier --write ./src"
},

关于 Prettier 究竟支持哪些 CLI 命令,可以在官网中看到:https://prettier.io/docs/en/cli.html

关于 CLI 命令有一个最基本的格式:

prettier [options] [file/dir/glob...]
  • options: 格式化的选项
  • file/dir/glob:要格式化的文件或者目录,glob 模式匹配

上面的命令 prettier --write ./src

  • --write 就是配置选项,本来 Prettier 格式化完成后是在控制台输出的,--write 代表写入到原本的文件,--write 还有一个短别名是 -w
  • ./src 是第二个参数,代表要格式化的路径,正常情况下可以写一个文件或者写一个目录,例如:
    • file.js:只格式化 file.js 这个文件
    • src/**/*.js:格式化 src 目录下面的所有的 js 文件(包含 src 的子目录)

介绍一些常见的 options

  • --check:该配置参数用于检查文件是否已经按照 Prettier 规则进行了格式化,如果匹配的路径下面的所支持的文件已经全部被格式化,那么会输出 “All matched files use Prettier code style!”,否则会显示哪些文件还没有被 Prettier 格式化
  • --config:指定配置文件的路径,正常情况下,Prettier 会自动去找项目下的配置文件。但是如果配置文件不在项目根目录,而是在其他的位置,就可以指定
    • prettier --config ~/configs/prettier.json --write .
  • --no-config: 不读取任何配置文件,直接使用 Prettier 默认的配置。
  • --ignore-path:指定忽略文件的路径,正常情况下也是在当前项目中去寻找,但是如果忽略文件不在项目中,而是在其他位置,也是可以指定的
    • prettier --ignore-path ~/configs/ignore/.prettierignore --write .
  • 规则配置:上一节课 介绍了的 Prettier 所有的规则都可以在 CLI 命令里面进行配置。不过这种只适用于单独的一两个规则,如果规则比较多还是应该单独用配置文件来配置规则。