ECSでコードを爆速にフォーマットする

正しいプログラムは

綺麗なコードに宿る

A good program resides in clean code.

pixiv Inc.

USAMI Kenta

WPHPerKaigi 2023 - PHPerのためのゆるいLT会 -

2022-04-18

お前誰よ

• うさみけんた (@tadsan) / Zonu.EXE / にゃんだーすわん
• ピクシブ株式会社 pixiv事業本部 エンジニア
• 最近はピクシブ百科事典(dic.pixiv.net)を開発しています
• Emacs Lisper, PHPer
• Emacs PHP Modeを開発しています (2017年-)
• プログラミング言語にちょっとこだわりのある素人

ふだんはEmacsとかPHPとかやってます

さて

綺麗なコード書いてますか？

コードの乱れは心の乱れ

正しいプログラムは綺麗なコードに宿る

綺麗なコードがモダーンなコード

美しいコードを書くのは靴を脱いで揃えるのと同じ

きたないコードは争いを生む

さあ美しいコードを書きましょう…

そう思いませんか？

どうやってコードをインデントする？

https://www.emacswiki.org/pics/static/TabsSpacesBoth.png より

均整でないソースコードの弊害

• チーム内での認知的な摩擦
• 同じリポジトリ内でも「ナワバリ」によってフォーマットの慣習が違う(!)
• コードレビューで「ここにスペースを入れてください」「ここで改行してくださ

い」などの不毛すぎる指摘をする羽目に…

• 「レビュー対応」というコードスタイルを直すだけの最悪のコミットが履歴に積

まれる (そういう些細な変更はfixupで直して…という意見はある)

誰がコードを書いても同じスタイルにしたい

Code Formatterコードスタイルを整形するツールの総称

フォーマッター導入待ったなし

退屈なことは機械にやらせよう

• ツールを呼び出すとフォーマッタが全てのコードを整形してくれる
• 人間が細かいところに気をつけながらコーディングしなくていい
• 最悪、人間がコードフォーマットをまったく把握してなくてもいい
• コミットする前にフォーマッターをかけてくれることだけ徹底してくれれば

それでだ

モダーンな言語の定義

言語標準のフォーマッターがある

go fmt dart format rustfmt

われらが最新最高言語PHPはどうだ

ただ普及してるフォーマッターはある

PHP-CS-Fixer PHP_CodeSiffer

＿人人人人人人＿＞ 二つある ＜‾Y^Y^Y^Y^Y‾

語ると長いが…設計思想の違いがある

(設定ファイル名もややこしかった…)

phpcs.xml vs .php_cs

まじめなプロジェクトではどちらかを選んで使う

二つのツールで同じような設定をしても結果が一致しなかったりする

≒ 似た設定をしてもフォーマット結果が競合しかねない

プロジェクト内でフォーマットツールを統一する必要がある

で、あんたはどっち派？

どうやってコードをインデントする？

CS-Fixer CodeSniffer

両方

もちつけ

tadsan

https://www.emacswiki.org/pics/static/TabsSpacesBoth.png より

そこで出てくるのが

ということで

ECS！

最速最強コードフォーマッター

Easy Coding Standard

ECS - The fastest and strongest code formatter

pixiv Inc.

USAMI Kenta

WPHPerKaigi 2023 - PHPerのためのゆるいLT会 -

2022-04-18

ECSってなあに?

• Tomas Votruba氏が開発しているスタイルチェック/フォーマットツール
• RectorというPHPStanベースのリファクタリングツールも作っている
• 内部的にPHP-CS-FixerとPHP_CodeSnifferを使っている
• 両方のツールに内蔵されたルールが使える！
• 並列実行してくれて爆速！ 一度実行したらキャッシュされるので待たせない
• ひとつのツール内で両方のルールを合せてくれるのでツール間で喧嘩しない

インストール方法

• 非常に簡単！
• composer require --dev symplify/easy-coding-standard:"^11.2"
• バージョン指定しないとインストール時にかなり待たされるので注意
• ./vendor/bin/ecs で実行できる
• 初回実行時に勝手に設定ファイル(ecs.php)が作成される
• PHP-CS-FixerやPHP_CodeSnifferのルールを指定する

清浄なコードベースを保つには

こきたないコードをマージさせない

• コードベース全体を (勇気をもって) 全フォーマットする
• メンバー全員に「コミットする直前に」必ずフォーマットすることを根付かせる
• CIでECSを呼び出してスタイルが合ってないファイルがあれば失敗させる
• 僕は編集中にテキストエディタから非同期フォーマットを実行するようにする

拡張を書きました

完璧主義のみなさんにも安心！

おまえら

pixivは

どうなのかって？

俺たちの戦いはこれからだ！！

続きはWebで