@jdg32794/prettier-plugin-pgsql weekly downloads statistics

@jdg32794/prettier-plugin-pgsql

A Prettier plugin for PostgreSQL. Formatting is done by the Rust pgsqlfmt crate, compiled to a native Node addon with napi-rs.

-- before
select a,b from t where x=1;

-- after
SELECT
  a,
  b
FROM t
WHERE x = 1;

Install

npm install --save-dev prettier @jdg32794/prettier-plugin-pgsql

Requires Prettier 3.

Prerelease: the current next build (0.1.0-alpha.x) only includes a binary for macOS on Apple Silicon (arm64). Binaries for macOS x64, Linux x64 (glibc) and Windows x64 are planned for the first stable release.

Usage

Add the plugin to your Prettier config:

{
  "plugins": ["@jdg32794/prettier-plugin-pgsql"]
}

Files ending in .sql, .pgsql and .psql are then formatted automatically:

npx prettier --write "**/*.sql"

To use the plugin for other files, set "parser": "postgresql" in an override.

Statements that pgsqlfmt cannot parse are left unchanged.

Options

Option	Default	Description
pgKeywordCase	"upper"	Case of SQL keywords: "upper", "lower" or "preserve".
pgCommaStyle	"trailing"	Comma position when items go one per line: "trailing" or "leading".

Prettier's own printWidth and tabWidth are respected (tabWidth minimum 2).

{
  "plugins": ["@jdg32794/prettier-plugin-pgsql"],
  "pgKeywordCase": "lower",
  "pgCommaStyle": "leading"
}

Using the formatter directly

The native binding can also be used without Prettier:

const { formatSql } = require('@jdg32794/prettier-plugin-pgsql/index.js')

formatSql('select 1', { maxWidth: 80, indentWidth: 2, keywordCase: 'upper', commaStyle: 'trailing' })

Development

Requires a recent Rust toolchain and Node.js.

yarn install
yarn build   # builds prettier-plugin-pgsql.<platform>.node
yarn test

License

MIT