登录
php cs fixer
分类:工具软件 访问:31 下载量:0

软件介绍

更新时间:2025-06-09

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}作为工作区根目录路径。executablePathexecutablePathWindowsconfig可以使用~/作为用户主目录路径。

自动格式化设置

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

"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配置文件示例:

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支持我们:

Buy Me A Coffee

本站所有资源都是由网友投稿发布,或转载各大下载站, 请自行检测软件的完整性!

本站所有资源仅供学习与参考,请勿用于商业用途,否则 产生的一切后果将由您自己承担!

如有侵权请联系我们删除下架,联系方式:study_golang@163.com

最新教程

查看更多
  • Golang云原生架构师课程
    Golang云原生架构师课程
    Go是一门并发支持、垃圾回收的编译型系统编程语言;本课程转载自哔哩哔哩:https://www.bilibili.com/video/BV1Mh411M7A
  • MySQL数据管理之备份恢复案例解析视频教程
    MySQL数据管理之备份恢复案例解析视频教程
    《MySQL数据管理之备份恢复案例解析视频教程》MySQL是一个开放源码的小型关联式数据库管理系统,目前MySQL被广泛地应用在Internet上的中小型网站中。由于其体积小、速度快、总体拥有成本低,尤其是开放源码这一特点,许多中小型网站为了降低网站总体拥有成本而选择了MySQL作为网站数据库。
  • MySQL索引优化解决方案
    MySQL索引优化解决方案
    本套课程是根据MySQL索引的设计理念与数据结构、索引使用场景、索引分类、索引运用场景、索引性能分析、查询优化、MySQL索引的慢查询等组成,主要讲述了MySQL索引优化的解决方案,非常适合有MySQL使用基础或者有一定工作经验的同学。课程讲解了解决大数量查询慢的问题、如何编写一个高效的SQL、查询语句应该如何优化、索引的实现原理是什么、索引又应该如何优化...等诸多SQL索引优化的难点和面试点。
  • 极客学院Docker视频教程
    极客学院Docker视频教程
    Docker是PaaS提供商dotCloud开源的一个基于LXC的高级容器引擎,源代码托管在Github上,基于go语言并遵从Apache2.0协议开源。Docker自2013年以来非常火热,无论是从github上的代码活跃度,还是各大厂商的支持,都使Docker成为了时下最受关注的技术,甚至微软都声称在下一代WindowsServer中集成对Docker的支持。所以我们收集了《极客学院Docke
  • Golang进阶实战编程
    Golang进阶实战编程
    本课程是在《Go语言基础视频》基础之上录制的,是Go语言基础的后半部分。包括包的管理,IO操作,Go语言最大的亮点:高并发,goroutine,channel,反射等。本视频主要为了帮助Go语言的初学者,从零到一的快速入门。学完本套课程,可以学会如果通过包管理Go项目,并发模型,以及并发实现,channel通道如何传递数据,反射等等。
  • JavaScript极速入门
    JavaScript极速入门
    本套课程将帮助大家迅速掌握JavaScript这门高端的、动态的、弱类型编程语言。知识点简单明了,让你学习0压力,适合新手观看学习......