Prettier SQL

What Prettier SQL is

Prettier SQL is a free, self-hosted plugin that adds SQL formatting support to Prettier. It formats SQL files using sql-formatter or node-sql-parser, with documented dialect support including BigQuery, DB2, Hive, MariaDB, MySQL, PostgreSQL, Snowflake, SQLite, T-SQL, Trino, and others. Package metadata also lists dialects such as Redshift, ClickHouse, Spark, and Flink SQL. Formatting options cover casing for keywords, data types, functions, and identifiers, plus indentation style and logical-operator line breaks. With prettier-plugin-embed, it can format SQL inside tagged template literals in JavaScript. Installation is shown through npm or Yarn, with configuration in a Prettier config file; automatic fixes and configuration are supported. The package requires Node.js v14.18.0 or later and lists Prettier ^3.0.3 as a peer dependency. It is distributed under the MIT license. The README says the plugin is under development and its formatting may not always match Prettier's formatting.

Who it suits

Prettier SQL suits developers using Prettier who want SQL formatting across supported dialects, including SQL embedded in JavaScript tagged templates. It requires Node.js v14.18.0 or later and a self-hosted setup.

Limits

The package is under development, and its README says formatting may not always match Prettier's formatting.

Getting started

1. Install the package with npm or Yarn
2. Use Node.js v14.18.0 or later
3. Ensure Prettier ^3.0.3 is available as a peer dependency
4. Add the plugin to a Prettier configuration file
5. Use prettier-plugin-embed when formatting SQL in tagged JavaScript templates

Verdict

Prettier SQL adds configurable SQL formatting to a self-hosted Prettier setup, with broad listed dialect support. Its development status and Node.js requirement are important considerations.