happy-sql 1.7.1 → 2.0.0

package/ChangeLog

@@ -1,3 +1,8 @@
+2026.08.19, v2.0.0
+
+feature:
+- f34faef happy-sql: parseSqlNode -> parseSql
+
 2026.08.19, v1.7.1
 
 fix:

package/README.md

@@ -9,24 +9,74 @@
 
 <img width="600" height="428" alt="image" src="https://github.com/user-attachments/assets/aefbd055-957e-4de3-aca5-c30e5e3ee3f9" />
 
-SQL to JS AST parser and printer.
+Write SQL as JavaScript function calls: parse, print, convert.
+
+SQL written as JS lives in `.js` files it gets linted, formatted, and transformed by standard tooling. **Happy Sql** is the engine that converts between the two representations and exposes the underlying AST for tools that need it.
 
 ## Install
 
 ```
-npm i happy-sql --save
+npm i happy-sql
+```
+
+## CLI
+
+The CLI reads from stdin and auto-detects direction: SQL in → JS out, JS in → SQL out.
+
+```sh
+# SQL → JS
+echo "SELECT * FROM users WHERE id = :id" | happy-sql
+# [
+#     select('*', from(users), where(id === ':id')),
+# ];
+# JS → SQL (pipe the output back)
+echo "[\n    select('*', from(users), where(id === ':id')),\n];" | happy-sql
+# SELECT *
+# FROM users
+# WHERE id = :id
 ```
 
 ## API
 
 ```js
-const source = `select(count('*'), from(users))`;
+import {
+    convertSqlToJs,
+    convertJsToSql,
+    parseSql,
+    printSql,
+} from 'happy-sql';
+```
+
+### `convertSqlToJs(sql)`
+
+```js
+convertSqlToJs('SELECT COUNT(*)\nFROM users\n');
+// [
+//     select(count('*'), from(users)),
+// ];
+```
+
+### `convertJsToSql(js)`
 
-convertJsToSql(source);
-// returns
-'SELECT COUNT(*)\nFROM users\n';
+```js
+convertJsToSql('select(count(\'*\'), from(users))');
+// "SELECT COUNT(*)\nFROM users\n"
 ```
 
+### `parseSql(sql)`
+
+Returns a Babel-compatible AST node. Use when you need to inspect or transform the tree directly.
+
+### `printSql(ast)`
+
+Prints a Babel AST node back to a SQL string.
+
+## Used by
+
+- [`@putout/processor-sql`](https://github.com/coderaiser/putout/tree/master/packages/processor-sql) — lets 🐊[Putout](https://github.com/coderaiser/putout) lint and transform `.sql` files
+- [`@putout/plugin-sql`](https://github.com/coderaiser/putout/tree/master/packages/plugin-sql) — SQL-specific rules for Putout (`apply-count`, `postgres`, SQLite↔Postgres conversions)
+- [`putnik`](https://github.com/coderaiser/putnik) — code transformation engine that writes AST into SQLite and runs SQL-aware plugins against it
+
 ## License
 
 MIT

package/lib/happy-sql.js

@@ -1,11 +1,11 @@
 import {parse} from '@putout/babel';
 import {print} from '@putout/printer';
-import {parseSqlNode} from '#parser';
+import {parseSql} from '#parser';
 import {printSql} from '#printer';
 
 export {printSql} from '#printer';
-export {parseSqlNode} from '#parser';
+export {parseSql} from '#parser';
 
-export const convertSqlToJs = (sql) => print(parseSqlNode(sql));
+export const convertSqlToJs = (sql) => print(parseSql(sql));
 
 export const convertJsToSql = (js) => printSql(parse(js));

package/lib/parser/parser.js

@@ -25,7 +25,7 @@ const parseCstDialect = (source, dialect) => parseCst(source, {
     includeComments: true,
 });
 
-export const parseSqlNode = (source) => {
+export const parseSql = (source) => {
     for (const dialect of DIALECTS) {
         const [, cst] = tryCatch(parseCstDialect, source, dialect);
         

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "happy-sql",
-  "version": "1.7.1",
+  "version": "2.0.0",
   "type": "module",
   "description": "sql to js ast parser and printer",
   "exports": {