一篇文章读懂 Prettier CLI 命令：从基础到进阶 （3）

Prettier 命令行工具

Prettier 提供了一个强大的命令行界面 (CLI)，允许用户通过命令行来格式化代码。在 package.json 中，你可以配置一个脚本来运行 Prettier，例如：

"scripts": {
  "format": "prettier --write ."
}

这个脚本会使用 Prettier 来格式化当前目录及其子目录中的所有支持的文件，并将更改写回原文件。

基本命令格式

Prettier 的 CLI 命令的基本格式如下：

prettier [options] [file/dir/glob ...]

• options：格式化的选项。
• file/dir/glob：要格式化的文件、目录或通配符。

常见的命令选项

1. –write 或 -w：

   • 描述：将格式化后的代码写入原文件。
   • 示例：

     prettier --write file.js
     prettier -w "src/**/*.js"
     

2. –check：

   • 描述：检查文件是否已经按照 Prettier 规则进行了格式化。如果所有文件都已格式化，则输出 All matched files use Prettier code style!；否则，显示哪些文件还没有被格式化。
   • 示例：

     prettier --check .
     

3. –find-config-path 和 –config：

   • –find-config-path：显示找到的配置文件路径。
   • –config：指定配置文件的路径。
   • 示例：

     prettier --config ~/configs/prettier.json --write .
     

4. –no-config：

   • 描述：不读取任何配置文件，直接使用 Prettier 默认的配置。
   • 示例：

     prettier --no-config --write .
     

5. –ignore-path：

   • 描述：指定忽略文件（.prettierignore）的路径。
   • 示例：

     prettier --ignore-path ~/configs/ignore/.prettierignore --write .
     

6. 规则的配置：

   • 描述：可以在 CLI 命令中直接配置 Prettier 的规则。不过，这种方式只适用于少量规则的快速配置。对于大量规则，建议使用单独的配置文件。
   • 示例：

     prettier --single-quote --semi false --print-width 80 --write .
     

示例

假设你有一个项目结构如下：

my-project/
├── src/
│   ├── index.js
│   └── utils/
│       └── helper.js
├── package.json
└── .prettierrc

你可以在 package.json 中添加以下脚本：

{
  "name": "my-project",
  "version": "1.0.0",
  "scripts": {
    "format": "prettier --write .",
    "check": "prettier --check ."
  }
}

然后你可以使用以下命令：

• 格式化整个项目：

  pnpm run format
  

• 检查项目中的文件是否已经格式化：

  pnpm run check
  

• 使用特定配置文件进行格式化：

  prettier --config ~/configs/prettier.json --write .
  

• 忽略特定文件并格式化：

  prettier --ignore-path .gitignore --write .
  

• 不使用配置文件，直接使用默认配置进行格式化：

  prettier --no-config --write .
  

通过这些命令，你可以灵活地使用 Prettier 来格式化你的代码，确保代码风格的一致性和可读性。

原文地址：https://blog.csdn.net/weixin_53961451/article/details/144070881

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！