@gethue/sql-formatter

中文文档
4.0.3发布于 2021/05/03MITTypeScriptCommonJS近 30 天下载 9951

Format whitespace in a SQL query to make it more readable

原始使用文档
文档目录7 节
  1. Install
  2. Usage as library
  3. Placeholders replacement
  4. Usage from command line
  5. Usage without NPM
  6. Contributing
  7. License

SQL Formatter NPM version Build Status Coverage Status

SQL Formatter is a JavaScript library for pretty-printing SQL queries. It started as a port of a PHP Library, but has since considerably diverged.

SQL formatter supports the following dialects:

It does not support:

  • Stored procedures.
  • Changing of the delimiter type to something else than ;.

→ Try the demo.

Install

Get the latest version from NPM:

npm install sql-formatter

Usage as library

import { format } from 'sql-formatter';

console.log(format('SELECT * FROM tbl'));

This will output:

SELECT
  *
FROM
  tbl

You can also pass in configuration options:

format('SELECT * FROM tbl', {
  language: 'spark', // Defaults to "sql" (see the above list of supported dialects)
  indent: '    ', // Defaults to two spaces
  uppercase: bool, // Defaults to false (not safe to use when SQL dialect has case-sensitive identifiers)
  linesBetweenQueries: 2, // Defaults to 1,
  indentQuerySeparator: true, // Defaults to false
});

Placeholders replacement

// Named placeholders
format("SELECT * FROM tbl WHERE foo = @foo", {
  params: {foo: "'bar'"}
}));

// Indexed placeholders
format("SELECT * FROM tbl WHERE foo = ?", {
  params: ["'bar'"]
}));

Both result in:

SELECT
  *
FROM
  tbl
WHERE
  foo = 'bar'

Usage from command line

The CLI tool will be installed under sql-formatter and may be invoked via npx sql-formatter:

sql-formatter -h
usage: sql-formatter [-h] [-o OUTPUT] [-l {db2,mariadb,mysql,n1ql,plsql,postgresql,redshift,spark,sql,tsql}]
                     [-i N | -t] [-u] [--lines-between-queries N] [--version] [FILE]

SQL Formatter

positional arguments:
  FILE                  Input SQL file (defaults to stdin)

optional arguments:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        File to write SQL output (defaults to stdout)
  -l {db2,mariadb,mysql,n1ql,plsql,postgresql,redshift,spark,sql,tsql},
  --language {db2,mariadb,mysql,n1ql,plsql,postgresql,redshift,spark,sql,tsql}
                        SQL Formatter dialect (defaults to basic sql)
  -i N, --indent N      Number of spaces to indent query blocks (defaults to 2)
  -t, --tab-indent      Indent query blocks with tabs instead of spaces
  -u, --uppercase       Capitalize language keywords
  --lines-between-queries N
                        How many newlines to insert between queries (separated by ";")
  --version             show program's version number and exit

By default, the tool takes queries from stdin and processes them to stdout but one can also name an input file name or use the --output option.

echo 'select * from tbl where id = 3' | sql-formatter -u
SELECT
  *
FROM
  tbl
WHERE
  id = 3

Usage without NPM

If you don't use a module bundler, clone the repository, run npm install and grab a file from /dist directory to use inside a <script> tag. This makes SQL Formatter available as a global variable window.sqlFormatter.

Contributing

Make sure to run all checks:

npm run check

...and you're ready to poke us with a pull request.

License

MIT

版本与发布记录

@gethue/sql-formatter 共发布 1 个版本,首次发布于 2021/05/03;过去 12 个月发布了 0 个版本。

版本发布日期距今
4.0.3latest2021/05/035 年前

关于 @gethue/sql-formatter 的常见问题

@gethue/sql-formatter 是什么?

Format whitespace in a SQL query to make it more readable

如何安装 @gethue/sql-formatter?

在项目目录运行 npm install @gethue/sql-formatter,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 sql-formatter,可以用 npx sql-formatter 直接运行。

@gethue/sql-formatter 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gethue/sql-formatter 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@gethue/sql-formatter 可以商用吗?

@gethue/sql-formatter 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gethue/sql-formatter 的下载量有多少?

根据 npm 官方下载统计,@gethue/sql-formatter 在 2026/10/17 – 2026/11/15 这 30 天内被下载 9,951 次,日均约 332 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gethue/sql-formatter 还在维护吗?

最新版本 4.0.3 发布于 2021/05/03(5 年前);至今共发布 1 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/05/03。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。