embedoc 0.11.2 → 0.12.0

package/cli-contract.yaml

@@ -1,9 +1,9 @@
 # yaml-language-server: $schema=./node_modules/cli-contracts/schemas/cli-contract.schema.json
-cliContracts: 0.1.0
+cli_contracts: 0.1.0
 
 info:
   title: embedoc CLI
-  version: 0.11.1
+  version: 0.12.0
   description: >-
     In-place document generator that auto-updates marker blocks in documents
     and source code while preserving manually edited sections. Supports
@@ -16,12 +16,29 @@ info:
     name: foo-ogawa
     url: https://github.com/foo-ogawa/embedoc
 
-commandSets:
+artifact_slots:
+  config:
+    direction: read
+    description: embedoc.config.yaml configuration
+  documents:
+    direction: readwrite
+    description: Target documents with @embedoc marker blocks
+  templates:
+    direction: read
+    description: Handlebars templates for file generation
+  datasources:
+    direction: read
+    description: Datasource files (SQLite, CSV, JSON, YAML)
+  generated-files:
+    direction: write
+    description: Files generated by Handlebars templates
+
+command_sets:
   embedoc:
     summary: In-place document generator with marker-based embedding.
     executable: embedoc
 
-    globalOptions:
+    global_options:
       - name: version
         aliases: [V]
         description: Print version and exit.
@@ -64,17 +81,17 @@ commandSets:
             files:
               - path: embedoc.config.yaml
                 required: false
-                mediaType: application/yaml
+                media_type: application/yaml
                 encoding: utf-8
                 description: Configuration file.
               - path: .embedoc/renderers/index.ts
                 required: false
-                mediaType: text/x-typescript
+                media_type: text/x-typescript
                 encoding: utf-8
                 description: Renderer registration file.
               - path: .embedoc/datasources/index.ts
                 required: false
-                mediaType: text/x-typescript
+                media_type: text/x-typescript
                 encoding: utf-8
                 description: Custom datasource registration file.
               - path: .embedoc/templates/.gitkeep
@@ -87,10 +104,10 @@ commandSets:
               format: text
 
         x-agent:
-          riskLevel: low
-          requiresConfirmation: false
+          risk_level: low
+          requires_confirmation: false
           idempotent: true
-          sideEffects:
+          side_effects:
             - file_write
             - directory_create
 
@@ -124,14 +141,14 @@ commandSets:
           - name: config
             aliases: [c]
             description: Path to config file (YAML or JSON).
-            valueName: path
+            value_name: path
             schema:
               type: string
               default: embedoc.config.yaml
             file:
               mode: read
               exists: true
-              mediaType: application/yaml
+              media_type: application/yaml
               encoding: utf-8
 
           - name: dry-run
@@ -160,13 +177,13 @@ commandSets:
               format: text
 
         x-agent:
-          riskLevel: medium
-          requiresConfirmation: false
+          risk_level: medium
+          requires_confirmation: false
           idempotent: true
-          sideEffects:
+          side_effects:
             - file_write
-          safeDryRunOption: --dry-run
-          recommendedBeforeUse:
+          safe_dry_run_option: --dry-run
+          recommended_before_use:
             - Ensure embedoc.config.yaml exists (run init if needed).
             - Verify datasource files are accessible.
 
@@ -189,27 +206,27 @@ commandSets:
           - name: config
             aliases: [c]
             description: Path to config file (YAML or JSON).
-            valueName: path
+            value_name: path
             schema:
               type: string
               default: embedoc.config.yaml
             file:
               mode: read
               exists: true
-              mediaType: application/yaml
+              media_type: application/yaml
               encoding: utf-8
 
           - name: datasource
             aliases: [s]
             description: Specific datasource to process.
-            valueName: name
+            value_name: name
             schema:
               type: string
 
           - name: generator
             aliases: [g]
             description: Specific generator template to use.
-            valueName: name
+            value_name: name
             schema:
               type: string
 
@@ -248,13 +265,13 @@ commandSets:
               format: text
 
         x-agent:
-          riskLevel: medium
-          requiresConfirmation: false
+          risk_level: medium
+          requires_confirmation: false
           idempotent: true
-          sideEffects:
+          side_effects:
             - file_write
