Prettier SQL

Formats SQL files using the sql-formatter library

Supports the following SQL Dialects:

• Standard SQL
• BigQuery
• DB2
• Hive
• MariaDB
• MySQL
• N1QL
• PL/SQL
• PostgresQL
• Amazon Redshift
• SingleStoreDB
• Snowflake
• Spark
• SQLite
• Trino (Presto)
• TransactSQL

Issues

Please report issues here: https://github.com/sql-formatter-org/sql-formatter/issues

Use the FORMATTING template if it is an issue related the formatting of the SQL, otherwise, please use the VSCODE template for issues with running the VSCode Extension

Configuration

Prettier-SQL.SQLFlavourOverride: Uses custom SQL Flavour to format sql files. Use this if you are using the Microsoft PostgreSQL or MSSQL Extensions since they do not provide a new language ID for VSCode.

Prettier-SQL.ignoreTabSettings: Whether to ignore VSCode user/workspace settings for tabSize and insertSpaces

Prettier-SQL.tabSizeOverride: Overrides tabSize if Prettier-SQL.ignoreTabSettings is enabled

Prettier-SQL.insertSpacesOverride: Overrides insertSpaces if Prettier-SQL.ignoreTabSettings is enabled

Prettier-SQL.keywordCase: Whether to print keywords in ALL CAPS or lowercase

Prettier-SQL.indentStyle: Switched between standard keyword positioning vs maintaining a central space column

Prettier-SQL.logicalOperatorNewline: Whether to break before or after AND and OR

Prettier-SQL.tabulateAlias: Whether to right-align aliases to the longest line in the SELECT clause

Prettier-SQL.commaPosition: Where to place commas for SELECT and GROUP BY clauses

Prettier-SQL.expressionWidth: Number of characters allowed in each line before breaking

Prettier-SQL.linesBetweenQueries: How many newlines to place between each query / statement

Prettier-SQL.denseOperators: Whether to strip whitespace around operators such as + or >=

Prettier-SQL.newlineBeforeSemicolon: Whether to place semicolon on its own line or on previous line

Publish Flow

To publish the VSCode Extension:

• ensure that the CHANGELOG and package.json are up to date before bumping version
• ensure that the version does not conflict with a previous extension version
• run the following commands in the vscode/ dir (requires auth with Microsoft Dev account + access to VSCode team)
  • yarn vsce:package
  • yarn vsce:publish (can also be done via browser)