zig fmt：コードを整形する

Zigには組み込みフォーマッターが用意されているため、すべてのプロジェクトでコードの見た目を統一できます。zig fmtコマンドを使うと、コードがZigの標準的なスタイルに書き換えられます。

zig fmtにファイルを指定すると、そのファイルをディスク上で直接フォーマットし、インデント、空白、改行を自動的に整えます。

directoryを指定すると、zig fmtはその中を再帰的に走査し、見つかったすべての.zigファイルを整えます。1つのコマンドでプロジェクト全体をフォーマットできます。

議論すべきstyle optionsはありません。Zig fmtには固定された1つのスタイルしかないため、チームやコードベースでのフォーマットに関する議論を終わらせられます。

--checkフラグを指定すると、フォーマットされていないファイルを報告してエラー終了しますが、ファイルを編集することはありません。検証に最適です。

--checkは失敗を示すexit codeを返すため、継続的インテグレーションに組み込んで、フォーマットされていないコードを自動的に拒否できます。

--stdinを指定すると、zig fmtはパイプで渡されたテキストをフォーマットし、結果を出力します。エディターでは、保存時のフォーマットに利用されています。

ほとんどのエディターは、saveすると自動的にzig fmtを実行します。コードの形が瞬時に整うため、レイアウトを気にする必要がなくなります。

対象範囲を覚えておきましょう。zig fmtが修正するのはlayoutだけです。名前の変更やロジックのバグの検出は行いません。それらはコンパイラーの仕事です。

zig fmtは、リテラルやコメント内のline breaksをほぼそのまま残します。そのため、意図したレイアウトを消さずに構造を整えられます。

コミットするbeforeに、毎回フォーマッターを実行しましょう。整然と一貫した差分によってレビューが速くなり、履歴全体も誰にとっても読みやすくなります。

CIでは、ファイルを変更せずに、コードがフォーマットされていない場合にビルドを失敗させたいとします。どのコマンドが適切でしょうか。

zig fmtについて学びました。標準スタイルは1つで、ファイルやフォルダーをフォーマットでき、CIでは--checkを使えます。また、保存時にエディターで実行すれば、コードを手軽にきれいに保てます。🧹