【VSCode】SQLファイル保存時にフォーマットする機能(Formatter)を設定する

prettier_sql BigQuery
prettier_sql

概要

リファクタリングをするタスクで、インデントがぐちゃぐちゃのソースコードがあり、一気に修正したいなと思い、フォーマッターをインストールしました。

今回の環境としては、

  • VScode
  • BigQueryで使用するSQLファイル
  • MacBook Pro

です。

インストール手順

拡張機能をインストールする

まずは、Prettier SQLをインストールします。

今回は、SQLファイルのフォーマット(整形)をしたいので、こちらをインストールします。

対象ファイルに応じて、拡張機能は追加してください。

拡張機能を設定

筆者はMacBookを使っているので 「command + P」で上部の検索窓を開き、

>preferences: Configure Language Specific Settings

と検索します。

日本語設定の場合は、

>preferences: 言語の固有の設定

で検索してみてください。

その後、SQLと入力します。

SQLに限定した設定画面が開かれるので、Editor: Default FormatterをPrettier SQLに設定します。

これで、SQLファイルのフォーマットはPrettier SQLが採用されます。

詳細(コーディングルール等)を設定する

Settingsの検索窓でPrettier SQLと入力します。

表示されない場合は、一度ウィンドウを閉じて再度開くと表示されるかと思います。(インストールしたばかりで表示されないケースがあります)

Prettier SQLで下記のような設定をします。

コーディングルールに応じて、この辺りは変更して使ってください。

Ignore Tab Setting : ☑︎
Expression Width : 100
Keyword Case : Upper
SQL Flavour Override : bigquery

最後に全体設定をします。

基本的にどのファイルに対してもフォーマットはしていきたいので、全てのファイルを保存したときに自動でフォーマットするように設定します。

Format On Save : ☑︎

まとめ

いかがでしたでしょうか。

今回は、自動でフォーマットするための拡張機能を設定していきました。

ぜひ各言語に応じて設定して作業を効率化していきたいですね。

また良いTipsを見つけたら共有していこうと思います!

コメント

タイトルとURLをコピーしました