Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslnode 18–226 runs
build_error
glibcnode 18–226 runs
build_error
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
prettier-plugin-sql
✓ Prettier plugin loaded via plugins config in .prettierrc: { "plugins": ["prettier-plugin-sql"] }
✗ import prettierPluginSql from 'prettier-plugin-sql'
Not imported directly; Prettier discovers it when listed in plugins array.
SqlBaseOptions
✓ import type { SqlBaseOptions } from 'prettier-plugin-sql'
✗ const { SqlBaseOptions } = require('prettier-plugin-sql')
Type only; erased at runtime. In CJS, use import() or require with .d.ts.
PrettierPluginEmbedOptions
✓ import type { PrettierPluginEmbedOptions } from 'prettier-plugin-embed'
For SQL-in-JS formatting, embed options come from a separate package.
Basic setup: add plugin to .prettierrc, configure PostgreSQL dialect and uppercase keywords, format a SQL file.
// Install: npm i -D prettier prettier-plugin-sql
// .prettierrc
{
"plugins": ["prettier-plugin-sql"],
"language": "postgresql",
"keywordCase": "upper"
}
// Run: npx prettier --write db.sql
// Before (db.sql):
// sELect first_name, species froM
// animals
// WhERE
// id = 1
//
// After:
// SELECT
// first_name,
// species
// FROM
// animals
// WHERE
// id = 1
prettier --version
Errors
Common errors & fixes
Cannot find module 'prettier-plugin-sql'
Plugin not installed or not in node_modules
fixRun: npm install -D prettier prettier-plugin-sql
Error: Could not load plugin 'prettier-plugin-sql'
Prettier version <3.0.3
fixUpgrade Prettier: npm install -D prettier@latest
Module not found: Can't resolve 'prettier-plugin-sql'
Importing directly instead of using Prettier plugin system
fixDo not import; add to .prettierrc plugins array.
TypeError: Cannot read properties of undefined (reading 'format')
Using node-sql-parser with unsupported language/dialect
fixUse formatter: 'sql-formatter' or ensure language is supported by node-sql-parser.
Audit
Dependencies
prettierrequiredpeer dependency (^3.0.3) required at runtime