sql-formatter or sqlfmt for auto-formatting sql

[coolaj86]

Contenders

sqlfmt (go)

Releases available at:

• https://github.com/maddyblue/sqlfmt/releases

let g:sqlfmt_command = "sqlfmt"
let g:sqlfmt_options = ""

TODO: figure out to get it to format without replacing the file with the error message on error (maybe it's outputting errors to stdout instead of stderr?) maddyblue/sqlfmt#69

sql-formatter (node)

Since we gotta have node anyway...

• https://github.com/sql-formatter-org/sql-formatter?tab=readme-ov-file

{
  "keywordCase": "upper",
  "identifierCase": "lower",
  "newlineBeforeSemicolon": true
}

let g:sqlfmt_command = "sql-formatter"
let g:sqlfmt_options = "-l postgresql -c ./.sql-formatter.json"
let g:sqlfmt_auto = 1

sql-parser-cst

https://github.com/nene/sql-parser-cst

Vim Plugin

autocmd

" Auto-format SQL files with sqlfmt on save
autocmd BufWritePre *.sql execute ':silent %!sqlfmt'

babarot/vim-sqlfmt

It seems that this is a generic formatter tool that could work with any formatter that follows the stdout / stderr conventions:

git clone https://github.com/babarot/vim-sqlfmt.git ~/.vim/pack/plugins/start/vim-sqlfmt