sqlformatter

library0.1.0jsnpmunverified

A lightweight JavaScript library for formatting basic SQL statements (DML + queries). Version 0.1.0 is a direct conversion of Hibernate's BasicFormatterImpl Java code. No updates since initial release. Simple API with a single `format()` function. Limited to basic formatting—no support for advanced SQL features or database-specific syntax. Not actively maintained.

database

npm install sqlformatter

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SQLFORMATTER

sqlformatter

databasejavascriptv0.1.0

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

✓ const sqlformatter = require('sqlformatter'); sqlformatter.format(sql);

✗ import { format } from 'sqlformatter';

The library does not support ESM imports; use CommonJS require.

default

✓ const sqlformatter = require('sqlformatter');

✗ import sqlformatter from 'sqlformatter';

No default export; the require returns an object with a format method.

Shows basic usage of sqlformatter.format to format a simple SQL query.

const sqlformatter = require('sqlformatter'); const sql = 'select * from dual'; const formatted = sqlformatter.format(sql); console.log(formatted); // Output: // select // * // from // dual

Debug

Known issues

gotchaLibrary only handles basic SQL formatting; complex queries may not be formatted correctly.

fix

Consider using sql-formatter (sql-formatter) for more comprehensive formatting.

affects: all

deprecatedThe library has not been updated since initial release; may not be actively maintained.

fix

Evaluate if it meets your needs; consider alternatives like sql-formatter.

affects: all

Errors

Common errors & fixes

TypeError: sqlformatter.format is not a function

Incorrect import (e.g., using ES import instead of require)

fix

Use const sqlformatter = require('sqlformatter'); instead of import.

Cannot find module 'sqlformatter'

Package not installed or incorrect package name

fix

Run npm install sqlformatter.

Upgrade

Version history

0.1.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

14 hits · last 30 days

node