PHP CS Fixer

使用 Composer 安装 PHP CS Fixer

当您使用 Composer 安装 PHP CS Fixer 时，PhpStorm 会自动下载必要的脚本，将其注册到 IDE 中，并可选地启用和配置相应的 代码检查。

1. 在 composer.json 中，将 friendsofphp/php-cs-fixer 依赖项记录添加到 require 或 require-dev 键中。 要获取包名称和版本的代码补全，请按 Ctrl+Space。

2. 请执行以下操作之一：

   • 单击编辑器面板顶部的 安装 快捷链接。

   • 如果启用了 未安装的 Composer 包 检查，PhpStorm 将突出显示当前未安装的声明依赖项。 按 Alt+Enter 并选择是要安装特定依赖项还是一次性安装所有依赖项。

单击 ，位于 composer.json 编辑器边栏中的包记录旁边，将带您到相应的 设置 页面，您可以在其中 手动配置 PHP CS Fixer。

重置 PHP CS Fixer 配置

PHP CS Fixer 初始配置完成后，在 composer.json 中的进一步修改将不会影响检查配置。 要应用更新的更改，请重置 PHP CS Fixer 配置。

1. 在 设置 对话框（Ctrl+Alt+S ）中，导航到 PHP | 质量工具 | PHP CS Fixer。

2. 点击 列表旁的 配置。

3. 在打开的 PHP CS Fixer 对话框中，清空 PHP CS Fixer 路径 字段。

   

4. 通过单击 composer.json 编辑器面板顶部的 更新 更新项目的 Composer 依赖项。 有关更多信息，请参阅 更新依赖项。

PhpStorm 将重新执行 PHP CS Fixer 配置，从而应用 composer.json 中的更改。

在 PhpStorm 中配置 PHP CS Fixer

当您 使用 Composer 安装 PHP CS Fixer 时，PhpStorm 会自动检测到 PHP CS Fixer 的可执行文件位于 vendor/bin 文件夹中，并设置系统路径中配置的 PHP 解释器来运行它。

在 设置 （Ctrl+Alt+S ）|PHP | 质量工具 | PHP CS Fixer 中，您可以更改默认的 PHP 解释器，设置路径为 手动下载并安装的 PHP CS Fixer 可执行文件 ，或添加一些选项以在 PhpStorm 中运行 PHP CS Fixer 时传递给它。

• 配置 ：在此字段中，您可以更改默认的 PHP 解释器和 PHP CS Fixer 可执行文件的路径。

  1. 要仅更改解释器，请从项目中配置的本地和远程 PHP 解释器列表中选择所需的项目。

  2. 要更改 PHP CS Fixer 可执行文件的路径，或同时更改解释器和路径，请单击 ，位于 配置 列表旁边，以打开 PHP CS Fixer 对话框，并按照 PHP CS Fixer 对话框 参考页面上的说明编辑字段。

• 显示被忽略的文件 ：使用此设置 从 PHP CS Fixer 验证检查中排除文件。 有关更多信息，请参阅 质量工具 参考页面。

• 选项 ：在此区域中，添加选项以 将 PHP CS Fixer 作为 PhpStorm 检查运行。 按照 PHP CS Fixer 参考页面 中的说明编辑字段。

通过 Composer 启用 PHP CS Fixer 检查

您可以在 scripts 部分中包含有关默认和自定义 PHP CS Fixer 规则集的信息，位于 composer.json 。 当您 安装 或 更新 项目依赖项时，指定的规则集将被检测到，并且 PHP CS Fixer 验证 检查将自动启用。

如果在 scripts 部分的 composer.json 中未指定规则集，PhpStorm 将另外检查项目根目录以定位具有 .php_cs 或 .php_cs.dist 默认名称的规则集。 如果文件存在，它将被自动选为检查的 自定义 规则集。

