PHP Mess Detector with suppressions 1.4.0

提升PHP代码质量：使用带抑制功能的PHP Mess Detector VSCode扩展

在开发PHP项目时，代码质量是至关重要的。使用带抑制功能的PHP Mess Detector VSCode扩展，您可以轻松分析并优化您的PHP代码。本文将详细介绍如何安装、配置和使用该扩展，以确保您的PHP项目更加清洁、安全和高效。

功能亮点：

• 自动分析： 在保存PHP源代码时，自动使用PHP Mess Detector进行分析，无需额外设置。
• 自定义规则： 可以自定义使用哪些PHPMD规则，并支持自定义规则集文件。
• 抑制问题： 提供如何抑制检测到的问题的指导，提升开发体验。
• 无缝集成： 如果您的系统已安装PHP，无需额外设置即可使用该扩展。

安装指南：

要安装该扩展，请按F1，输入ext install PCODE-pl.vscode-phpmd-suppress并按回车。

使用内置的PHPMD PHAR：

要使用内置的PHP Mess Detector，您需要确保PHP已添加到系统PATH中。可以通过在命令行中输入php -v来测试。如果返回了PHP版本信息，说明您可以直接使用该扩展。

使用自定义PHPMD PHAR或可执行文件：

如果您希望自定义默认的PHP Mess Detector命令，例如通过Composer全局安装或PHP位于其他位置，可以通过phpmd.command设置进行自定义。

配置选项：

• phpmd.command：自定义PHP Mess Detector命令。如果为空，将使用内置的PHPMD PHAR，需要PHP在PATH中可用。

  • 示例：

    "phpmd.command": "C:/Users/{USER}/AppData/Roaming/Composer/vendor/bin/phpmd.bat"

    或

    "phpmd.command": "php C:/path/to/phpmd.phar"

• phpmd.unsafeCommand：从工作区设置中自定义PHP Mess Detector命令，默认情况下被忽略，除非phpmd.unsafeCommandEnabled设置为true。

  • 警告：使用此设置可能导致远程代码执行攻击，请谨慎操作。

• phpmd.unsafeCommandEnabled：启用从工作区设置中自定义PHP Mess Detector命令，默认值为false。此设置不能在工作区设置中更改。

  • 警告：启用此设置可能导致远程代码执行攻击，请谨慎操作。

• phpmd.rules：自定义使用的PHPMD规则集文件。可以通过VS Code的工作区设置控制每个工作区的规则或规则集文件。

  • 示例：

    "phpmd.rules": "cleancode"

    或

    "phpmd.rules": "cleancode,codesize"

    或

    "phpmd.rules": "C:/path/to/phpmd_config.xml"

• phpmd.verbose：开启或关闭详细日志记录。所有日志条目可以在VS Code的输出面板中查看。

  • 示例：

    "phpmd.verbose": true

系统要求：

• PHP_Depend >= 2.0.0
• PHP >= 5.3.9
• PHP XML扩展

故障排除：

• 通过设置开启详细日志记录并检查输出。
• 在gitter上提问。
• 发现bug？提交问题（请包含日志）。

贡献代码：

如果您发现了bug或可以帮助添加新功能，您可以通过拉取请求提交代码。拉取请求被接受的要求包括：

• 为所有新代码添加单元测试（代码覆盖率不得下降）。
• 为所有“事物”添加JSDoc注释。
• 确保没有TSLint违规（请参阅tslint.json）。

在贡献之前，请确保您熟悉VSCode的语言服务器开发，并使用yarn安装所有依赖。

历史记录：

请参阅client/CHANGELOG.md。

致谢：

• PHPMD背后的团队。
• Microsoft VSCode团队提供的VSCode和vscode-languageserver-node。
• Quentin Dreyer提供的OS homedir替换解决方案。
• Shane Smith提供的拼写修正。
• RyotaK报告的phpmd.command安全问题。

通过使用带抑制功能的PHP Mess Detector VSCode扩展，您可以确保您的PHP项目保持高质量和安全性，从而提高开发效率和代码可维护性。