readme, addon

Author: pyramation

README.md

@@ -1,28 +1,45 @@
 # libpg-query
 
+<p align="center" width="100%">
+    <img src="https://github.com/launchql/libpg-query-node/assets/545047/7f7053b8-9f52-4f4e-95b0-201d656902ed" alt="webincubator" width="100">
+</p>
+
+<p align="center" width="100%">
+   <a href="https://www.npmjs.com/package/libpg-query"><img height="20" src="https://img.shields.io/npm/dt/libpg-query"></a>
+   <a href="https://www.npmjs.com/package/libpg-query"><img height="20" src="https://img.shields.io/npm/dw/libpg-query"/></a>
+   <a href="https://github.com/launchql/libpg-query/blob/main/LICENSE-MIT"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
+   <a href="https://www.npmjs.com/package/libpg-query"><img height="20" src="https://img.shields.io/github/package-json/v/launchql/libpg-query-node"/></a>
+</p>
+
 The real PostgreSQL parser, exposed for nodejs.
 
 Primarily used for the node.js parser and deparser [pgsql-parser](https://github.com/pyramation/pgsql-parser)
 
-## Building a binary distribution
 
-- Install requirements (`npm i`)
-- `npx node-pre-gyp rebuild package`
-- With appropriate AWS credentials configured, `npx node-pre-gyp publish`
+## Table of Contents
 
-Or you can run the scripts
+1. [Installation](#installation)
+2. [Example](#example)
+5. [Documentation](#documentation)
+3. [Versions](#versions)
+4. [Building a binary distribution](#building-a-binary-distribution)
+6. [Related Projects](#related-projects)
+7. [Credit](#credit)
 
-```
-npm run binary:build
-npm run binary:publish
-```
 
 ## Installation
 
 ```sh
 npm install libpg-query
 ```
 
+## Example
+
+```js
+const parser = require('libpg-query');
+parser.parseQuery('select 1').then(console.log);
+```
+
 ### Documentation
 
 ### `query.parseQuery(sql)`/`parseQuerySync`
@@ -35,27 +52,36 @@ The return value is an array, as multiple queries may be provided in a single st
 
 Parses the contents of a PL/PGSql function, from a `CREATE FUNCTION` declaration, and returns a Promise for the parse tree (or returns the parse tree directly in the sync version). May reject with/throw a parse error.
 
-## Example
+## Versions
 
-```js
-const parser = require('libpg-query');
-parser.parseQuery('select 1').then(console.log);
-```
+Our latest is built with `16-latest` branch from libpg_query
 
-## Versions
 
-Our latest is built with `15-latest` branch from libpg_query
+| PG Major Version | libpg_query | Branch                                                                                         | npm 
+|--------------------------|-------------|------------------------------------------------------------------------------------------------|---------|
+| 16                       | 16-latest   | [`16-latest`](https://github.com/launchql/libpg-query-node/tree/16-latest)                       | [`[email protected]`](https://www.npmjs.com/package/libpg-query/v/latest)
+| 15                       | 15-latest   | [`15-latest`](https://github.com/launchql/libpg-query-node/tree/15-latest)                       | [`[email protected]`](https://www.npmjs.com/package/libpg-query/v/15.0.0)
+| 14                       | 14-latest   | [`14-latest`](https://github.com/launchql/libpg-query-node/tree/14-latest)                       | [`[email protected]`](https://www.npmjs.com/package/libpg-query/v/14.0.0)
+| 13                       | 13-latest   | [`13-latest`](https://github.com/launchql/libpg-query-node/tree/13-latest)                       | [`[email protected]`](https://www.npmjs.com/package/libpg-query/v/13.3.1)
+| 12                       | (n/a)       |                                                                                                |
+| 11                       | (n/a)       |                                                                                                |
+| 10                       | 10-latest   |                        | `@1.3.1` ([tree](https://github.com/pyramation/pgsql-parser/tree/39b7b1adc8914253226e286a48105785219a81ca))      |
+
 
-| PostgreSQL Major Version | libpg_query | Status              | npm 
-|--------------------------|-------------|---------------------|---------|
-| 15                       | 15-latest   | Supported           | [`latest`](https://www.npmjs.com/package/libpg-query/v/latest)
-| 14                       | 14-latest   | Supported           | [`[email protected]`](https://www.npmjs.com/package/libpg-query/v/14.0.0)
-| 13                       | 13-latest   | Supported           | [`[email protected]`](https://www.npmjs.com/package/libpg-query/v/13.3.1)
-| 12                       | (n/a)       | Not supported       |
-| 11                       | (n/a)       | Not supported       |
-| 10                       | 10-latest   | Not supported       | `@1.3.1` ([tree](https://github.com/pyramation/pgsql-parser/tree/39b7b1adc8914253226e286a48105785219a81ca))      | 
+## Building a binary distribution
+
+- Install requirements (`npm i`)
+- `npx node-pre-gyp rebuild package`
+- With appropriate AWS credentials configured, `npx node-pre-gyp publish`
+
+Or you can run the scripts
+
+```
+npm run binary:build
+npm run binary:publish
+```
 
-## Related
+## Related Projects
 
 * [libpg_query](https://github.com/pganalyze/libpg_query)
 * [pgsql-parser](https://github.com/pyramation/pgsql-parser)
@@ -68,6 +94,6 @@ This is based on the output of [libpg_query](https://github.com/pganalyze/libpg_
 
 All credit for the hard problems goes to [Lukas Fittl](https://github.com/lfittl).
 
-Additional thanks for node binding [Ethan Resnick](github.com/ethanresnick).
+Additional thanks for node binding [Ethan Resnick](https://github.com/ethanresnick).
 
 Original [Code](https://github.com/zhm/node-pg-query-native) and [License](https://github.com/zhm/node-pg-query-native/blob/master/LICENSE.md)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libpg-query",
-  "version": "15.0.2",
+  "version": "15.0.3",
   "description": "The real PostgreSQL query parser",
   "homepage": "https://github.com/pyramation/libpg-query-node",
   "main": "index.js",

script/buildAddon.sh

@@ -1,58 +1,67 @@
 #!/usr/bin/env bash
 
-commit=1ada550d901ed4edbfb6bce2163d21f4b948ab2d
+# Set the desired commit hash and branch
+commit=db39825bc7c1ddd45962ec6a626d740b7f8f027a
+branch=15-latest
 
+# Remember current directory and create a new, unique, temporary directory
 rDIR=$(pwd)
 tmpDir=$(mktemp -d 2>/dev/null || mktemp -d -t 'tmpdir.XXXX')
+
+# Define the make target
 makeTarget=build
 
+# Change to the newly created temp directory
 cd "$tmpDir"
 
-git clone -b 15-latest --single-branch https://github.com/pganalyze/libpg_query.git
+# Clone the selected branch of the libpg_query Git repo
+git clone -b $branch --single-branch https://github.com/pganalyze/libpg_query.git
 cd libpg_query
 
+# Checkout the desired commit
 git checkout $commit
 
 # needed if being invoked from within gyp
 unset MAKEFLAGS
 unset MFLAGS
 
+# Adaptively build for macOS or Linux
 if [ "$(uname)" == "Darwin" ]; then
 	make CFLAGS='-mmacosx-version-min=10.7' PG_CFLAGS='-mmacosx-version-min=10.7' $makeTarget
 elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
 	make CFLAGS='' PG_CFLAGS='' $makeTarget
 fi
 
+# Terminate if build fails
 if [ $? -ne 0 ]; then
 	echo "ERROR: 'make' command failed";
 	exit 1;
 fi
 
+# Search for libpg_query.a, error if not found
 file=$(ls | grep 'libpg_query.a')
-
 if [ ! $file ]; then
 	echo "ERROR: libpg_query.a not found";
 	exit 1;
 fi
 
+# Error if pg_query.h is missing
 file=$(ls | grep 'pg_query.h')
-
 if [ ! $file ]; then
 	echo "ERROR: pg_query.h not found";
 	exit 1;
 fi
 
-#copy queryparser.cc, binding.gyp to current directory
-#
-#
-
+# Copy queryparser.cc, binding.gyp to current directory
 if [ "$(uname)" == "Darwin" ]; then
     cp $(pwd)/libpg_query.a $rDIR/libpg_query/osx/
 elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
     cp $(pwd)/libpg_query.a $rDIR/libpg_query/linux/
 fi
 
+# Copy header
 cp $(pwd)/pg_query.h $rDIR/libpg_query/include/
 
+# Cleanup: revert to original directory and remove the temp
 cd "$rDIR"
 rm -rf "$tmpDir"