原创

phpstorm配置php-cs-fixer代码格式化插件

前言

PHPer 的日常开发大多数使用的 IDE 都是 phpstorm 进行开发的,phpstorm 功能强大,支持 git 管理代码,今天说的就是 phpstorm 中怎么对自己编写的代码进行格式化,使其遵循 PSR 开发规范。

一、安装php-cs-fixer

php-cs-fixer 可以使用 composer 进行全局安装,如图:
file

composerphp-cs-fixer

1、composer 全局安装

composer global require friendsofphp/php-cs-fixer

配置环境变量:

export PATH="$PATH:$HOME/.composer/vendor/bin"

2、Macbrew 安装

brew install php-cs-fixer

3、直接下载进行使用

wget https://cs.symfony.com/download/php-cs-fixer-v2.phar -O php-cs-fixer

给予可执行权限

sudo chmod a+x php-cs-fixer

移动到执行文件夹下

sudo mv php-cs-fixer /usr/local/bin/php-cs-fixer

二、使用方法

1、对某个目录下面的php文件格式化

php php-cs-fixer fix /path/to/dir

2、对单个php文件格式化

php php-cs-fixer fix /path/to/file

3、采用PSR2规范进行格式化

php-cs-fixer fix /path/to/project --rules=@PSR2

三、结合 phpstrom 进行使用

1、打开 phpstrom,点击设置 -> Tools -> External Tools

得到如图界面:
phpstrom 设置
file

2、点击左下角的添加按钮,如图:

添加工具
file

3、弹出一个设置框,把 php-cs-fixer 的一些参数放置进去,如图:

php-cs-fixer 的参数设置(这里的位置是我项目里自带的,按照教程为准)
file

具体配置:

Program:填写 php-cs-fixer 执行文件的位置

:如果不知道 php-cs-fixer 的位置在哪里,可以在终端输入

which php-cs-fixer

即可拿到 php-cs-fixer 的可执行文件位置,如图:
file

查找 php-cs-fixer 的位置

Arguments:填写运行 php-cs-fixer 后面附加的参数,也就是:

php php-cs-fixer **fix /path/to/file**

加粗的这一部分,我们这里填写单个文件,如果想要一次性格式化整个文件夹或者整个项目可以自行百度搜索一下

这里的填写为:

fix $FileDir$/$FileName$

Working directory:这是填写工作目录的,一般工作目录都是为当前项目的根目录,所以这里填写的是 :

$ContentRoot$

到这里基本的配置就完成了,点击ok,然后点击 Apply 使其生效,返回代码界面,点开你要格式化的代码文件,点击顶部 Tools -> External Tools -> php-cs-fixer

如图:
没办法截图,手机拍的,凑合着看哈
file

点击后成功格式化的界面如图:
file

可以明显的看到文件有改变,查看一下格式确实清晰很多。

4、设置快捷键

可能觉得每次运行一次都要点击一次 Tools -> External Tools -> php-cs-fixer 太麻烦了,那这里就教你怎么设置快捷键。

打开 phpstrom设置 -> Keymap -> External Tools -> 点击你刚刚设置的php-cs-fixer工具 。如图:
file

设置快捷键

双击该工具,点击 Add Keyboard Shortcut,然后点击弹窗右边的加号(+),设置你想要的快捷键,如图:
file

设置快捷键

然后点击 OK -> Apply 然后返回到文件内,测试你设置的快捷键吧!

结语

代码不规范,PR 两行泪,且行且珍惜。

正文到此结束