PHP
VisualStudioCode

VS CodeでPHPの開発をするのに導入した拡張機能

アドベントカレンダー5日目になりました。(All About的には3日目ですが)

Qiita初投稿の@cflat0528です。

私は入社してからPHPの開発をVisual Studio Codeを利用して行っているのですが、入社してから現在まで利用して、便利だと感じたVS Codeの拡張機能について書きたいと思います。


1. PHP Intelephense

PHPのコード補完、参照の検索や定義への移動などいろいろな機能を提供してくれます。

類似の拡張機能にPHP IntelliSenseが存在します。

導入を検討していた時に、useを利用したときの補完がこちらのほうがいい、といったことが書かれており、実際比較してみてよさそうだったのでこちらを利用しています。

phpintelephense.gif


2. php cs fixer

エディタでのファイルの保存時などにphp-cs-fixerを使ってPHPのファイルのフォーマットを行ってくれます。

.php_csや.php_cs.distにルールを定義しておけばそれにそって整形をしてくれるため、プロジェクト内で共有しておくといいと思います。

PHP-CS-Fixer自体の利用方法はGitHubのページを参照。

phpcsfixer.gif


3. phpcs

PHP Code Snifferを用いて、ソースコード内のルールに沿わない箇所に警告を表示してくれます。

基本は上記のphp cs fixerで自動整形されますが、PSR-2の文字数のソフトリミット120文字などは整形できなかったためこちらを導入しています。

スクリーンショット 2018-12-04 23.49.14.png


4. PHP DocBlocker

以下のようにDocコメントの入力を補完してくれます。

タイプヒントをつけておくとそれに応じて@param@returnも追加してくれるので便利です。

また、User.settingsにphp-docblocker.authorの設定をしておくと@authorを書いた際に自身の名前とメールアドレスを自動補完もしてくれます。

phpdoc.gif


5. Bracket Pair Colorizer

対応する括弧に同じ色をつけてくれる拡張機能です。

設定をすれば現在のカーソルがある箇所の括弧の強調表示もしてくれます。

下記画像では括弧の強調表示のためにUser SettingsにbracketPairColorizer.activeScopeCSSなどの設定を行っております。各設定の詳細はMarketPlaceを参照。

スクリーンショット 2018-12-03 23.32.45.png


6. Dot ENV

Laravelで利用している.envファイルにシンタックスハイライトをつけてくれます。

All AboutではフレームワークとしてLaravelを利用しているため導入しました。

スクリーンショット 2018-12-03 22.05.09.png


7. Material Icon Theme

下記画像のように初期アイコンよりアイコンが綺麗になります。

Visual Codeのアイコンはvscode-iconsとかSetiとかいろいろあるのでお好みで。

スクリーンショット 2018-12-02 22.07.21.png


8. Vim

操作に慣れていれば導入するだけで幸せになれます。

正直なところWindowsでVS code利用時にこの拡張機能を導入するともともとのショートカットキーとvimの操作が衝突して少し辛いような気がします。


おわりに

使用歴が浅いので今回書きませんでしたが、GitLensとかもコミットの比較を行ったりコミット履歴を見たりするのにはおすすめですし、PHP DebugもXdebugの導入が少々面倒ですが、デバッグ作業が格段に楽になると思います。

今回便利だと感じたものを上げたらよく利用されているものばかりになりましたが、拡張機能も紹介記事も山程あるので色々試してみるのも面白いと思います。