readmes

Author: pyramation

DEPARSER_USAGE.md

@@ -218,15 +218,15 @@ These ensure proper handling of different input formats automatically.
 ### Complete Example
 
 ```typescript
-import deparse from 'pgsql-deparser';
+import { deparse } from 'pgsql-deparser';
 import { parse } from 'pgsql-parser';
 
 // Parse SQL
 const sql = 'SELECT * FROM users; INSERT INTO logs (action) VALUES ($1);';
-const parseResult = parse(sql);
+const parseResult = await parse(sql);
 
 // Deparse back to SQL
-const regeneratedSql = deparse(parseResult);
+const regeneratedSql = await deparse(parseResult);
 console.log(regeneratedSql);
 // Output: "SELECT * FROM users;\n\nINSERT INTO logs (action) VALUES ($1);"
 ```
@@ -252,6 +252,6 @@ const customSelect = {
   }
 };
 
-const sql = deparse(customSelect);
+const sql = await deparse(customSelect);
 // Output: "SELECT * FROM users"
 ```

README.md

@@ -74,7 +74,7 @@ console.log(sql); // SELECT * FROM users WHERE id = 1
 #### Build AST Programmatically
 ```typescript
 import * as t from '@pgsql/utils';
-import { RangeVar, SelectStmt } from '@pgsql/types';
+import { SelectStmt } from '@pgsql/types';
 
 const stmt: { SelectStmt: SelectStmt } = t.nodes.selectStmt({
   targetList: [
@@ -127,9 +127,6 @@ yarn install
 
 # Build all packages
 yarn build
-
-# Run tests
-yarn test
 ```
 
 ### Building Individual Packages
@@ -163,15 +160,15 @@ const ast = await parse('SELECT * FROM users WHERE active = true');
 ast[0].RawStmt.stmt.SelectStmt.fromClause[0].RangeVar.relname = 'customers';
 
 // Generate the modified SQL
-const newSql = deparse(ast);
+const newSql = await deparse(ast);
 console.log(newSql); // SELECT * FROM customers WHERE active = TRUE
 ```
 
 ### Build a Query Programmatically
 
 ```typescript
 import ast from '@pgsql/utils';
-import { deparse as deparseSync } from 'pgsql-deparser';
+import { deparse } from 'pgsql-deparser';
 
 const query: { SelectStmt: SelectStmt } = t.nodes.selectStmt({
   targetList: [
@@ -207,7 +204,7 @@ const query: { SelectStmt: SelectStmt } = t.nodes.selectStmt({
   op: 'SETOP_NONE'
 });
 
-console.log(deparse(query));
+console.log(await deparse(query));
 // SELECT name, email FROM users WHERE age > 18
 ```
 

TESTS.md

@@ -91,7 +91,7 @@ Here's how you can use the deparser in your TypeScript code, using [`@pgsql/util
 ```ts
 import * as t from '@pgsql/utils';
 import { RangeVar, SelectStmt } from '@pgsql/types';
-import { deparseSync as deparse } from 'pgsql-deparser';
+import { deparse } from 'pgsql-deparser';
 
 // This could have been obtained from any JSON or AST, not necessarily @pgsql/utils
 const stmt: { SelectStmt: SelectStmt } = t.nodes.selectStmt({
@@ -117,7 +117,7 @@ const stmt: { SelectStmt: SelectStmt } = t.nodes.selectStmt({
 (stmt.SelectStmt.fromClause[0] as {RangeVar: RangeVar}).RangeVar.relname = 'another_table';
 
 // Deparse the modified AST back to a SQL string
-console.log(deparse(stmt));
+console.log(await deparse(stmt));
 
 // Output: SELECT * FROM another_table
 ```

packages/parser/README.md

@@ -61,7 +61,7 @@ Explore the PostgreSQL Abstract Syntax Tree (AST) as JSON objects with ease usin
 ```ts
 import * as t from '@pgsql/utils';
 import { SelectStmt } from '@pgsql/types';
-import { deparseSync as deparse } from 'pgsql-deparser';
+import { deparse } from 'pgsql-deparser';
 
 const selectStmt: { SelectStmt: SelectStmt } = t.nodes.selectStmt({
   targetList: [
@@ -83,16 +83,16 @@ const selectStmt: { SelectStmt: SelectStmt } = t.nodes.selectStmt({
 });
 console.log(selectStmt);
 // Output: { "SelectStmt": { "targetList": [ { "ResTarget": { "val": { "ColumnRef": { "fields": [ { "A_Star": {} } ] } } } } ], "fromClause": [ { "RangeVar": { "relname": "some_amazing_table", "inh": true, "relpersistence": "p" } } ], "limitOption": "LIMIT_OPTION_DEFAULT", "op": "SETOP_NONE" } }
-console.log(deparse(stmt))
+console.log(await deparse(stmt))
 // Output: SELECT * FROM some_amazing_table
 ```
 
 #### Select Statement
 
 ```ts
 import * as t from '@pgsql/utils';
-import { RangeVar, SelectStmt } from '@pgsql/types';
-import { deparseSync as deparse } from 'pgsql-deparser';
+import { SelectStmt } from '@pgsql/types';
+import { deparse } from 'pgsql-deparser';
 
 const query: { SelectStmt: SelectStmt } = t.nodes.selectStmt({
   targetList: [
@@ -128,7 +128,7 @@ const query: { SelectStmt: SelectStmt } = t.nodes.selectStmt({
   op: 'SETOP_NONE'
 });
 
-deparse(createStmt, {});
+await deparse(createStmt);
 // SELECT name, email FROM users WHERE age > 18
 ```
 
@@ -167,7 +167,7 @@ const createStmt = t.nodes.createStmt({
 });
 
 // `deparse` function converts AST to SQL string
-const sql = deparse(createStmt);
+const sql = await deparse(createStmt, { pretty: true });
 
 console.log(sql);
 // OUTPUT: