sql-format-plus 0.0.1

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016-present ZeroTurnaround LLC
+Copyright (c) 2026-present xcy960815 <18763006837@163.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,134 @@
+# sql-format-plus
+
+[中文文档](./README.zh-CN.md)
+
+- Documentation: [https://xcy960815.github.io/sql-format-plus/](https://xcy960815.github.io/sql-format-plus/)
+- Online Demo: [https://xcy960815.github.io/sql-format-plus/guide/demo](https://xcy960815.github.io/sql-format-plus/guide/demo)
+
+`sql-format-plus` is a lightweight JavaScript and TypeScript library for pretty-printing SQL queries.
+
+It supports:
+
+- Standard SQL
+- Couchbase N1QL
+- IBM DB2
+- Oracle PL/SQL
+
+## Features
+
+- TypeScript source and bundled declaration files
+- ESM and UMD build artifacts
+- Configurable indentation
+- Named and indexed placeholder replacement
+- Dialect-specific tokenizer configuration
+- VitePress documentation
+- Local Vite demo
+
+## Installation
+
+```bash
+npm install sql-format-plus
+```
+
+```bash
+pnpm add sql-format-plus
+```
+
+## Quick Start
+
+```ts
+import sqlFormatter from 'sql-format-plus'
+
+console.log(sqlFormatter.format('SELECT * FROM table1'))
+```
+
+Output:
+
+```sql
+SELECT
+  *
+FROM
+  table1
+```
+
+You can also use the named export:
+
+```ts
+import { format } from 'sql-format-plus'
+
+format('SELECT * FROM table1', {
+  language: 'sql',
+  indent: '    ',
+})
+```
+
+## Placeholder Replacement
+
+```ts
+import { format } from 'sql-format-plus'
+
+format('SELECT * FROM tbl WHERE foo = @foo', {
+  params: {
+    foo: "'bar'",
+  },
+})
+```
+
+```ts
+format('SELECT * FROM tbl WHERE foo = ?', {
+  params: ["'bar'"],
+})
+```
+
+## API
+
+### `format(query, options)`
+
+| Option     | Type                                                                                                | Default     | Description                                |
+| ---------- | --------------------------------------------------------------------------------------------------- | ----------- | ------------------------------------------ |
+| `language` | `'sql' \| 'n1ql' \| 'db2' \| 'pl/sql'`                                                              | `'sql'`     | SQL dialect configuration.                 |
+| `indent`   | `string`                                                                                            | `'  '`      | Characters used for one indentation level. |
+| `params`   | `Record<string, string \| number \| boolean \| null> \| Array<string \| number \| boolean \| null>` | `undefined` | Placeholder replacement values.            |
+
+## CDN / UMD Example
+
+```html
+<script src="https://unpkg.com/sql-format-plus/dist/sql-format-plus.umd.min.js"></script>
+<script>
+  const result = window.SqlFormatPlus.format('SELECT * FROM table1')
+</script>
+```
+
+## Build Artifacts
+
+The published package includes:
+
+- `dist/sql-format-plus.es.js`: ESM build for modern bundlers
+- `dist/sql-format-plus.umd.js`: UMD build for script-tag or legacy integration
+- `dist/sql-format-plus.umd.min.js`: minified UMD build
+- `types/sql-format-plus.d.ts`: bundled TypeScript declarations
+
+Source maps and CommonJS output are intentionally not published.
+
+## Development
+
+```bash
+pnpm install
+pnpm run dev
+pnpm run check
+pnpm run build
+```
+
+## Project Structure
+
+- `src/sql-format-plus/index.ts`: library entry
+- `src/sql-format-plus/core`: tokenizer, formatter, indentation, inline-block, and params logic
+- `src/sql-format-plus/languages`: dialect-specific formatter configuration
+- `src/main.ts`: local demo entry
+- `rollup.config.js`: Rollup build for library bundles and bundled declarations
+- `vite.config.mts`: Vite config for the demo app
+- `docs`: VitePress documentation
+
+## License
+
+[MIT](./LICENSE)

package/README.zh-CN.md

@@ -0,0 +1,134 @@
+# sql-format-plus
+
+[English README](./README.md)
+
+- 文档地址：[https://xcy960815.github.io/sql-format-plus/](https://xcy960815.github.io/sql-format-plus/)
+- 在线演示：[https://xcy960815.github.io/sql-format-plus/zh-CN/guide/demo](https://xcy960815.github.io/sql-format-plus/zh-CN/guide/demo)
+
+`sql-format-plus` 是一个轻量级 JavaScript 和 TypeScript SQL 格式化库。
+
+它支持：
+
+- Standard SQL
+- Couchbase N1QL
+- IBM DB2
+- Oracle PL/SQL
+
+## 功能特性
+
+- 使用 TypeScript 编写，并内置打包后的类型声明
+- 输出 ESM 和 UMD 构建产物
+- 支持自定义缩进
+- 支持命名占位符和索引占位符替换
+- 按 SQL 方言配置 tokenizer
+- 使用 VitePress 生成文档
+- 使用 Vite 提供本地 demo
+
+## 安装
+
+```bash
+npm install sql-format-plus
+```
+
+```bash
+pnpm add sql-format-plus
+```
+
+## 快速开始
+
+```ts
+import sqlFormatter from 'sql-format-plus'
+
+console.log(sqlFormatter.format('SELECT * FROM table1'))
+```
+
+输出：
+
+```sql
+SELECT
+  *
+FROM
+  table1
+```
+
+也可以使用命名导出：
+
+```ts
+import { format } from 'sql-format-plus'
+
+format('SELECT * FROM table1', {
+  language: 'sql',
+  indent: '    ',
+})
+```
+
+## 占位符替换
+
+```ts
+import { format } from 'sql-format-plus'
+
+format('SELECT * FROM tbl WHERE foo = @foo', {
+  params: {
+    foo: "'bar'",
+  },
+})
+```
+
+```ts
+format('SELECT * FROM tbl WHERE foo = ?', {
+  params: ["'bar'"],
+})
+```
+
+## API
+
+### `format(query, options)`
+
+| 参数       | 类型                                                                                                | 默认值      | 说明                     |
+| ---------- | --------------------------------------------------------------------------------------------------- | ----------- | ------------------------ |
+| `language` | `'sql' \| 'n1ql' \| 'db2' \| 'pl/sql'`                                                              | `'sql'`     | SQL 方言配置。           |
+| `indent`   | `string`                                                                                            | `'  '`      | 一个缩进层级使用的字符。 |
+| `params`   | `Record<string, string \| number \| boolean \| null> \| Array<string \| number \| boolean \| null>` | `undefined` | 占位符替换值。           |
+
+## CDN / UMD 用法
+
+```html
+<script src="https://unpkg.com/sql-format-plus/dist/sql-format-plus.umd.min.js"></script>
+<script>
+  const result = window.SqlFormatPlus.format('SELECT * FROM table1')
+</script>
+```
+
+## 构建产物说明
+
+发布包包含：
+
+- `dist/sql-format-plus.es.js`：给现代 bundler 使用的 ESM 版本
+- `dist/sql-format-plus.umd.js`：给 script 标签或传统接入方式使用的 UMD 版本
+- `dist/sql-format-plus.umd.min.js`：压缩后的 UMD 版本
+- `types/sql-format-plus.d.ts`：打包后的 TypeScript 类型声明
+
+源码映射文件和 CommonJS 构建产物不会进入最终发布包。
+
+## 本地开发
+
+```bash
+pnpm install
+pnpm run dev
+pnpm run check
+pnpm run build
+```
+
+## 项目结构
+
+- `src/sql-format-plus/index.ts`：库入口
+- `src/sql-format-plus/core`：分词、格式化、缩进、内联块和参数替换逻辑
+- `src/sql-format-plus/languages`：不同 SQL 方言的 formatter 配置
+- `src/main.ts`：本地 demo 入口
+- `rollup.config.js`：库构建和类型打包配置
+- `vite.config.mts`：demo 开发配置
+- `docs`：VitePress 文档
+
+## License
+
+[MIT](./LICENSE)