この ZetaSQL Formatter について紹介する前に、なぜ Formatter が必要なのかについて触れておきます。
一般的なコードを書いているときにある程度お作法があるのと同じように、以下のようなメリットがあると思っています。
- 人によって書き方の癖をある程度なくし、コードを読みやすくする
- コードが読みやすくなることで、レビューが行いやすくなり、ミスが発見しやすくなる
SQL などは、書き方が無限にあるので、ある程度書き方の癖をなくすることができれば、より良いと思っています。
以下の 2 つの formatter が知られています。
今回は、ZetaSQL Formatter の方を使ってやっていきたいと思います。
インストール方法
以下の手順でインストールすることができます。
使い方
CI でチェックできるようにする
CI でフォーマットにしたがっているかどうかを確認することができるようにする。
以下のコードを使うことで、GitHub Actions 上で実行することができます。
GitHub Actions
参考