prettier-plugin-sql-cst

What it does

Bound parameters

Bound SQL parameter placeholders are rejected by default, and users can configure sqlParamTypes to recognize specified placeholder forms.checked 8 Oct 2001

Configuration

It supports Prettier’s printWidth, tabWidth, and useTabs options, plus SQL-specific options for keyword, literal, type, identifier, and function casing.checked 8 Oct 2001

Dialect limits

The experimental dialects are limited by incomplete parser syntax support, and the README says unsupported SQL sections can be bracketed with special comments to disable parsing.checked 8 Oct 2001

Editor integration

The plugin can be used with Prettier’s VSCode extension, configured as the default formatter, with document selectors potentially needed for SQL files.checked 8 Oct 2001

Embedded SQL

The README recommends using prettier-plugin-embed together with this plugin to format SQL strings inside JavaScript files.checked 8 Oct 2001

Experimental dialects

PostgreSQL, PL/pgSQL, MySQL, and MariaDB are listed as experimental, and the README says parser syntax support is incomplete for these dialects.checked 8 Oct 2001

Formatting

It adapts SQL layout to expression length, placing longer clauses and their contents on separate lines as needed.checked 8 Oct 2001

Installation

The README gives npm, pnpm, and yarn commands for installing the plugin with Prettier as a development dependency.checked 8 Oct 2001

License

The repository identifies the project as GPL-3.0 licensed.checked 8 Oct 2001

Limitations

The README says SQL formatting style details remain subject to change and describes identifier and function case options as experimental and not thoroughly tested.checked 8 Oct 2001

Live demo

The project README links to a live SQL formatting playground.checked 8 Oct 2001

Maintainer

The maintainer profile identifies Rene Saarsoo and lists Tartu, Estonia as his location.checked 8 Oct 2001

Purpose

It is a Prettier plugin for formatting SQL that uses sql-parser-cst and Prettier’s formatting algorithm.checked 8 Oct 2001

Style

Its stated formatting philosophy is to use one style, avoid configuration options, format embedded languages, and preserve syntax when uncertain.checked 8 Oct 2001

Supported dialects

SQLite and BigQuery have full support; PostgreSQL, PL/pgSQL, MySQL, and MariaDB are experimental.checked 8 Oct 2001