- Home
- SQL Linters and Formatters
- prettier-plugin-sql-cst
On the recordRead 8 Oct 202615 facts
prettier-plugin-sql-cst
On the record
- Bound parameters
- Bound SQL parameter placeholders are rejected by default, and users can configure sqlParamTypes to recognize specified placeholder forms.github.com · read 8 Oct 2026
- Configuration
- It supports Prettier’s printWidth, tabWidth, and useTabs options, plus SQL-specific options for keyword, literal, type, identifier, and function casing.github.com · read 8 Oct 2026
- 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.github.com · read 8 Oct 2026
- 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.github.com · read 8 Oct 2026
- Embedded SQL
- The README recommends using prettier-plugin-embed together with this plugin to format SQL strings inside JavaScript files.github.com · read 8 Oct 2026
- Experimental dialects
- PostgreSQL, PL/pgSQL, MySQL, and MariaDB are listed as experimental, and the README says parser syntax support is incomplete for these dialects.github.com · read 8 Oct 2026
- Formatting
- It adapts SQL layout to expression length, placing longer clauses and their contents on separate lines as needed.github.com · read 8 Oct 2026
- Installation
- The README gives npm, pnpm, and yarn commands for installing the plugin with Prettier as a development dependency.github.com · read 8 Oct 2026
- License
- The repository identifies the project as GPL-3.0 licensed.github.com · read 8 Oct 2026
- 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.github.com · read 8 Oct 2026
- Live demo
- The project README links to a live SQL formatting playground.github.com · read 8 Oct 2026
- Maintainer
- The maintainer profile identifies Rene Saarsoo and lists Tartu, Estonia as his location.github.com · read 8 Oct 2026
- Purpose
- It is a Prettier plugin for formatting SQL that uses sql-parser-cst and Prettier’s formatting algorithm.github.com · read 8 Oct 2026
- Style
- Its stated formatting philosophy is to use one style, avoid configuration options, format embedded languages, and preserve syntax when uncertain.github.com · read 8 Oct 2026
- Supported dialects
- SQLite and BigQuery have full support; PostgreSQL, PL/pgSQL, MySQL, and MariaDB are experimental.github.com · read 8 Oct 2026