windows 环境下 PHPstorm 安装 PHP-CS-Fixer 及使用说明

标签: PHP-CS-Fixer  php

windows 环境下 PHPstorm 安装 PHP-CS-Fixer 及使用说明

PHP-CS-Fixer 官方 github 网站:https://github.com/FriendsOfPHP/PHP-CS-Fixer

官方文档安装已经有了详细的说明,这里我们采用 composer 的方式安装。

  1. composer 中引入 PHP-CS-Fixer
$ composer global require friendsofphp/php-cs-fixer

这是全局安装, composer 会自动跳转到根目录地址自动下载,中间下载速度可能会比较慢,如果断了链接它会在有效范围内自动重连,耐心等待一段时间。

  1. PHPstorm 中设置 PHP-CS-Fixer
    依次打开设置:File>Settings>Tools>External Tools
    tools
    点击 + 号新增。
    ceaete Tool
    参数说明:
参数 参考值 备注
Name php-cs-fixer 名称,任意填写
Description php-cs-fixer 规范代码 描述内容,任意填写
Program C:\Users\win10\AppData\Roaming\Composer\vendor\bin\php-cs-fixer.bat composer 安装的 php-cs-fixer 的 php-cs-fixer.bat 的路径
Arguments fix $FileDir$\$FileName$ --config=.php_cs.dist --using-cache=no config 参数后面的 .php_cs.dist 是 php-cs-fixer 的配置文件路径(即这个是文件的存放地址,根据你的实际环境来。)
Working Directory $Projectpath$ 工作目录,填写 phpstorm 的变量宏指令就可以

这里需要注意到是:$变量名$ 这种类型的格式属于 PHPstorm 宏变量指令(Macros)。

  1. 表格中的 Arguments 参数值中的 .php_cs.dist 是官方提供的格式化标准,其实就是 php 文件,可以从官方 github 仓库中下载。文件参数可以在自己创建项目的根目录下面建立,比如指令:fix $FileDir$\$FileName$ --config=E:\PhpStudy20180211\PHPTutorial\WWW\DolphinPHPV1.4.5\.php_cs.dist

目前官方 .php_cs.dist文件 ,这些格式化控制可以根据你自己的需要去定制 ,内容如下:

<?php

