Psalm

使用 Composer 安装 Psalm

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

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

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

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

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

单击 ，位于 composer.json 编辑器边栏的包记录旁边，将带您进入相应的 设置 页面，您可以在此 手动配置 Psalm。

重置 Psalm 配置

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

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

2. 点击 列表旁的 配置。

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

   

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

PhpStorm 将重新执行 Psalm 配置，从而在 composer.json 中应用更改。

在 PhpStorm 中配置 Psalm

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

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

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

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

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

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

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

通过 Composer 启用 Psalm 检查

您可以在 composer.json 的 scripts 部分中包含有关 Psalm 配置文件的信息。 当您 安装 或 更新 项目依赖项时，指定的配置文件将被检测到，并且 Psalm 验证 检查将自动启用。

如果在 scripts 的 composer.json 部分中未指定配置文件，PhpStorm 将另外检查项目根目录以定位具有 psalm.xml 或 psalm.xml.dist 默认名称的规则集。

• 在 scripts 的 composer.json 部分中，将 psalm Psalm 启动命令添加到某个叶子元素中。

  提供 --config 参数和配置文件的路径：

  "scripts": { "psalm": "vendor/bin/psalm --config=psalm.xml" }

在检查设置中启用 Psalm 验证

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

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

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

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

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

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

初始化 Psalm 缓存

虽然 Psalm 验证 检查可以在单个文件上运行，但 Psalm 仍会对整个项目进行一次检查。 在大型项目中，首次运行 Psalm 时等待其响应可能会超过 工具进程超时 字段中指定的限制，该字段位于 Psalm 对话框中。 在这种情况下，PhpStorm 会显示错误消息：

• 单击 初始化缓存 链接，让 Psalm 对整个项目进行一次检查，并在配置的 缓存目录 中生成缓存。 如果您使用的是 远程解释器 ，请确保将缓存目录设置为远程环境中可访问的位置。

• 单击 从 Psalm 分析中排除 链接，将当前文件添加到 忽略文件 列表。

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

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

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

3. 在 问题工具窗口 中查看检查结果。 Psalm 报告的错误和警告会带有前缀，以区分它们与 PhpStorm 内部检查。

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

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

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

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

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