Vim

Vim + ALE でPHPの自動整形

どうも、シローです。

以前、Vim + ALEでJavaScriptの自動整形(https://shiro-secret-base.com/?p=178)についての記事を書きました。

今回はそれのPHP版です。

ALEについて

Vimのプラグインで、コードのシンタックスチェックをやってくれます。

https://github.com/dense-analysis/ale

インストール

~/.vimrcにて「Plugin」でインストールします。

~/.vimrc

記述したら、vim上で「:PlugInInstall」を実行してインストール。

詳しくは https://github.com/dense-analysis/ale#installation を参照。

 

 

ただ、コードの自動整形はデフォルトではやってくれません。

そのため、「php-cs-fixer」コマンドをインストールする必要があります。

php-cs-fixerとは

php-cs-fixerはphpのコードをチェックして余分なスペースや改行などがあれば整形してくれるコマンドです。

インストール

curlでインストール

composerでインストール

homebrewでインストール

 

ターミナルで、「php-cs-fixer」というコマンドが使えていればOKです。もし実行できていない場合は、パスが通っていないかをチェックしてみたらいいかもです。

また、「php-cs-fixer」のコマンドがある場所もALEから実行するために必要なので、「which」コマンドで確認します。

詳しくは、https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/master/doc/installation.rst を参照。

~/.vimrcにALEでphp-cs-fixerを使う記述を追加

~/.vimrcにてphp-cs-fixerをALEから利用するための記述はこちらです。

~/.vimrc

ここまでできれば、あとはPHPのファイルを編集して効果を実感できると思います。

一応、こんな感じで整形してくれます

僕のローカル環境ではこのようにスペースを開けたり、適宜改行もやってくれてます。

まとめ

  • php-cs-fixerはPHPの構文をチェックして整形してくれる
  • vimでコード保存時にphp-cs-fixerを利用するためには
    • php-cs-fixerコマンドを実行できるようにする(インストール、パスを通す)
    • vimのaleプラグインでfixerにphp_cs_fixer(「 _ 」なのに注意)

参考になればと思います、おっしまい^^

  • この記事を書いた人

シロー

Webシステムの開発のお仕事をさせて頂いております。 フリーランスの日常、Web開発に関する情報を発信しています。 趣味はゲーム、映画鑑賞、個人サービスを作ることです。

-Vim

© 2021 Shiro's secret base