Dataform で利用する sqlx ファイルを編集する時に Vim/VSCode に設定した内容やインストールしたプラグイン

はじめに

Dataform では SQLX ファイルを利用します。普段使っているエディタでの設定ではハイライト等されないのでプラグインや拡張をインストールする必要があります。

今回私が今回 Vim に設定した内容やインストールしたプラグインをまとめました。

エディタに手を加えずにファイルを開くと以下のように見た目になります。

今回用意したサンプルは、行数・設定共に少ないため問題ありません。しかし、実際のプロジェクトではファイルサイズや設定内容によっては見づらくなりました。

最初 Vim/Neovim 用の Plugin を見つけるまで filetype を設定して SQLX ファイルを編集していましたが限界だったため公式が出している VSCode 拡張を設定しました。

この VSCode 拡張をインストールすればシンタックスハイライトだけでなく、自動コンパイルやコードジャンプを利用することが出来ます。

ただし、 Vimmer な私は VSCode を使い続ける事がストレスでした。どうにかして Vim/Neovim に戻れるように SQLX ファイルを快適に書ける環境を探すたびに出ました。

:set filetype=sql と設定することでまだましになります。

ただし、 config {}, js {} 等の SQL にはない記述には対応していません。

現時点 Vim/Neovim での最適解は有志の方が作成された、 andres-lowrie/vim-sqlx を導入することです。

この Plugin を導入して 40 ~ 50 ファイル程 SQLX を書きましたがとても快適でした。

:::note info vim-plug を例に記載します。他の Plugin マネージャーを利用している方は置き換えてください。

:::note warn vim-plug はすでに導入済みで Plug xxx の記述を追加すれば良い状態を前提とします。 :::

以下記述を Vim/Neovim の Config file に追記していただければ OK です :tada:

Plug 'andres-lowrie/vim-sqlx'

Dataform とても良い。 SQLX 書きましょう :muscle: