phpfmt - PHP formatter 1.2.41

phpfmt for Visual Studio Code：提升PHP代码质量的必备工具

phpfmt是Visual Studio Code的强大PHP格式化扩展，旨在帮助开发者轻松格式化PHP代码，提升代码的可读性和一致性。无论您是个人开发者还是团队协作，都可以通过phpfmt快速实现代码风格的统一。

安装指南：

1. 打开命令面板（F1），选择“Extensions: Install Extension”。
2. 搜索“phpfmt”并安装。
3. 注意：您的机器上需要安装PHP 5.6或更高版本才能运行此插件。

使用方法：

• 通过命令面板（F1）选择“phpfmt: Format This File”。
• 使用键盘快捷键Ctrl Shift I（Visual Studio Code默认格式化快捷键）。
• 通过右键上下文菜单选择“Format Document”或“Format Selection”。

保存时自动格式化：

phpfmt支持Visual Studio Code的editor.formatOnSave设置。您可以根据需要启用或禁用此功能：

// 设置默认值
"editor.formatOnSave": false,
// 启用PHP语言的保存时格式化
"[php]": {
  "editor.formatOnSave": true
}

常见问题解答：

• 如何在路径中有空格时使用phpfmt.php_bin？
  将路径用引号包裹，例如：

  {
    "phpfmt.php_bin": "\"C:\\Program Files\\php\\php.exe\""
  }

  建议将php.exe所在目录添加到Windows的PATH环境变量中。如果仍然无法工作，请参考相关问题和Stack Overflow上的讨论。

• 如何在启用PSR2时使用制表符而不是空格？
  PSR2要求使用4个空格进行缩进，但如果您喜欢PSR2但不喜欢4个空格的缩进，可以添加以下配置：

  {
    "phpfmt.passes": [
      "PSR2KeywordsLowerCase",
      "PSR2LnAfterNamespace",
      "PSR2CurlyOpenNextLine",
      "PSR2ModifierVisibilityStaticOrder",
      "PSR2SingleEmptyLineAndStripClosingTag",
      "ReindentSwitchBlocks"
    ],
    "phpfmt.exclude": [
      "ReindentComments",
      "StripNewlineWithinClassBody"
    ],
    "phpfmt.psr2": false
  }

• fmt.phar（phpfmt本身）是否仍在维护？
  我们现在使用driade的phpfmt8中的fmt.stub.php，它非常新。

配置选项：

phpfmt提供了丰富的配置选项，允许您根据需求定制代码格式化风格。以下是一些关键配置：

• phpfmt.php_bin：指定PHP可执行文件路径，默认值为"php"。
• phpfmt.use_old_phpfmt：是否使用支持PHP 5.6的旧版fmt.phar，默认值为false。
• phpfmt.psr2：是否启用PSR2风格，默认值为true。

支持的转换：

phpfmt支持多种代码转换，帮助您优化PHP代码结构和风格。通过命令面板（F1）选择“phpfmt: List Transformations”查看所有支持的转换。

贡献代码：

欢迎开发者参与phpfmt的开发和维护。您可以通过以下步骤运行和测试扩展：

• 在Visual Studio Code中打开此仓库。
• 在调试侧边栏中选择“Launch Extension”运行扩展。
• 在调试侧边栏中选择“Launch Tests”运行测试。

通过使用phpfmt for Visual Studio Code，您可以轻松提升PHP代码的质量和一致性，提高开发效率。