Tips: ローカルで保存しているSQLファイルを一括で formatterにかける

これは何

3000文字Tipsイベントの参加記事です。

ローカルで保存しているSQLを、eslintと同じようにフォーマットにかけたいと思っていました。
これを実現する方法を紹介します。

sql-formatterをinstallする

sql-formatterは特定のSQLファイルをフォーマットできるツールです。しかしこれだけでは複数ファイルを一括でフォーマットにかけることはできません。
まずはsql-formatterをinstallだけしておきます。

yarn add -D sql-formatter

複数のファイルに一気にフォーマットをかけるスクリプトを用意する

複数のファイルをフォーマットにかけるようにするために、シェルスクリプトを用います。
以下のようなスクリプトファイルを用意してください。

format.sh

files=($(ls path/to/files/**/*.sql))
for file in ${files[@]}; do
  echo ${file}
  yarn run sql-formatter ${file} -o ${file} -u
done

これで複数のSQLファイルを一気にフォーマットにかけることができます。