prettier-plugin-sql

An opinionated sql formatter plugin for Prettier

Prettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing, taking various rules into account.

This plugin adds support for a lot of sql files through sql-formatter or node-sql-parser.

Notice

This plugin is still under development, its printer just wraps sql-formatter or node-sql-parser's default printer. Of course it should just work, but may not match prettier's format sometimes.

Requirements

prettier-plugin-sql is an evergreen module. 🌲 This module requires an LTS Node version (v14.18.0+).

Install

Using npm:

1# npm
2npm i -D prettier prettier-plugin-sql
3
4# yarn
5yarn add -D prettier prettier-plugin-sql

Usage

Once installed, Prettier plugins must be added to .prettierrc:

1{
2  "plugins": ["prettier-plugin-sql"]
3}

Then:

1# npx
2npx prettier --write db.sql
3
4# yarn
5yarn prettier --write db.sql

SQL-in-JS with prettier-plugin-embed

Format SQL-in-JS tagged template literals by installing prettier-plugin-embed and configuring as follows:

prettier.config.mjs

1/** @type {import('prettier').Config} */
2const prettierConfig = {
3  plugins: ['prettier-plugin-embed', 'prettier-plugin-sql'],
4}
5
6/** @type {import('prettier-plugin-embed').PrettierPluginEmbedOptions} */
7const prettierPluginEmbedConfig = {
8  embeddedSqlTags: ['sql'],
9}
10
11/** @type {import('prettier-plugin-sql').SqlBaseOptions} */
12const prettierPluginSqlConfig = {
13  language: 'postgresql',
14  keywordCase: 'upper',
15}
16
17const config = {
18  ...prettierConfig,
19  ...prettierPluginEmbedConfig,
20  ...prettierPluginSqlConfig,
21}
22
23export default config

Before formatting:

1const animals = await sql`
2  sELect  first_name,    species froM
3   animals
4         WhERE
5 id = ${id}
6`

After formatting:

1const animals = await sql`
2  SELECT
3    first_name,
4    species
5  FROM
6    animals
7  WHERE
8    id = ${id}
9`

Parser Options

1interface SqlOptions {
2  formatter: 'sql-formatter' | 'node-sql-parser' // default `sql-formatter`
3
4  // sql-formatter
5  language:
6    | 'sql'
7    | 'bigquery'
8    | 'db2'
9    | 'db2i' // (experimental)
10    | 'hive'
11    | 'mariadb'
12    | 'mysql'
13    | 'n1ql'
14    | 'postgresql'
15    | 'plsql'
16    | 'redshift'
17    | 'singlestoredb'
18    | 'snowflake'
19    | 'spark'
20    | 'sqlite'
21    | 'transactsql'
22    | 'tsql'
23    | 'trino'
24  // default `sql`
25  dialect: string // `JSOX` **stringified**, please refer https://github.com/sql-formatter-org/sql-formatter/blob/master/docs/dialect.md for more details
26  keywordCase: 'preserve' | 'upper' | 'lower' // default `preserve`
27  dataTypeCase: 'preserve' | 'upper' | 'lower' // default `preserve`
28  functionCase: 'preserve' | 'upper' | 'lower' // default `preserve`
29  identifierCase: 'preserve' | 'upper' | 'lower' // default `preserve`, experimental
30  indentStyle: 'standard' | 'tabularLeft' | 'tabularRight' // default `standard`
31  logicalOperatorNewline: 'before' | 'after' // default `before`
32  expressionWidth: number // default `50`
33  linesBetweenQueries: number // default `1`
34  denseOperators: boolean // default `false`
35  newlineBeforeSemicolon: boolean // default `false`
36  params: string // `JSOX` **stringified**, please refer https://github.com/sql-formatter-org/sql-formatter/blob/master/docs/params.md for more details
37  paramTypes: string // `JSOX` **stringified**, please refer https://github.com/sql-formatter-org/sql-formatter/blob/master/docs/paramTypes.md for more details
38
39  // node-sql-parser
40  type: 'table' | 'column' // default `table`
41  database:
42    | 'bigquery'
43    | 'db2'
44    | 'hive'
45    | 'mariadb'
46    | 'mysql'
47    | 'postgresql'
48    | 'transactsql'
49    | 'flinksql'
50    | 'snowflake' // (alpha)
51  // default `mysql`
52}

More details on sql-formatter and node-sql-parser.

Sponsors and Backers

Sponsors

1stG	RxTS	UnTS

Backers

1stG	RxTS	UnTS

Changelog

Detailed changes for each release are documented in CHANGELOG.md.

License

MIT © JounQin@1stG.me