php cs fixer 0.3.21

PHP CS Fixer for Visual Studio Code：自动格式化PHP代码的最佳扩展

PHP CS Fixer for Visual Studio Code是一款专门为PHP开发者设计的扩展工具，旨在帮助您自动格式化PHP代码，确保您的代码符合最新的编码标准和最佳实践。

安装指南

要安装此扩展，请打开命令面板（F1），选择“扩展：安装扩展”，然后搜索“PHP CS Fixer”。

使用方法

您可以通过多种方式使用PHP CS Fixer：

• 命令面板：F1 -> php-cs-fixer: fix this file
• 键盘快捷键：Alt+Shift+F（VS Code默认格式化快捷键）
• 右键菜单：选择“格式化文档”或“格式化选中内容”
• 在资源管理器中右键菜单：选择“php-cs-fixer: fix”

安装PHP CS Fixer

• 此扩展已包含php-cs-fixer.phar文件，适合初学者，但性能可能较低。
• 如果您希望自己安装php-cs-fixer，请参考php-cs-fixer安装指南。

配置选项

您可以根据需求调整PHP CS Fixer的配置：

{
    "php-cs-fixer.executablePath": "php-cs-fixer",
    "php-cs-fixer.executablePathWindows": "",   //例如：php-cs-fixer.bat
    "php-cs-fixer.onsave": false,
    "php-cs-fixer.rules": "@PSR12",
    "php-cs-fixer.config": ".php-cs-fixer.php;.php-cs-fixer.dist.php;.php_cs;.php_cs.dist",
    "php-cs-fixer.allowRisky": false,
    "php-cs-fixer.pathMode": "override",
    "php-cs-fixer.ignorePHPVersion": false,
    "php-cs-fixer.exclude": [],
    "php-cs-fixer.autoFixByBracket": false,
    "php-cs-fixer.autoFixBySemicolon": false,
    "php-cs-fixer.formatHtml": false,
    "php-cs-fixer.documentFormattingProvider": true
}

配置技巧

如果您同时使用其他格式化工具（如Prettier），可能遇到自动保存或其他功能的冲突。可以通过以下设置避免这种情况：

"[php]": {
    "editor.defaultFormatter": "junstyle.php-cs-fixer"
},

安装php-cs-fixer的方法

• 使用Composer安装：

"php-cs-fixer.executablePath": "php-cs-fixer"

• 在Windows上可以尝试使用：

"php-cs-fixer.executablePath": "php-cs-fixer.bat"

• 使用phar文件：

"php-cs-fixer.executablePath": "/full/path/of/php-cs-fixer.phar"

您还可以为Windows指定特定的路径：

"php-cs-fixer.executablePathWindows": "C:/path/to/php-cs-fixer.bat"

executablePath可以使用${workspaceFolder}作为工作区根目录路径。executablePath、executablePathWindows和config可以使用~/作为用户主目录路径。

自动格式化设置

您可以配置此扩展在保存时自动执行格式化：

"php-cs-fixer.onsave": true

您还可以同时格式化HTML内容：

"php-cs-fixer.formatHtml": true

配置文件设置

您可以从分号分隔的值列表中选择配置文件：

"php-cs-fixer.config": ".php-cs-fixer.php;.php-cs-fixer.dist.php;.php_cs;.php_cs.dist"

配置文件可以放置在工作区根目录、.vscode文件夹或其他任何文件夹中：

"php-cs-fixer.config": "/full/config/file/path"

相对路径仅在打开工作区文件夹时被考虑。

配置文件示例

以下是一个.php-cs-fixer.php配置文件示例：

<?php

return (new PhpCsFixer\Config())
    ->setRules([
        '@PSR12' => true,
        'array_indentation' => true,
        'array_syntax' => ['syntax' => 'short'],
        'combine_consecutive_unsets' => true,
        'class_attributes_separation' => ['elements' => ['method' => 'one',]],
        'multiline_whitespace_before_semicolons' => false,
        'single_quote' => true,

        'binary_operator_spaces' => [
            'operators' => [
                // '=>' => 'align',
                // '=' => 'align'
            ]
        ],
        // 其他规则...
    ])
    ->setLineEnding("\n");

自动修复

• 通过大括号，当按下}键时，自动修复括号内的代码。
• 通过分号，当按下;键时，自动修复当前行的代码。

更多信息

如需更多信息，请访问：https://github.com/FriendsOfPHP/PHP-CS-Fixer

许可证

本扩展遵循MIT许可证。

支持我们

如果您喜欢这个扩展，请考虑通过Buy Me A Coffee支持我们：