dev-cockpit 0.2.6 → 0.2.8

package/examples/cockpit.schema.json

@@ -18,12 +18,16 @@
     "processes": {
       "type": "array",
       "description": "Long-running commands streamed into the Output pane. Each runs once at startup and is restarted on `restartOn` fsevents.",
-      "items": { "$ref": "#/$defs/Process" }
+      "items": {
+        "$ref": "#/$defs/Process"
+      }
     },
     "repos": {
       "type": "array",
       "description": "Rows shown in the Repos/Targets pane.",
-      "items": { "$ref": "#/$defs/Repo" }
+      "items": {
+        "$ref": "#/$defs/Repo"
+      }
     },
     "docker": {
       "$ref": "#/$defs/Docker",
@@ -32,12 +36,16 @@
     "highlights": {
       "type": "array",
       "description": "Regex patterns applied to all output streams (processes + docker). Each can carry an explicit severity; otherwise inferred.",
-      "items": { "$ref": "#/$defs/Highlight" }
+      "items": {
+        "$ref": "#/$defs/Highlight"
+      }
     },
     "health": {
       "type": "array",
       "description": "Health-check declarations. `type` references a built-in (`container-running` | `port-open` | `http-ok` | `file-exists` | `exec-zero`) or a profile-registered check id.",
-      "items": { "$ref": "#/$defs/HealthCheck" }
+      "items": {
+        "$ref": "#/$defs/HealthCheck"
+      }
     },
     "help": {
       "$ref": "#/$defs/Help",
@@ -50,11 +58,13 @@
     "mounts": {
       "type": "array",
       "description": "Explicit `{hostPath, containerPath, meta?}` candidates for `dev-cockpit mount`. Merged with `profile.mountCandidatesProvider()`.",
-      "items": { "$ref": "#/$defs/Mount" }
+      "items": {
+        "$ref": "#/$defs/Mount"
+      }
     },
     "mount": {
       "$ref": "#/$defs/MountSettings",
-      "description": "Overlay/manifest path overrides. Default overlay lives at <stateDir>/dev-mount-overlay.yml (out of the repo)."
+      "description": "Overlay/manifest path overrides. Default overlay lives at <stateDir>/dev-mount-overlay.yml (out of the repo). Set `overlayPath` when the project's compose chain (Makefile wildcard, compose -f include, etc.) expects the overlay at a fixed location."
     },
     "defaultPane": {
       "type": "string",
@@ -64,7 +74,9 @@
     "actions": {
       "type": "array",
       "description": "Named, key-bound shell commands surfaced via the `:` command palette and the Targets pane.",
-      "items": { "$ref": "#/$defs/Action" }
+      "items": {
+        "$ref": "#/$defs/Action"
+      }
     },
     "profile": {
       "type": "object",
@@ -76,13 +88,18 @@
     "NotifyOverride": {
       "description": "Either `false` (mute notifications for this item) or `{ onTransitionTo: [...] }` to override the global transition list.",
       "oneOf": [
-        { "type": "boolean", "const": false },
+        {
+          "type": "boolean",
+          "const": false
+        },
         {
           "type": "object",
           "properties": {
             "onTransitionTo": {
               "type": "array",
-              "items": { "type": "string" }
+              "items": {
+                "type": "string"
+              }
             }
           },
           "additionalProperties": false
@@ -93,18 +110,40 @@
       "type": "object",
       "required": ["id", "command"],
       "properties": {
-        "id": { "type": "string" },
-        "label": { "type": "string" },
-        "command": { "type": "string", "description": "Shell command. Spawned via the wrapper with the workspace as cwd by default." },
-        "cwd": { "type": "string", "description": "Workspace-relative override of the process working dir." },
-        "env": { "type": "object", "additionalProperties": { "type": "string" } },
-        "color": { "type": "string", "description": "ANSI colour for prefixed output (cyan / magenta / yellow / blue / green / red / white)." },
+        "id": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "command": {
+          "type": "string",
+          "description": "Shell command. Spawned via the wrapper with the workspace as cwd by default."
+        },
+        "cwd": {
+          "type": "string",
+          "description": "Workspace-relative override of the process working dir."
+        },
+        "env": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        "color": {
+          "type": "string",
+          "description": "ANSI colour for prefixed output (cyan / magenta / yellow / blue / green / red / white)."
+        },
         "restartOn": {
           "type": "array",
-          "items": { "type": "string" },
+          "items": {
+            "type": "string"
+          },
           "description": "Glob patterns; when a matching file changes, the process is killed + respawned."
         },
-        "notify": { "$ref": "#/$defs/NotifyOverride" }
+        "notify": {
+          "$ref": "#/$defs/NotifyOverride"
+        }
       },
       "additionalProperties": false
     },
@@ -112,9 +151,16 @@
       "type": "object",
       "required": ["id", "path"],
       "properties": {
-        "id": { "type": "string" },
-        "path": { "type": "string", "description": "Workspace-relative path to the repo root." },
-        "label": { "type": "string" }
+        "id": {
+          "type": "string"
+        },
+        "path": {
+          "type": "string",
+          "description": "Workspace-relative path to the repo root."
+        },
+        "label": {
+          "type": "string"
+        }
       },
       "additionalProperties": false
     },
@@ -122,8 +168,14 @@
       "type": "object",
       "required": ["name"],
       "properties": {
-        "name": { "type": "string", "description": "Compose service name." },
-        "tail": { "type": "boolean", "default": true }
+        "name": {
+          "type": "string",
+          "description": "Compose service name."
+        },
+        "tail": {
+          "type": "boolean",
+          "default": true
+        }
       },
       "additionalProperties": false
     },
@@ -136,7 +188,9 @@
         },
         "services": {
           "type": "array",
-          "items": { "$ref": "#/$defs/Service" },
+          "items": {
+            "$ref": "#/$defs/Service"
+          },
           "description": "Services to tail in the Output pane + reference as `container-running` health check targets."
         }
       },
@@ -146,7 +200,10 @@
       "type": "object",
       "required": ["pattern"],
       "properties": {
-        "pattern": { "type": "string", "description": "JavaScript-flavour regex." },
+        "pattern": {
+          "type": "string",
+          "description": "JavaScript-flavour regex."
+        },
         "severity": {
           "type": "string",
           "enum": ["info", "warn", "error"],
@@ -159,10 +216,21 @@
       "type": "object",
       "required": ["key", "label", "command"],
       "properties": {
-        "key": { "type": "string", "minLength": 1, "maxLength": 1, "description": "Single key character that triggers the remediation in the Health pane." },
-        "label": { "type": "string" },
-        "command": { "type": "string" },
-        "cwd": { "type": "string" }
+        "key": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1,
+          "description": "Single key character that triggers the remediation in the Health pane."
+        },
+        "label": {
+          "type": "string"
+        },
+        "command": {
+          "type": "string"
+        },
+        "cwd": {
+          "type": "string"
+        }
       },
       "additionalProperties": false
     },
@@ -170,8 +238,12 @@
       "type": "object",
       "required": ["id", "label", "type", "remediation"],
       "properties": {
-        "id": { "type": "string" },
-        "label": { "type": "string" },
+        "id": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
         "type": {
           "type": "string",
           "description": "Built-in: container-running | port-open | http-ok | file-exists | exec-zero. Profiles may register additional check types."
@@ -183,20 +255,57 @@
         },
         "triggers": {
           "type": "array",
-          "items": { "type": "string", "enum": ["startup", "fsevent", "lockfile", "docker"] },
+          "items": {
+            "type": "string",
+            "enum": ["startup", "fsevent", "lockfile", "docker"]
+          },
           "description": "When to re-run this check. Sensible defaults per check type when omitted."
         },
-        "url": { "type": "string", "description": "http-ok target." },
-        "expectStatus": { "type": "integer", "description": "http-ok success status (default 200)." },
-        "container": { "type": "string", "description": "container-running target — compose service or container name (substring match against `docker ps --filter name=`)." },
-        "port": { "type": "integer", "description": "port-open TCP port." },
-        "host": { "type": "string", "description": "port-open / http-ok host override (default 127.0.0.1)." },
-        "path": { "type": "string", "description": "file-exists path (workspace-relative)." },
-        "command": { "type": "string", "description": "exec-zero command to run (success = exit 0)." },
-        "args": { "type": "array", "items": { "type": "string" }, "description": "exec-zero argv." },
-        "cwd": { "type": "string", "description": "exec-zero cwd override." },
-        "notify": { "$ref": "#/$defs/NotifyOverride" },
-        "remediation": { "$ref": "#/$defs/Remediation" }
+        "url": {
+          "type": "string",
+          "description": "http-ok target."
+        },
+        "expectStatus": {
+          "type": "integer",
+          "description": "http-ok success status (default 200)."
+        },
+        "container": {
+          "type": "string",
+          "description": "container-running target — compose service or container name (substring match against `docker ps --filter name=`)."
+        },
+        "port": {
+          "type": "integer",
+          "description": "port-open TCP port."
+        },
+        "host": {
+          "type": "string",
+          "description": "port-open / http-ok host override (default 127.0.0.1)."
+        },
+        "path": {
+          "type": "string",
+          "description": "file-exists path (workspace-relative)."
+        },
+        "command": {
+          "type": "string",
+          "description": "exec-zero command to run (success = exit 0)."
+        },
+        "args": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "exec-zero argv."
+        },
+        "cwd": {
+          "type": "string",
+          "description": "exec-zero cwd override."
+        },
+        "notify": {
+          "$ref": "#/$defs/NotifyOverride"
+        },
+        "remediation": {
+          "$ref": "#/$defs/Remediation"
+        }
       },
       "additionalProperties": false
     },
