PHP_CodeSniffer
在此页面启用并配置 PHP_CodeSniffer 质量工具。
项目 | 描述 |
|---|---|
配置 | 从列表中选择所需的解释器。 该列表包含所有当前配置的本地和远程 PHP 解释器。 如需更多信息,请参阅 配置本地 PHP 解释器 和 配置远程 PHP 解释器。 单击下拉列表右侧的 |
显示被忽略的文件 | 单击以打开 PHP_CodeSniffer 忽略的文件 对话框,其中列出了 PHP_CodeSniffer 跳过的文件。 PhpStorm 建议在检查期间,当等待 PHP_CodeSniffer 的响应超过 工具进程超时 字段中指定的限制时,将新文件添加到列表中。 这样做是为了防止处理速度变慢。 对于每个文件,PhpStorm 会显示其名称和位置。
|
检查带有扩展程序的文件 | 提供一个以逗号分隔的文件扩展名列表,这些扩展名应由 PHP_CodeSniffer 检查。 |
将警告显示为... | 要让 PHP_CodeSniffer 除了报告错误外还报告警告,请选中复选框并从列表中选择 严重程度。 清除复选框以仅报告错误并抑制警告报告。 |
显示 sniff 名称 | 选中复选框以在编辑器或 检查结果 中显示相应的 sniff 名称,以及检查摘要。 |
已安装的标准路径 | 如果您依赖于自定义的第三方编码标准(例如, Coder 或 Joomla Coding Standards ),则需要在使用 PHP_CodeSniffer 之前将其集成。 为此,请选中 已安装的标准路径 复选框,单击 |
编码标准 | 指定要应用的编码标准。
|
运行模式 | 配置 PHP_CodeSniffer 触发代码分析的频率:
|
空闲阈值(毫秒): | 定义代码修改后到 PHP_CodeSniffer 运行前的延迟时间(以毫秒为单位)。 |
最小间隔(毫秒): | 定义对同一文件两次连续 PHP_CodeSniffer 运行之间必须经过的最短时间(以毫秒为单位)。 这可防止在频繁保存文件或输入密集时 PHP_CodeSniffer 运行过于频繁。 |
PHP_CodeSniffer 对话框
单击 ,打开 配置 列表旁边的 PHP_CodeSniffer 页面上的对话框。
使用此对话框配置所用的 PHP 解释器、PHP_CodeSniffer 可执行文件的路径以及 PHP_CodeSniffer 的行为。 有关更多信息,请参见 PHP_CodeSniffer。
项目 | 描述 |
|---|---|
解释器窗格 | 对话框的左侧窗格显示用于 PHP_CodeSniffer 的默认 PHP 解释器。 要添加不同的解释器,请单击 |
PHP_CodeSniffer 路径 | 在此字段中,指定 PHP_CodeSniffer 脚本的位置:Windows 使用 phpcs.bat ,Linux 和 macOS 使用 phpcs 。 PhpStorm 会检测 要检查指定的 phpcs.bat 或 phpcs 路径是否确保 PhpStorm 与 PHP_CodeSniffer 之间的交互,即工具可以从 PhpStorm 启动并且 PhpStorm 会接收其问题报告,请单击 验证 按钮。 此验证等同于运行 |
工具进程超时 | 在此字段中,指定您希望 PhpStorm 等待 PHP_CodeSniffer 返回结果的时间。 如果超时,进程将被终止以防止过多的 CPU 和内存使用。 这使您可以根据计算机的配置和使用的规则集微调 PHP_CodeSniffer 的处理行为。 |
PHP 代码美化和修复工具设置 | 在此区域中,在 phpcbf 的路径 字段中提供 PHP Code Beautifier and Fixer 工具的自定义路径。 请手动输入路径或点击 PHP Code Beautifier and Fixer 允许您自动修复 PHP_CodeSniffer 检测到的许多错误。 |