-          safeDryRunOption: --dry-run
-          recommendedBeforeUse:
+          safe_dry_run_option: --dry-run
+          recommended_before_use:
             - Ensure embedoc.config.yaml exists with generators configured.
             - Verify datasource files are accessible.
             - Ensure Handlebars templates exist in templates_dir.
@@ -278,14 +295,14 @@ commandSets:
           - name: config
             aliases: [c]
             description: Path to config file (YAML or JSON).
-            valueName: path
+            value_name: path
             schema:
               type: string
               default: embedoc.config.yaml
             file:
               mode: read
               exists: true
-              mediaType: application/yaml
+              media_type: application/yaml
               encoding: utf-8
 
           - name: verbose
@@ -317,11 +334,11 @@ commandSets:
               format: text
 
         x-agent:
-          riskLevel: medium
-          requiresConfirmation: false
+          risk_level: medium
+          requires_confirmation: false
           idempotent: true
-          sideEffects:
+          side_effects:
             - file_write
-          recommendedBeforeUse:
+          recommended_before_use:
             - Ensure embedoc.config.yaml exists (run init if needed).
             - Verify datasource files are accessible.

package/docs/cli-reference.md

@@ -2,7 +2,7 @@
 
 In-place document generator that auto-updates marker blocks in documents and source code while preserving manually edited sections. Supports multiple datasources (SQLite, CSV, JSON, YAML, glob), programmable TypeScript renderers, Handlebars file generation, and incremental builds with dependency tracking.
 
-**Version:** 0.11.1
+**Version:** 0.12.0
 
 ## Table of Contents
 
@@ -66,10 +66,10 @@ embedoc init --force
 
 ```yaml
 x-agent: 
-  riskLevel: low
-  requiresConfirmation: false
+  risk_level: low
+  requires_confirmation: false
   idempotent: true
-  sideEffects: 
+  side_effects: 
     - file_write
     - directory_create
 ```
@@ -125,13 +125,13 @@ embedoc build --dry-run --verbose
 
 ```yaml
 x-agent: 
-  riskLevel: medium
-  requiresConfirmation: false
+  risk_level: medium
+  requires_confirmation: false
   idempotent: true
-  sideEffects: 
+  side_effects: 
     - file_write
-  safeDryRunOption: --dry-run
-  recommendedBeforeUse: 
+  safe_dry_run_option: --dry-run
+  recommended_before_use: 
     - Ensure embedoc.config.yaml exists (run init if needed).
     - Verify datasource files are accessible.
 ```
@@ -184,13 +184,13 @@ embedoc generate --all --dry-run --verbose
 
 ```yaml
 x-agent: 
-  riskLevel: medium
-  requiresConfirmation: false
+  risk_level: medium
+  requires_confirmation: false
   idempotent: true
-  sideEffects: 
+  side_effects: 
     - file_write
-  safeDryRunOption: --dry-run
-  recommendedBeforeUse: 
+  safe_dry_run_option: --dry-run
+  recommended_before_use: 
     - Ensure embedoc.config.yaml exists with generators configured.
     - Verify datasource files are accessible.
     - Ensure Handlebars templates exist in templates_dir.
@@ -247,12 +247,12 @@ embedoc watch --debug-deps
 
 ```yaml
 x-agent: 
-  riskLevel: medium
-  requiresConfirmation: false
+  risk_level: medium
+  requires_confirmation: false
   idempotent: true
-  sideEffects: 
+  side_effects: 
     - file_write
-  recommendedBeforeUse: 
+  recommended_before_use: 
     - Ensure embedoc.config.yaml exists (run init if needed).
     - Verify datasource files are accessible.
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "embedoc",
-  "version": "0.11.2",
+  "version": "0.12.0",
   "description": "In-place document generator that auto-updates marker blocks while preserving manual edits. Supports multiple datasources (SQLite, CSV, JSON, YAML, glob), programmable TypeScript embeds, and incremental builds with dependency tracking.",
   "type": "module",
   "workspaces": [
@@ -89,7 +89,7 @@
     "@types/node": "^22.10.2",
     "@typescript-eslint/eslint-plugin": "^8.0.0",
     "@typescript-eslint/parser": "^8.0.0",
-    "cli-contracts": "^0.7.2",
+    "cli-contracts": "^0.30.2",
     "eslint": "^8.57.0",
     "typedoc": "^0.28.0",
     "typedoc-plugin-markdown": "^4.9.0",