2. phpstorm 搭配 PHP-CS-Fixer,格式化代码为 laravel 风格

PHP-CS-Fixer


PHP-CS-Fixer 是一个编码风格修复工具。全称 PHP Coding Standards Fixer。

它可以修复你的代码,以遵循 PSR-1、PSR-2 标准。

它可以修复你的代码,以遵循其他由社区驱动的标准(例如Laravel、Symfony)。

官方文档:https://cs.symfony.com

github:https://github.com/FriendsOfPHP/PHP-CS-Fixer

laravel 代码风格


可能大家在看 laravel 源码的时候,也曾经和我有一样的疑惑: 为什么逻辑非运算符(!)后面总是跟着一个空格? 为什么最后一个 return 语句前面总是有一个换行?

其实这些都属于 laravel 作者个人的编码习惯。

如果你也想让自己的代码风格,和 laravel 框架一致,不妨试试 PHP-CS-Fixer。


image.png

具体操作步骤


1. 安装 composer (直接在系统上安装,非虚拟机。)

已经安装好 composer 就忽略这一步

$ curl -sS https://getcomposer.org/installer | php
$ mv composer.phar /usr/local/bin/composer

参考文档:https://docs.phpcomposer.com/00-intro.html#Installation-*nix

2. 通过 composer 去安装 PHP-CS-Fixer
$ composer global require friendsofphp/php-cs-fixer

参考文档:https://github.com/FriendsOfPHP/PHP-CS-Fixer

3. 把 PHP-CS-Fixer 添加到系统环境变量

这个步骤不作赘述,大家根据自己的操作系统 (MacOS / Windows) 来

4. 把 PHP-CS-Fixer 添加到 phpstorm

打开 php 设置,选择 External Tools,点击 + 号,添加一个 External Tool

  • Name
取一个名字,随意取就OK
  • Program
1. MacOS 系统使用 which php-cs-fixer 命令查看,然后复制过来
$ which php-cs-fixer
/Users/digua/.composer/vendor/bin/php-cs-fixer

2. Windows 系统使用 where.exe 命令查看,然后复制过来
$ where.exe php-cs-fixer
$ C:\Users\user\AppData\Roaming\Composer\vendor\bin\php-cs-fixer
  • Parameters
把这个值粘贴进去 (也可以使用后面的 Insert marco 按钮手动设置 )
fix -v "$FileDir$/$FileName$"
  • Working Directory:
把这个值粘贴进去 (也可以使用后面的 Insert marco 按钮手动设置 )
$ProjectFileDir$
image.png
5. 给 PHP-CS-Fixer 设置一个快捷键,方便使用
image.png
6. 恭喜。在任意一个 php 文件里面,摁下刚刚设置的快捷键,你的代码就变成 laravel 风格了。
7. 写在最后

之所以摁下快捷键,代码就变成 laravel 风格,是因为:

摁下快捷键,phpstorm 在项目根目录执行了命令
$ php-cs-fixer fix -v "$FileDir$/$FileName$" 
这个命令读取了项目根目录的 .php_cs.dist 文件
而 .php_cs.dist 文件里面配置好了 laravel 代码风格
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,684评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,143评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,214评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,788评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,796评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,665评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,027评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,679评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,346评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,664评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,766评论 1 331
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,412评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,015评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,974评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,073评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,501评论 2 343