Docker × Laravel コードを自動整形するコンテナを構築する

PHP CS Fixer とは

PHP CS Fixer (PHP Coding Standards Fixer) とは、その名の通りPHPのコードをコーディング規約に沿うよう修正してくれるツールです。

前提

• 最強のLaravel開発環境をDockerを使って構築する【新編集版】
• https://github.com/ucan-lab/docker-laravel

当記事は上記の記事の補足になる記事です。

docker-compose.ymlの編集

docker-compose.yml

services:
  cs:
    image: herloct/php-cs-fixer
    volumes:
      - ./backend:/project

services.cs を追記します。

コマンド

# 自動整形しない(差分表示のみ)
$ docker-compose run cs fix --dry-run -v --diff --diff-format udiff .

# 自動整形する
$ docker-compose run cs fix -v --diff --diff-format udiff .

Makefile

コマンドが長いのでMakefileを用意しておくと良いです。

dry-cs:
	docker-compose run cs fix --dry-run -v --diff --diff-format udiff .
fix-cs:
	docker-compose run cs fix -v --diff --diff-format udiff .

下記のコマンドで実行できるようになります。

$ make dry-cs
$ make fix-cs

参考

• Laravel PHP-CS-Fixer のルール設定
• お手元のPHPファイルをphp-cs-fixerでチェックする