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 代码风格

你可能感兴趣的:(2. phpstorm 搭配 PHP-CS-Fixer,格式化代码为 laravel 风格)