@pgpm/inflection 0.6.0 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/Makefile CHANGED
@@ -1,5 +1,5 @@
1
1
  EXTENSION = launchql-inflection
2
- DATA = sql/launchql-inflection--0.5.0.sql
2
+ DATA = sql/launchql-inflection--0.6.0.sql
3
3
 
4
4
  PG_CONFIG = pg_config
5
5
  PGXS := $(shell $(PG_CONFIG) --pgxs)
package/README.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @pgpm/inflection
2
2
 
3
+ <p align="center" width="100%">
4
+ <img height="250" src="https://raw.githubusercontent.com/launchql/launchql/refs/heads/main/assets/outline-logo.svg" />
5
+ </p>
6
+
7
+ <p align="center" width="100%">
8
+ <a href="https://github.com/launchql/pgpm-modules/actions/workflows/ci.yml">
9
+ <img height="20" src="https://github.com/launchql/pgpm-modules/actions/workflows/ci.yml/badge.svg" />
10
+ </a>
11
+ <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>
12
+ <a href="https://www.npmjs.com/package/@pgpm/inflection"><img height="20" src="https://img.shields.io/github/package-json/v/launchql/pgpm-modules?filename=packages%2Futils%2Finflection%2Fpackage.json"/></a>
13
+ </p>
14
+
3
15
  String inflection utilities for PostgreSQL naming conventions
4
16
 
5
17
  ## Overview
@@ -30,40 +42,42 @@ This is a quick way to get started. The sections below provide more detailed ins
30
42
  ### Prerequisites
31
43
 
32
44
  ```bash
33
- # Install pgpm globally
45
+ # Install pgpm CLI
34
46
  npm install -g pgpm
35
47
 
36
- # Start PostgreSQL
48
+ # Start local Postgres (via Docker) and export env vars
37
49
  pgpm docker start
38
-
39
- # Set environment variables
40
50
  eval "$(pgpm env)"
41
51
  ```
42
52
 
43
- ### Deploy
53
+ > **Tip:** Already running Postgres? Skip the Docker step and just export your `PG*` environment variables.
44
54
 
45
- #### Option 1: Deploy by installing with pgpm
55
+ ### **Add to an Existing Package**
46
56
 
47
57
  ```bash
58
+ # 1. Install the package
48
59
  pgpm install @pgpm/inflection
49
- pgpm deploy
60
+
61
+ # 2. Deploy locally
62
+ pgpm deploy
50
63
  ```
51
64
 
52
- #### Option 2: Deploy from Package Directory
65
+ ### **Add to a New Project**
53
66
 
54
67
  ```bash
55
- cd packages/utils/inflection
56
- pgpm deploy --createdb
57
- ```
68
+ # 1. Create a workspace
69
+ pgpm init --workspace
70
+ cd my-app
58
71
 
59
- #### Option 3: Deploy from Workspace Root
72
+ # 2. Create your first module
73
+ pgpm init
74
+ cd packages/your-module
60
75
 
61
- ```bash
62
- # Install workspace dependencies
63
- pnpm install
76
+ # 3. Install a package
77
+ pgpm install @pgpm/inflection
64
78
 
65
- # Deploy with dependencies
66
- pgpm deploy mydb1 --yes --createdb
79
+ # 4. Deploy everything
80
+ pgpm deploy --createdb --database mydb1
67
81
  ```
68
82
 
69
83
  ## Core Functions
@@ -378,76 +392,6 @@ pnpm test
378
392
 
379
393
  - `@pgpm/verify`: Verification utilities
380
394
 
381
- ## Development
382
-
383
- See the [Development](#development-1) section below for information on working with this package.
384
-
385
- ---
386
-
387
- ## Development
388
-
389
- ### **Before You Begin**
390
-
391
- ```bash
392
- # 1. Install pgpm
393
- npm install -g pgpm
394
-
395
- # 2. Start Postgres (Docker or local)
396
- pgpm docker start
397
-
398
- # 3. Load PG* environment variables (PGHOST, PGUSER, ...)
399
- eval "$(pgpm env)"
400
- ```
401
-
402
- ---
403
-
404
- ### **Starting a New Project**
405
-
406
- ```bash
407
- # 1. Create a workspace
408
- pgpm init --workspace
409
- cd my-app
410
-
411
- # 2. Create your first module
412
- pgpm init
413
-
414
- # 3. Add a migration
415
- pgpm add some_change
416
-
417
- # 4. Deploy (auto-creates database)
418
- pgpm deploy --createdb
419
- ```
420
-
421
- ---
422
-
423
- ### **Working With an Existing Project**
424
-
425
- ```bash
426
- # 1. Clone and enter the project
427
- git clone <repo> && cd <project>
428
-
429
- # 2. Install dependencies
430
- pnpm install
431
-
432
- # 3. Deploy locally
433
- pgpm deploy --createdb
434
- ```
435
-
436
- ---
437
-
438
- ### **Testing a Module Inside a Workspace**
439
-
440
- ```bash
441
- # 1. Install workspace deps
442
- pnpm install
443
-
444
- # 2. Enter the module directory
445
- cd packages/<some-module>
446
-
447
- # 3. Run tests in watch mode
448
- pnpm test:watch
449
- ```
450
-
451
395
  ## Related Tooling
452
396
 
453
397
  * [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.
@@ -1,6 +1,6 @@
1
1
  # launchql-inflection extension
2
2
  comment = 'launchql-inflection extension'
3
- default_version = '0.5.0'
3
+ default_version = '0.6.0'
4
4
  module_pathname = '$libdir/launchql-inflection'
5
5
  requires = 'plpgsql,unaccent,uuid-ossp,launchql-verify'
6
6
  relocatable = false
package/package.json CHANGED
@@ -1,7 +1,13 @@
1
1
  {
2
2
  "name": "@pgpm/inflection",
3
- "version": "0.6.0",
3
+ "version": "0.7.1",
4
4
  "description": "String inflection utilities for PostgreSQL naming conventions",
5
+ "keywords": [
6
+ "postgresql",
7
+ "pgpm",
8
+ "inflection",
9
+ "strings"
10
+ ],
5
11
  "publishConfig": {
6
12
  "access": "public"
7
13
  },
@@ -11,7 +17,7 @@
11
17
  "test:watch": "jest --watch"
12
18
  },
13
19
  "dependencies": {
14
- "@pgpm/verify": "0.6.0"
20
+ "@pgpm/verify": "0.7.1"
15
21
  },
16
22
  "devDependencies": {
17
23
  "pgpm": "^0.2.0"
@@ -24,5 +30,5 @@
24
30
  "bugs": {
25
31
  "url": "https://github.com/launchql/pgpm-modules/issues"
26
32
  },
27
- "gitHead": "c7d0eae588d7a764b382a330c8b853b341b13fb2"
33
+ "gitHead": "f3156553b409bd27b66ac03562151d439d779f53"
28
34
  }