Registry / devops / devkits-sql-formatter

devkits-sql-formatter

JSON →
library1.0.7jsnpmunverified

A zero-dependency SQL formatter and minifier for Node.js and CLI. Current stable version 1.0.7. Offers both beautification (with configurable indentation and uppercase keywords) and compression. Lightweight alternative to sql-formatter-plus with no subscriptions. Actively maintained with weekly releases on npm.

devops
npm install devkits-sql-formatter
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · DEVKITS-SQL-FORMAT
D
devkits-sql-formatter
devopsjavascriptv1.0.7
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

format
✓ import { format } from 'devkits-sql-formatter'
✗ import format from 'devkits-sql-formatter'
Use named import; no default export.
minify
✓ import { minify } from 'devkits-sql-formatter'
✗ const { minify } = require('devkits-sql-formatter')
Works in both ESM and CJS; require is common for older Node versions.
CLI usage
✓ npx sql-formatter --format "SELECT * FROM users"
✗ node -e "require('devkits-sql-formatter').format('SELECT *')"
Use CLI aliases sqlformat and sqlmin for convenience.

Shows formatting with uppercase keywords and minifying a SQL query.

import { format, minify } from 'devkits-sql-formatter'; const sql = 'SELECT * FROM users WHERE name = "John" ORDER BY id DESC LIMIT 10'; const formatted = format(sql, { indent: ' ', uppercase: true }); console.log(formatted); // SELECT * FROM users WHERE name = "John" ORDER BY id DESC LIMIT 10 const minified = minify(sql); console.log(minified); // SELECT * FROM users WHERE name = "John" ORDER BY id DESC LIMIT 10
Debug
Known issues
gotchaCLI may conflict if you have other packages with sql-formatter binary installed globally.
fix
Use npx devkits-sql-formatter to avoid global collisions.
affects: >=1.0.0
gotchaMinification does not fully normalize whitespace for all edge cases (e.g., comments inside strings may be broken).
fix
Test minification on your specific SQL; if issues arise, stick with formatting.
affects: >=1.0.0
breakingVersion 1.0.0 changed export from default to named exports.
fix
Use named import: import { format } from 'devkits-sql-formatter' instead of import format from ...
affects: >=1.0.0
Errors
Common errors & fixes
Error: Cannot find module 'devkits-sql-formatter'
Package not installed or wrong import path.
fix
Run npm install devkits-sql-formatter and ensure import path is correct.
TypeError: format is not a function
Using default import instead of named import.
fix
Change to import { format } from 'devkits-sql-formatter'
Upgrade
Version history
1.0.7latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
6 hits · last 30 days
node
6
Resources
githubhttps://github.com/devkits/devkits ↗
packagedevkits-sql-formatter ↗
homepagehttps://devkits-tools.surge.sh ↗
devkits-sql-formatter — npm install devkits-sql-formatter · libregistry