@pgpm/utils 0.6.0 → 0.7.0

package/Makefile

@@ -1,5 +1,5 @@
 EXTENSION = launchql-utils
-DATA = sql/launchql-utils--0.5.0.sql
+DATA = sql/launchql-utils--0.6.0.sql
 
 PG_CONFIG = pg_config
 PGXS := $(shell $(PG_CONFIG) --pgxs)

package/README.md

@@ -1,5 +1,17 @@
 # @pgpm/utils
 
+<p align="center" width="100%">
+  <img height="250" src="https://raw.githubusercontent.com/launchql/launchql/refs/heads/main/assets/outline-logo.svg" />
+</p>
+
+<p align="center" width="100%">
+  <a href="https://github.com/launchql/pgpm-modules/actions/workflows/ci.yml">
+    <img height="20" src="https://github.com/launchql/pgpm-modules/actions/workflows/ci.yml/badge.svg" />
+  </a>
+   <a href="https://github.com/launchql/pgpm-modules/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
+   <a href="https://www.npmjs.com/package/@pgpm/utils"><img height="20" src="https://img.shields.io/github/package-json/v/launchql/pgpm-modules?filename=packages%2Futils%2Futils%2Fpackage.json"/></a>
+</p>
+
 General utility functions for PostgreSQL extensions
 
 ## Overview
@@ -28,40 +40,42 @@ This is a quick way to get started. The sections below provide more detailed ins
 ### Prerequisites
 
 ```bash
-# Install pgpm globally
+# Install pgpm CLI 
 npm install -g pgpm
 
-# Start PostgreSQL
+# Start local Postgres (via Docker) and export env vars
 pgpm docker start
-
-# Set environment variables
 eval "$(pgpm env)"
 ```
 
-### Deploy
+> **Tip:** Already running Postgres? Skip the Docker step and just export your `PG*` environment variables.
 
-#### Option 1: Deploy by installing with pgpm
+### **Add to an Existing Package**
 
 ```bash
+# 1. Install the package
 pgpm install @pgpm/utils
-pgpm deploy
+
+# 2. Deploy locally
+pgpm deploy 
 ```
 
-#### Option 2: Deploy from Package Directory
+### **Add to a New Project**
 
 ```bash
-cd packages/utils/utils
-pgpm deploy --createdb
-```
+# 1. Create a workspace
+pgpm init --workspace
+cd my-app
 
-#### Option 3: Deploy from Workspace Root
+# 2. Create your first module
+pgpm init
+cd packages/your-module
 
-```bash
-# Install workspace dependencies
-pnpm install
+# 3. Install a package 
+pgpm install @pgpm/utils
 
-# Deploy with dependencies
-pgpm deploy mydb1 --yes --createdb
+# 4. Deploy everything
+pgpm deploy --createdb --database mydb1
 ```
 
 ## Core Functions
@@ -381,76 +395,6 @@ pnpm test
 
 - `@pgpm/verify`: Verification utilities
 
-## Development
-
-See the [Development](#development-1) section below for information on working with this package.
-
----
-
-## Development
-
-### **Before You Begin**
-
-```bash
-# 1. Install pgpm
-npm install -g pgpm
-
-# 2. Start Postgres (Docker or local)
-pgpm docker start
-
-# 3. Load PG* environment variables (PGHOST, PGUSER, ...)
-eval "$(pgpm env)"
-```
-
----
-
-### **Starting a New Project**
-
-```bash
-# 1. Create a workspace
-pgpm init --workspace
-cd my-app
-
-# 2. Create your first module
-pgpm init
-
-# 3. Add a migration
-pgpm add some_change
-
-# 4. Deploy (auto-creates database)
-pgpm deploy --createdb
-```
-
----
-
-### **Working With an Existing Project**
-
-```bash
-# 1. Clone and enter the project
-git clone <repo> && cd <project>
-
-# 2. Install dependencies
-pnpm install
-
-# 3. Deploy locally
-pgpm deploy --createdb
-```
-
----
-
-### **Testing a Module Inside a Workspace**
-
-```bash
-# 1. Install workspace deps
-pnpm install
-
-# 2. Enter the module directory
-cd packages/<some-module>
-
-# 3. Run tests in watch mode
-pnpm test:watch
-```
-
 ## Related Tooling
 
 * [pgpm](https://github.com/launchql/launchql/tree/main/packages/pgpm): **🖥️ PostgreSQL Package Manager** for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.

package/launchql-utils.control

@@ -1,6 +1,6 @@
 # launchql-utils extension
 comment = 'launchql-utils extension'
-default_version = '0.5.0'
+default_version = '0.6.0'
 module_pathname = '$libdir/launchql-utils'
 requires = 'plpgsql,launchql-verify'
 relocatable = false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pgpm/utils",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "General utility functions for PostgreSQL extensions",
   "publishConfig": {
     "access": "public"
@@ -11,7 +11,7 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@pgpm/verify": "0.6.0"
+    "@pgpm/verify": "0.7.0"
   },
   "devDependencies": {
     "pgpm": "^0.2.0"
@@ -24,5 +24,5 @@
   "bugs": {
     "url": "https://github.com/launchql/pgpm-modules/issues"
   },
-  "gitHead": "c7d0eae588d7a764b382a330c8b853b341b13fb2"
+  "gitHead": "1f24d8fa95fb141f16e5b8345458c3b687d80908"
 }