@dsillman2000/yaml-reference-ts 0.0.0 → 1.0.6

package/README.md

@@ -11,16 +11,20 @@ A Node.js TypeScript library for resolving YAML documents containing `!reference
 - **CLI Interface**: Command-line tool for resolving YAML files
 - **TypeScript Support**: Full type definitions included
 
+## Spec
+
+This Node.js TypeScript library implements the YAML specification for cross-file references in YAML files using tags `!reference` and `!reference-all` as defined in the [yaml-reference-specs project](https://github.com/dsillman2000/yaml-reference-specs).
+
 ## Installation
 
 ```bash
-npm install yaml-reference-ts
+npm install @dsillman2000/yaml-reference-ts
 ```
 
 Or for global CLI usage:
 
 ```bash
-npm install -g yaml-reference-ts
+npm install -g @dsillman2000/yaml-reference-ts
 ```
 
 ## YAML Syntax Examples
@@ -56,11 +60,11 @@ files: !reference-all {glob: ./data/*.yaml}
 ### Basic Usage
 
 ```typescript
-import { loadAndResolve } from 'yaml-reference-ts';
+import { loadYamlWithReferences } from '@dsillman2000/yaml-reference-ts';
 
 async function loadConfig() {
   try {
-    const resolved = await loadAndResolve('./config/main.yaml');
+    const resolved = await loadYamlWithReferences('./config/main.yaml');
     console.log(resolved);
   } catch (error) {
     console.error('Failed to resolve references:', error);
@@ -73,7 +77,7 @@ async function loadConfig() {
 #### `loadYamlWithReferences(filePath: string): Promise<any>`
 Loads a YAML file and resolves all `!reference` and `!reference-all` tags, returning the fully resolved object.
 
-#### `parseYamlWithReferences(content: string, filePath: string): any`
+#### `parseYamlWithReferences(content: string, filePath: string): Promise<any>`
 Parses YAML content with custom tags, setting `_location` on Reference objects.
 
 #### `loadYamlWithReferencesSync(filePath: string): any`
@@ -96,17 +100,67 @@ Represents a `!reference-all` tag with properties:
 
 The package includes a CLI tool called `yaml-reference-cli`:
 
+If an example `config.yaml` contains:
+```yaml
+services:
+  - !reference {path: services/etl-hub.yaml}
+  - !reference {path: services/etl-worker.yaml}
+connections: !reference-all {glob: databases/*.yaml}
+```
+
+With other files containing valid YAML data, then we can use the CLI to visualize the resolved YAML as JSON:
+
 ```bash
-# Basic usage
-yaml-reference-cli config.yaml
+# Basic usage (resolve references, stdout as json)
+$ yaml-reference-cli config.yaml
+  {
+    "connections": [
+      {
+        "name": "payments_pg",
+        "type": "postgres"
+      },
+      {
+        "name": "transactions_redis",
+        "type": "redis"
+      }
+    ],
+    "services": [
+      {
+        "name": "etl-hub",
+        "type": "service"
+      },
+      {
+        "name": "etl-worker",
+        "type": "service"
+      }
+    ]
+  }
+# Pipe to a file
+$ yaml-reference-cli config.yaml > .compiled/config.json
+```
+
+If you have the `yq` CLI installed ([mikefarah/yq](https://github.com/mikefarah/yq)), resolved YAML can be pretty-printed as well (with keys sorted):
 
-# With conversion back to YAML (requires yq)
-yaml-reference-cli config.yaml | yq -P
+```bash
+# Basic usage (resolve references, stdout as json, convert to YAML)
+$ yaml-reference-cli config.yaml | yq -P
+  connections:
+    - name: payments_pg
+      type: postgres
+    - name: transactions_redis
+      type: redis
+  services:
+    - name: etl-hub
+      type: service
+    - name: etl-worker
+      type: service
+# Pipe to a file
+$ yaml-reference-cli config.yaml | yq -P > .compiled/config.yaml
+```
 
-# Save output to file
-yaml-reference-cli config.yaml | yq -P > .compiled/config.yaml
+This basic CLI usage is also explained in the help message.
 
-# Show help
+```bash
 yaml-reference-cli --help
 ```
 

package/package.json

@@ -1,7 +1,15 @@
 {
     "name": "@dsillman2000/yaml-reference-ts",
-    "version": "0.0.0",
+    "version": "1.0.6",
     "description": "A Node.js TypeScript library for resolving YAML documents containing !reference and !reference-all tags",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/dsillman2000/yaml-reference-ts"
+    },
+    "homepage": "https://github.com/dsillman2000/yaml-reference-ts#readme",
+    "bugs": {
+        "url": "https://github.com/dsillman2000/yaml-reference-ts/issues"
+    },
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "bin": {

package/dist/example/additional/extra.yaml

@@ -1,15 +0,0 @@
-# Additional configuration file
-extra_config:
-  enabled: true
-  options:
-    - option1
-    - option2
-    - option3
-  settings:
-    timeout: 5000
-    retry_count: 5
-    fallback: true
-  metadata:
-    created: 2024-01-15
-    updated: 2024-01-20
-    version: 2.1.0

package/dist/example/config/database.yaml

@@ -1,11 +0,0 @@
-# Database configuration
-host: localhost
-port: 5432
-database: myapp_production
-username: admin
-password: secret123
-pool:
-  max: 20
-  min: 5
-  idle: 10000
-ssl: true

package/dist/example/config/settings.yaml

@@ -1,15 +0,0 @@
-# Application settings
-debug: false
-log_level: info
-cache:
-  enabled: true
-  ttl: 3600
-  max_size: 1000
-api:
-  timeout: 30000
-  retries: 3
-  base_url: https://api.example.com
-features:
-  analytics: true
-  notifications: false
-  dark_mode: true

package/dist/example/data/products.yaml

@@ -1,30 +0,0 @@
-# Products data file
-products:
-  - id: 101
-    name: Laptop Pro
-    category: electronics
-    price: 1299.99
-    in_stock: true
-    features:
-      - 16GB RAM
-      - 512GB SSD
-      - Intel i7
-      - 15.6" Display
-  - id: 102
-    name: Wireless Mouse
-    category: accessories
-    price: 49.99
-    in_stock: true
-    features:
-      - Bluetooth 5.0
-      - Rechargeable
-      - Ergonomic design
-  - id: 103
-    name: USB-C Cable
-    category: accessories
-    price: 19.99
-    in_stock: false
-    features:
-      - 3m length
-      - Fast charging
-      - Data transfer

package/dist/example/data/users.yaml

@@ -1,17 +0,0 @@
-# Users data file
-users:
-  - id: 1
-    name: Alice Smith
-    email: alice@example.com
-    role: admin
-    active: true
-  - id: 2
-    name: Bob Johnson
-    email: bob@example.com
-    role: user
-    active: true
-  - id: 3
-    name: Charlie Brown
-    email: charlie@example.com
-    role: user
-    active: false

package/dist/example/main.yaml

@@ -1,19 +0,0 @@
-# Example main.yaml file with !reference and !reference-all tags
-# This demonstrates the usage of the yaml-reference-ts library
-
-app:
-  name: My Application
-  version: 1.0.0
-  config: !reference
-    path: ./config/database.yaml
-  settings: !reference { path: ./config/settings.yaml }
-
-data:
-  files: !reference-all
-    glob: ./data/*.yaml
-  additional: !reference-all { glob: ./additional/*.yaml }
-
-metadata:
-  author: John Doe
-  created: 2024-01-01
-  description: Example configuration with references