https://github.com/nightvisi0n/pg-formatter-ts
Format PostgreSQL SQL with ease using this TypeScript library, which provides a convenient API wrapping the `pgFormatter` CLI tool
https://github.com/nightvisi0n/pg-formatter-ts
cli-wrapper code-formatter database-tools pgformatter postgresql query-optimization sql sql-formatter typescript
Last synced: about 1 month ago
JSON representation
Format PostgreSQL SQL with ease using this TypeScript library, which provides a convenient API wrapping the `pgFormatter` CLI tool
- Host: GitHub
- URL: https://github.com/nightvisi0n/pg-formatter-ts
- Owner: nightvisi0n
- License: mit
- Created: 2023-04-05T07:05:52.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-06T07:41:23.000Z (about 3 years ago)
- Last Synced: 2025-09-14T15:15:10.703Z (9 months ago)
- Topics: cli-wrapper, code-formatter, database-tools, pgformatter, postgresql, query-optimization, sql, sql-formatter, typescript
- Language: TypeScript
- Homepage:
- Size: 205 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pg-formatter-ts [](https://www.npmjs.com/package/pg-formatter-ts) [](https://coveralls.io/github/nightvisi0n/pg-formatter-ts?branch=main)
`pg-formatter-ts` is a TypeScript library that wraps the pgFormatter CLI tool for formatting PostgreSQL SQL code.
With a simple and easy-to-use API, it provides the ability to format SQL code programmatically with various formatting options.
Compared to the existing [`pg-formatter`](https://github.com/gajus/pg-formatter) library, `pg-formatter-ts` offers improved TypeScript support and better integration with modern TypeScript/JavaScript projects. This library utilizes the same underlying CLI tool, but provides a more streamlined and developer-friendly API.
Additionally, `pg-formatter-ts` supports all available CLI options of pgFormatter, allowing for greater customization and control over the formatting process.
## Installation
```bash
yarn install pg-formatter-ts
```
### Prerequisites
Ensure that `perl` is installed on your system, as `pgFormatter` relies on it. You can check if Perl is installed by running `perl -v` in your command line. If it's not installed, please visit the [Perl official website](https://www.perl.org/get.html) for installation instructions.
## Usage
```typescript
import { format, PgFormatOptions } from "pg-formatter-ts";
const sqlCode = "SELECT id, name, age FROM users WHERE age >= 18;";
const options: PgFormatOptions = {
keywordCase: 2,
spaces: 2,
};
format(sqlCode, options).then((formattedCode) => {
console.log(formattedCode);
});
```
## Options
`pg-formatter-ts` accepts an optional `PgFormatOptions` object as a parameter for the `format` function. The options available are:
```typescript
interface PgFormatOptions {
anonymize?: boolean;
commaStart?: boolean;
commaBreak?: boolean;
config?: string;
wrapComment?: boolean;
debug?: boolean;
commaEnd?: boolean;
functionCase?: number;
format?: string;
nogrouping?: boolean;
help?: boolean;
inplace?: boolean;
keepNewline?: boolean;
noExtraLine?: boolean;
maxlength?: number;
multiline?: boolean;
nocomment?: boolean;
numbering?: boolean;
output?: string;
placeholder?: string;
redshift?: boolean;
spaces?: number;
separator?: string;
formatType?: boolean;
tabs?: boolean;
keywordCase?: number;
typeCase?: number;
version?: boolean;
wrapLimit?: number;
wrapAfter?: number;
noRcfile?: boolean;
extraFunction?: string;
extraKeyword?: string;
noSpaceFunction?: boolean;
}
```
For a detailed explanation of each option, refer to the [pgFormatter documentation](https://github.com/darold/pgFormatter).
## Disclaimer
The code for this library and this README were generated by an AI called GPT-4, developed by OpenAI. While GPT-4 strives for accuracy, it is possible that the code and documentation may contain errors or inconsistencies. Please feel free to report any issues or submit pull requests with improvements, as your contributions are welcome and appreciated.
## License
This project is licensed under the [MIT License](https://opensource.org/license/mit/).