/*
 * This file is part of PHP CS Fixer.
 * (c) Fabien Potencier <[email protected]>
 *     Dariusz Rumiński <[email protected]>
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

$header = <<<'EOF'
This file is part of PHP CS Fixer.
(c) Fabien Potencier <[email protected]>
    Dariusz Rumiński <[email protected]>
This source file is subject to the MIT license that is bundled
with this source code in the file LICENSE.
EOF;

$finder = PhpCsFixer\Finder::create()
    ->exclude('tests/Fixtures')
    ->in(__DIR__)
    ->append([__DIR__.'/php-cs-fixer'])
;

$config = PhpCsFixer\Config::create()
    ->setRiskyAllowed(true)
    ->setRules([
        '@PHP56Migration' => true,
        '@PHPUnit60Migration:risky' => true,
        '@PhpCsFixer' => true,
        '@PhpCsFixer:risky' => true,
        'header_comment' => ['header' => $header],
        'list_syntax' => ['syntax' => 'long'],
    ])
    ->setFinder($finder)
;

// special handling of fabbot.io service if it's using too old PHP CS Fixer version
if (false !== getenv('FABBOT_IO')) {
    try {
        PhpCsFixer\FixerFactory::create()
            ->registerBuiltInFixers()
            ->registerCustomFixers($config->getCustomFixers())
            ->useRuleSet(new PhpCsFixer\RuleSet($config->getRules()))
        ;
    } catch (PhpCsFixer\ConfigurationException\InvalidConfigurationException $e) {
        $config->setRules([]);
    } catch (UnexpectedValueException $e) {
        $config->setRules([]);
    } catch (InvalidArgumentException $e) {
        $config->setRules([]);
    }
}

return $config;

每个文件格式化之后在头部会有一段头部注释,可以修改或者取消,取消则注释掉以下命令:

// 'header_comment' => ['header' => $header],

这样就完成了所有配置,通过 PHPstorm 程序格式化 php 文件,通过 Tools>External Tools 去选择。
php格式化工具调用
可以看到,使用如下:
php格式化


如果刚开始使用该工具,可能有疑问?PHPstorm 自带的格式化就挺好,为什么还要折腾。实际上,这个工具更多的是为了规范团队内部风格代码的统一,也是让我们更好的遵守 PSR 规范。


每次执行一次文件的代码检查,类似键入命令,只是配置到 IDE 上,帮我们自动完成了这个步骤。如果不需要配置 IDE 。可以如下直接使用:

多个规则可以用 “,” 隔开:

$ php php-cs-fixer.phar fix /path/to/dir # 对目录下面的 php 文件格式化
$ php php-cs-fixer.phar fix /path/to/file # 对单个 php 文件格式化
$ php php-cs-fixer.phar fix /path/to/project --rules=@PSR2 # 采用 PSR2 规范进行格式化

更多使用请参照官方文档

版权声明:本文为weixin_43930641原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/weixin_43930641/article/details/106238191

智能推荐

PHP开发环境的搭建——PHPStorm的安装使用

在win10系统搭建PHP的开发环境。 安装XAMPP XAMPP(Apache+MySQL+PHP+PERL)是一个功能强大的建站集成软件包。可以在window、Linux、Mac系统上安装使用 windows系统的安装 下载地址:https://www.apachefriends.org/index.html 安装好后,如果桌面没有快捷方式,则在安装目录下找到 打开后会出现这个控制界面,点击s...

Windows环境下Qwt安装和使用

声明:本文并非原创,因为感觉大佬整理非常不错,所以自己收藏一下。 来源网址:https://www.jianshu.com/p/d6fb96c3e6b0 一 准备环境 1. 准备Qt Creator 如果你没有Qt开发环境,请先去官方网站下载一个,选择离线安装的windows版本,安装很简单。由于这个版本已经集成了MinGw,所以你都不需要单独安装MinGW。配置到你的环境变量。 离线安装版.pn...

PHP - MAC下PhpStorm安装调试环境xdebug

今天下午一直在捣鼓如何用PhpStorm进行调试,查找了许多资料,零零碎碎的,所以自己弄篇文章记录一下步骤。 安装xdebug 使用brew安装xdebug,语法如下 到https://xdebug.org/download.php下载xdebug,版本必须是与php对应的版本 如果你不知道该下载哪个版本的xdebug,xdebug网站有可以检测的地方(xdebug检测),把你的phpinfo()...

【PHP】wamp集成环境下PHPStorm安装XDebug插件

新手看这一篇就够了,包教包会。 如果你用的是wamp集成开发环境,恭喜你,你成功了一小半,如果不是,也没关系,方法大同小异,只不过一些文件放的地方不一样而已。 需要准备的东西: 1. xdebug.dll这个库文件 如果你装的是wamp环境,你自带的就有这个文件,路径:wamp\bin\php\php5.5.12\zend_ext 如果你不是,那么你就乖乖的去下吧:http://xdebug.or...

PhpStorm+PlantUML安装使用

PlantUML 是基于贝尔实验室发明的 Graphviz 所想即所得软件,废话不多说, 直奔主题 环境依赖: graphvize 软件 下载连接:http://www.graphviz.org/Download_windows.php phpstorm 软件:下载地址 https://www.jetbrains.com/phpstorm/download/ 具体操作 打开phpstorm , 添...

猜你喜欢

(C++)Leetcode狂刷200题——标签“动态规划篇--简单难度10道(两道重复) #198. 打家劫舍

第五道、#198. 打家劫舍 你是一个专业的小偷,计划偷窃沿街的房屋。每间房内都藏有一定的现金,影响你偷窃的唯一制约因素就是相邻的房屋装有相互连通的防盗系统,如果两间相邻的房屋在同一晚上被小偷闯入,系统会自动报警。 给定一个代表每个房屋存放金额的非负整数数组,计算你 不触动警报装置的情况下 ,一夜之内能够偷窃到的最高金额。 示例 1: 输入:[1,2,3,1] 输出:4 解释:偷窃 1 号房屋 (...

8. Linux mint 安装Tim、网盘、wps等常用软件

Linux mint 安装 常用软件 1. 安装网易云音乐(官网直接有安装包) 可以听歌享受一下的旅程 2.安装tim 上面直接引入原文的开头了, 教程其实原文已经非常详细,还有一些问题的注意,都已经讲的分明白这里直接引入原文链接了 2019年wine QQ最完美解决方案 软件 Github 地址 不过看完原文可能需要花一些时间,如果只是想快速安装QQ的话,按照下面步骤就可以了 Tim的下载地址:...

Android Service与IntentService测试 带你理清两者的细节

目录 Service IntentService Service 布局文件中定义了四个按钮,分别设置了对应的监听事件:startService(),stopService(),bindService(),unbindService()。 在 MyService 的回调方法中打印该方法名以及对应线程。 测试: 点击顺序: Start -> Stop 可知 Service 的几个回调方法都是在 ...

京东抢购服务高并发实践

声明:本位来自京东张开涛的微信公众号(kaitao-1234567),授权CSDN转载,如需转载请联系作者。 作者:张子良,京东高级开发工程师,在京东负责抢购后端服务系统架构和开发工作。 责编:钱曙光,关注架构和算法领域,寻求报道或者投稿请发邮件[email protected],另有「CSDN 高级架构师群」,内有诸多知名互联网公司的大牛架构师,欢迎架构师加微信qshuguang2008申请入群,...

Cobbler实战

Cobbler,自动化运维之部署神器,可实现网卡启动批量安装系统,节省时间提高装机效率。 环境:CentOS7.6 安装Cobbler #yum install -y epel-release #yum clean && yum makecache #yum -y install dhcp tftp-server rsync xinetd httpd cobbler cobbler...