Prettier学习:命令行工具

在最初的时候,我们在 pacakge.json 里面做了一个命令行的配置:

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

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

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

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

看一个命令

prettier –write .

  • –write 就是配置选项,本来 prettier 格式化完成后是在控制台输出的, –write 代表写入到原本的文件,–write 还有一个别名就是 -w

  • . 是第二个参数,代表的是要格式化的路径,正常情况下你可以写一个文件或者写一个目录,例如

  • 上面的 . 表示当前目录以及子目录下所有支持的文件,全部格式化之后写回原来的文件。

ShellScript
prettier --write file.js # 只格式化 file.js 这个文件
prettier -w "src/**/*.js" # 格式化 src 目录下面的所有的 js 文件(包含 src 下面的子目录)

接下来介绍一些常见的 options

  • –check:该配置参数用于检查文件是否已经按照 prettier 规则进行了格式化,如果匹配的路径下面的所支持的文件已经全部被格式化,那么会输出 All matched files use Prettier code style!,否则会显示哪些文件还没有被 prettier 格式化

  • --find-config-path and –config:指定配置文件的路径,正常情况下,prettier 会自动去找项目下面的配置文件。但是如果你的配置文件不在项目中,而是在其他的位置,那么这个也是可以指定的

ShellScript
prettier --config ~/configs/prettier.json --write .
  • –no-config: 不读取任何配置文件,直接使用 prettier 里面默认的配置。
  • –ignore-path:指定忽略文件的路径,正常情况下也是在当前项目中去寻找,但是如果你的忽略文件不在项目中,而是在其他位置,也是可以指定的
ShellScript
prettier --ignore-path ~/configs/ignore/.prettierignore --write .
  • 规则的配置:上一节课介绍了的 prettier 所有的规则都可以在 CLI 命令里面进行配置的。不过这种只适用于单独的一两个规则,如果你的规则比较多还是应该单独拿一个配置文件来配置规则。

评论

《“Prettier学习:命令行工具”》 有 1 条评论

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注