• 在 scripts 部分的 composer.json 中，将 php-cs-fixer PHP CS Fixer 启动命令添加到其中一个叶子元素中。

  提供 --rules 参数以表示使用的编码标准。 例如，添加以下记录将把编码标准设置为 PSR1：

  "scripts": { "php-cs-fixer": "php-cs-fixer --rules=@PSR1" }

  或者，提供 --config 参数和规则集文件的路径，这将把编码标准设置为 自定义：

  "scripts": { "php-cs-fixer": "php-cs-fixer --config=./.php_cs" }

在检查设置中启用 PHP CS Fixer 验证

1. 在 设置 对话框（Ctrl+Alt+S ）中，点击 检查 下的 编辑器。

2. 在打开的 Inspections 页面上，展开 PHP | 质量工具 节点并选中 PHP CS Fixer 验证 旁边的复选框。

   

3. 在页面的右侧窗格中，配置 PhpStorm 如何处理 PHP CS Fixer 检查输出：

   1. 范围 ：选择 范围 以限制检查的应用范围。

   2. 严重性 ：选择检查的 严重程度。 所选值决定了 PhpStorm 将如何对待检测到的差异，并在 检查结果 中呈现。

   3. 编辑器中的高亮显示 ：选择检查检测到的问题在编辑器中的突出显示方式。

1. 在主菜单中，进入 代码 | 检查代码.

2. 在打开的 指定检查范围 对话框中，从列表中选择检查配置文件，或单击 配置… 打开 检查 对话框并配置新配置文件。

   您还可以单击 配置… 检查在所选检查配置文件范围内将应用哪些修复，并确保启用了 PHP CS Fixer 验证 检查。

3. 在 问题工具窗口 中查看检查结果。 PHP CS Fixer 报告的错误和警告以 PHP CS Fixer: 为前缀，以将其与 PhpStorm 内部检查区分开来。

   

使用快速修复修复问题

检测到问题后，PhpStorm 会根据 PHP CS Fixer 的 检查设置 突出显示它。

1. 将光标放在检测到的问题上，然后单击 ，或按 Alt+Enter。

2. 从弹出菜单中选择 PHP CS Fixer：修复整个文件。 请注意，这将修复当前文件中检测到的所有问题。

您还可以 以批处理模式 检测问题，或通过 代码重新格式化 自动修复它们。

通过代码重新格式化修复问题

您可以通过运行 重新格式化代码 操作修复 PHP CS Fixer 检测到的问题。

1. 在 质量工具设置 中将 PHP CS Fixer 设置为外部格式化器。

   为此，在 设置 对话框（Ctrl+Alt+S ）中，转到 PHP | 质量工具 并在 外部格式化工具 部分中选择 PHP CS Fixer。

   

2. 将 重新格式化代码 应用于所需的文件或项目范围：

   • 对于编辑器中打开的代码片段或文件，从主菜单中选择 代码 | 重新设置代码格式 或按 Ctrl+Alt+L。

   • 对于 Project 工具窗口中选定的文件、目录或文件组，从上下文菜单中选择 重新设置代码格式 或按 Ctrl+Alt+L。

1. 将您的编码标准的根目录放在 项目根目录 下。

2. 将 PHP CS Fixer 配置为 一个 PhpStorm 检查。

3. 指定您的编码标准。

4. 确保在 Inspections 页面顶部选择了一个 项目配置文件。 此类配置文件保存在特定项目的 .idea 目录中（例如， $PROJECT_DIR$/.idea/inspectionProfiles ）。 欲了解更多信息，请参阅 检查配置文件。

5. 在 版本控制 页面上的 设置 对话框中，确保 .idea 目录已被 置于版本控制 下。

1. 在 设置 对话框（Ctrl+Alt+S ）中，导航到 PHP | 质量工具 | PHP CS Fixer。

2. 点击 显示被忽略的文件 链接。

   • 要添加文件，请单击 并在打开的对话框中找到所需的文件。

   • 要从列表中删除文件并让 PHP CS Fixer 再次处理它，请选择该文件并单击 。

   • 要从列表中删除所有文件，请单击 。