obliviousharmony/vscode-phpcs-integration

为obliviousharmony.vscode-php-codesniffer VS Code扩展提供的自定义PHPCS集成。

3.0.2 2024-09-17 22:51 UTC

README

将PHP_CodeSniffer集成到VS Code。

此扩展使用平台特定的可执行设置中定义的PHPCS版本。通过使用自定义报告,我们可以生成诊断、代码操作和文档格式,充分利用VS Code的可用功能。

配置

除非您配置它,否则此扩展不会检查任何文件。

标准 (phpCodeSniffer.standard)

此下拉菜单选择将使用的编码标准。有一些选项,当选中时,将改变扩展的行为。

禁用

此选项将阻止扩展检查任何文档。

默认

允许PHPCS决定应用于文档的标准。如果已配置,它将使用默认标准,否则,它将在工作区根目录和所有父目录中尝试找到。

自动

当选中此选项时,此选项将导致扩展搜索适用的编码标准文件(.phpcs.xmlphpcs.xml.phpcs.xml.distphpcs.xml.dist)。扩展从文档文件夹开始,遍历父目录直到工作区根目录。如果扩展无法找到文件,则不执行任何操作并输出错误。

自定义

此选项将使用phpCodeSniffer.standardCustom输入的内容作为标准。这可以是自定义规则集的名称,或者自定义标准文件的路径。如果给出相对路径,它将基于文档所在的工作区根目录(无标题文档使用第一个根目录)。

可执行文件 (phpCodeSniffer.exec.linuxphpCodeSniffer.exec.osxphpCodeSniffer.exec.windows)

此文本输入允许设置平台特定PHPCS可执行文件的路径。如果给出相对路径,它将基于文档所在的工作区根目录(无标题文档使用第一个根目录)。任何添加到可执行文件后面的参数或选项将自动传递给它。

您还可以设置phpCodeSniffer.autoExecutable选项,以便扩展自动搜索可执行文件。这通过在文档目录中查找{vendor-dir}/bin/phpcs(Windows上的{vendor-dir}\bin\phpcs.bat)文件,然后遍历到工作区文件夹来实现。如果在自动搜索失败时找不到,它将回退到显式选项。

文件和文件夹排除 (phpCodeSniffer.exclude)

此glob模式数组允许您排除文件和文件夹的检查。虽然扩展确实尊重您的编码标准中的任何文件规则,但此选项允许您定义额外的规则。

保存时自动修复

而不是在这里提供一个选项,此扩展鼓励您使用VS Code内置的editor.formatOnSave选项

{
    "[php]": {
        "editor.formatOnSave": true,
        "editor.defaultFormatter": "obliviousharmony.vscode-php-codesniffer"
    }
}

在容器化开发环境中使用 (phpCodeSniffer.autoloadPHPCSIntegration)

如果您正在使用容器作为您的开发环境,我们强烈建议使用VS Code 的远程开发扩展之一。然而,如果这不可能,我们已提供了一个Composer包,其中包含了用于与PHPCS集成的文件。您必须将这些文件与PHPCS(全局或按项目)一起安装,以便扩展能正常工作。安装完包后,当启用 phpCodeSniffer.autoloadPHPCSIntegration 时,将使用此包而不是内置集成。