@@ -205,25 +314,37 @@
       "properties": {
         "sources": {
           "type": "array",
-          "items": { "type": "string" },
+          "items": {
+            "type": "string"
+          },
           "description": "Workspace-relative paths to markdown dirs layered on top of built-in help."
         },
-        "defaultPage": { "type": "string", "description": "Slug of the page to land on when Help opens." }
+        "defaultPage": {
+          "type": "string",
+          "description": "Slug of the page to land on when Help opens."
+        }
       },
       "additionalProperties": false
     },
     "Notifications": {
       "type": "object",
       "properties": {
-        "enabled": { "type": "boolean", "default": true },
+        "enabled": {
+          "type": "boolean",
+          "default": true
+        },
         "onTransitionTo": {
           "type": "array",
-          "items": { "type": "string" },
+          "items": {
+            "type": "string"
+          },
           "description": "Severities that fire a notification on transition (default: [error, recovered])."
         },
         "exclude": {
           "type": "array",
-          "items": { "type": "string" },
+          "items": {
+            "type": "string"
+          },
           "description": "Check ids to mute even when their severity matches."
         }
       },
@@ -231,25 +352,59 @@
     },
     "Mount": {
       "type": "object",
-      "required": ["hostPath", "containerPath"],
+      "required": ["hostPath"],
       "properties": {
-        "hostPath": { "type": "string" },
-        "containerPath": { "type": "string" },
-        "meta": { "type": "object", "description": "Opaque to dev-cockpit core; consumed by profile hooks (e.g. awc reads meta.name and meta.type)." }
+        "hostPath": {
+          "type": "string"
+        },
+        "containerPath": {
+          "type": "string",
+          "description": "Absolute path inside the container. Required when kind='bind' (the default); omit for kind='symlink-only'."
+        },
+        "kind": {
+          "type": "string",
+          "enum": ["bind", "symlink-only"],
+          "description": "How the mount is materialised. 'bind' (default) emits a docker-compose bind into the overlay. 'symlink-only' skips the docker bind — used when a host-side symlink (via Profile.mountSymlinks) is the only artefact, e.g. when redirecting a pre-existing compose bind to a dev clone."
+        },
+        "meta": {
+          "type": "object",
+          "description": "Opaque to dev-cockpit core; consumed by profile hooks (e.g. awc reads meta.name and meta.type)."
+        }
       },
-      "additionalProperties": false
+      "additionalProperties": false,
+      "allOf": [
+        {
+          "if": {
+            "not": {
+              "properties": {
+                "kind": {
+                  "const": "symlink-only"
+                }
+              },
+              "required": ["kind"]
+            }
+          },
+          "then": {
+            "required": ["containerPath"]
+          }
+        }
+      ]
     },
     "MountSettings": {
       "type": "object",
       "properties": {
         "overlayPath": {
           "type": "string",
-          "description": "Override for the generated docker-compose overlay. Unset = <stateDir>/dev-mount-overlay.yml (recommended). Set values are workspace-relative; absolute paths honoured verbatim."
+          "description": "Override for the generated docker-compose overlay. Unset = <stateDir>/dev-mount-overlay.yml (out of the repo). Set this when the project's compose chain expects the overlay at a specific path — e.g. a wrapper Makefile wildcard or a `docker compose -f` include — that won't pick up the stateDir default. Relative values resolve against the workspace root; absolute paths honoured verbatim."
         },
         "manifestFile": {
           "type": "string",
           "default": "mount.manifest.json",
           "description": "Basename inside stateDir for the mount manifest."
+        },
+        "service": {
+          "type": "string",
+          "description": "Target compose service. Unset = first in docker.services."
         }
       },
       "additionalProperties": false
@@ -258,10 +413,19 @@
       "type": "object",
       "required": ["id", "label", "command"],
       "properties": {
-        "id": { "type": "string" },
-        "label": { "type": "string" },
-        "command": { "type": "string", "description": "Shell command to run. cwd defaults to the workspace." },
-        "cwd": { "type": "string" },
+        "id": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "command": {
+          "type": "string",
+          "description": "Shell command to run. cwd defaults to the workspace."
+        },
+        "cwd": {
+          "type": "string"
+        },
         "scope": {
           "type": "string",
           "pattern": "^(global|repos(:[\\w-]+)?)$",
@@ -278,10 +442,17 @@
       "allOf": [
         {
           "if": {
-            "properties": { "scope": { "type": "string", "pattern": "^repos(:.*)?$" } },
+            "properties": {
+              "scope": {
+                "type": "string",
+                "pattern": "^repos(:.*)?$"
+              }
+            },
             "required": ["scope"]
           },
-          "then": { "required": ["key"] }
+          "then": {
+            "required": ["key"]
+          }
         }
       ]
     }

package/examples/cockpit.yaml

@@ -7,8 +7,8 @@
 #   DEV_COCKPIT_CONFIG=<path> dev-cockpit dev   # one-shot env override
 #   dev-cockpit dev --config <path>          # one-shot CLI override
 
-version: 2                            # config schema version; required (v1 auto-migrated in memory)
-appName: my-app                       # state dir: ~/.local/state/my-app/<workspace-hash>/
+version: 2 # config schema version; required (v1 auto-migrated in memory)
+appName: my-app # state dir: ~/.local/state/my-app/<workspace-hash>/
 
 # Processes — long-running commands streamed into the Output pane.
 # Renamed from `watchers` in schema v2; v1 configs still load with a one-time warning.
@@ -25,7 +25,7 @@ processes:
     label: eslint
     command: npx eslint . --watch
     color: yellow
-    notify: false                     # mute notifications for this process
+    notify: false # mute notifications for this process
     restartOn:
       - package.json
       - .eslintrc.*
@@ -59,7 +59,7 @@ highlights:
     severity: error
   - pattern: WARN
     severity: warn
-  - pattern: "Stack trace"
+  - pattern: 'Stack trace'
     severity: error
 
 # Health checks — `type` references a built-in or profile-registered check id.
@@ -70,7 +70,7 @@ health:
     type: http-ok
     url: http://localhost:3000/health
     notify:
-      onTransitionTo: [error]         # only notify on going-down, not on recovery
+      onTransitionTo: [error] # only notify on going-down, not on recovery
     remediation:
       key: a
       label: restart api
@@ -122,6 +122,7 @@ notifications:
 # mount:
 #   overlayPath: docker/compose/dev-mount-overlay.yml   # workspace-relative
 #   manifestFile: mount.manifest.json                   # basename inside stateDir
+#   service: web                                      # target compose service (default: first in docker.services)
 
 # Actions — named, key-bound shell commands surfaced via the `:` palette and
 # the Targets pane. `scope` values: `global` | `repos` | `repos:<id>`.
@@ -133,7 +134,8 @@ actions:
     key: o
 
 # Which pane the cockpit lands on when it boots.
-defaultPane: repos                    # repos | output | health | help
+defaultPane: repos # repos | output | health | help
+
 
 # Profile-specific config lives under `profile.<name>` — validated by the
 # profile's `configSchemaExt` zod extension. Generic core ignores this block.