Neverending Pile of Messages
Introducing npm Teams! Private packages + team management tools.Learn more »

pg-formatter

1.1.2 • Public • Published

pg-formatter

Travis build status Coveralls NPM version Canonical Code Style Twitter Follow

A PostgreSQL SQL syntax beautifier.

Note:

This project is a thin wrapper of https://github.com/darold/pgFormatter. Execution of the module relies on Perl being available on the host system.

Usage

import {
  format
} from 'pg-formatter';
 
format(`SELECT foo FROM bar`);
 

Configuration

Configuration Format Default Description pgFormatter equivalent
anonymize boolean false Obscure all literals in queries, useful to hide confidential data before formatting. anonymize
functionCase string ("unchanged", "lowercase", "uppercase", "capitalize") unchanged Change the case of the function names. function-case
keywordCase string ("unchanged", "lowercase", "uppercase", "capitalize") unchanged Change the case of the reserved keyword. keyword-case
spaces number 4 Number of spaces to indent the code. spaces
stripComments boolean false Remove any comment from SQL code. nocomment
placeholder string (regex) N/A Regex to find code that must not be changed. placeholder

Install

npm i pg-formatter

DownloadsWeekly Downloads

2,558

Version

1.1.2

License

none

Unpacked Size

6.49 MB

Total Files

513

Last publish

Collaborators

  • avatar