devlanes 0.1.0 → 0.2.0

package/README.md

@@ -36,7 +36,7 @@ The package ships the JSON Schemas of the config files, exported as `devlanes/sc
 # yaml-language-server: $schema=./node_modules/devlanes/schema.json
 ```
 
-yaml-language-server resolves the path from the YAML file's directory, so it fits a `devlanes.yaml` next to `node_modules`.
+yaml-language-server resolves the path from the YAML file's directory, so it fits a `devlanes.yaml` next to `node_modules`. This copy matches the installed version. Without the package in the project, use `https://devlanes.run/v1/schema.json` and `https://devlanes.run/v1/user-schema.json`, which follow the latest stable release.
 
 ## Behaviour
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "devlanes",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Development environments in Git worktree lanes",
   "license": "Apache-2.0",
   "homepage": "https://devlanes.run",
@@ -26,9 +26,9 @@
     "node": ">=18"
   },
   "optionalDependencies": {
-    "@devlanes/darwin-arm64": "0.1.0",
-    "@devlanes/darwin-x64": "0.1.0",
-    "@devlanes/linux-arm64": "0.1.0",
-    "@devlanes/linux-x64": "0.1.0"
+    "@devlanes/darwin-arm64": "0.2.0",
+    "@devlanes/darwin-x64": "0.2.0",
+    "@devlanes/linux-arm64": "0.2.0",
+    "@devlanes/linux-x64": "0.2.0"
   }
 }

package/schema.json

@@ -1136,7 +1136,7 @@
               "type": "null"
             }
           ],
-          "description": "Action for newly discovered worktrees; defaults to register.",
+          "description": "What happens when a worktree gets its lane; defaults to register. A worktree\nbecomes a lane the first time devlanes runs in it (or `lane new` creates it),\nnot because it exists; only the primary worktree gets one on its own.",
           "examples": [
             "register",
             "setup",
@@ -1162,7 +1162,7 @@
               "type": "null"
             }
           ],
-          "description": "Stop processes or also clean lane data when a worktree disappears.",
+          "description": "What happens to a running lane whose worktree folder disappears; defaults to\nstop. A lane whose folder is gone and that runs nothing is cleaned; its logs\nstay until log retention removes them.",
           "examples": [
             "stop",
             "clean"
@@ -1203,7 +1203,7 @@
       "type": "object"
     },
     "NewWorktrees": {
-      "description": "Action when a new worktree appears; defaults to register.",
+      "description": "Action when a worktree gets its lane; defaults to register.",
       "examples": [
         "register",
         "setup",
@@ -1212,7 +1212,7 @@
       "oneOf": [
         {
           "const": "register",
-          "description": "Reserve a lane without running setup or services.",
+          "description": "Only reserve the lane: its index, ports and domain.",
           "examples": [
             "register"
           ],
@@ -1220,7 +1220,7 @@
         },
         {
           "const": "setup",
-          "description": "Run infrastructure setup and lane.create tasks, leaving services stopped.",
+          "description": "Also run infrastructure setup and lane.create tasks, leaving services stopped.",
           "examples": [
             "setup"
           ],
@@ -1228,7 +1228,7 @@
         },
         {
           "const": "start",
-          "description": "Start the worktree with the default profile.",
+          "description": "Also start the lane with the default profile.",
           "examples": [
             "start"
           ],
@@ -1543,7 +1543,7 @@
       ]
     },
     "RemovedWorktrees": {
-      "description": "Action when a worktree disappears; defaults to stop and retain its data.",
+      "description": "Action when a running lane's worktree folder disappears; defaults to stop.",
       "examples": [
         "stop",
         "clean"
@@ -1551,7 +1551,7 @@
       "oneOf": [
         {
           "const": "stop",
-          "description": "Stop the lane's processes but keep its data.",
+          "description": "Stop the lane's processes; once nothing runs, the lane is cleaned.",
           "examples": [
             "stop"
           ],
@@ -1559,7 +1559,7 @@
         },
         {
           "const": "clean",
-          "description": "Stop processes, run teardown, and free the lane.",
+          "description": "Clean the lane right away: stop processes, run teardown, and free the lane.",
           "examples": [
             "clean"
           ],
@@ -1912,6 +1912,17 @@
             "null"
           ]
         },
+        "name": {
+          "description": "Display name shown in the TUI and human output instead of the service key;\nany text, spaces allowed. Commands, references and `svc.<key>` keep using the key.",
+          "examples": [
+            "Admin API",
+            "Storefront (web)"
+          ],
+          "type": [
+            "string",
+            "null"
+          ]
+        },
         "next": {
           "$ref": "#/$defs/InjectedPresetOptions1",
           "description": "Options under the service's `next:` key.",
@@ -2738,7 +2749,7 @@
         },
         {
           "const": "lane.stop",
-          "description": "Run when the lane stops, but not on daemon shutdown.",
+          "description": "Run when the whole lane stops, on `devlanes daemon stop` and on `daemon restart`; skipped when a signal (logout, system shutdown) stops the daemon.",
           "examples": [
             "lane.stop"
           ],
@@ -2903,7 +2914,7 @@
       ]
     }
   },
-  "$id": "https://devlanes.run/schema/v1.json",
+  "$id": "https://devlanes.run/v1/schema.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "additionalProperties": false,
   "description": "Fully merged project configuration. Map order is declaration order.",

package/user-schema.json

@@ -97,7 +97,7 @@
       "examples": [
         {
           "remote_hosts_retention": "90d",
-          "retention": "30d"
+          "retention": "7d"
         }
       ],
       "properties": {
@@ -112,11 +112,11 @@
         },
         "retention": {
           "$ref": "#/$defs/ConfigDuration",
-          "default": "2592000000ms",
-          "description": "Maximum age since a unit or task finished; defaults to 30d. Disk pressure may prune it sooner.",
+          "default": "604800000ms",
+          "description": "Maximum age since a unit or task finished; defaults to 7d. Disk pressure may prune it sooner.",
           "examples": [
-            "30d",
-            "14d"
+            "7d",
+            "30d"
           ]
         }
       },
@@ -307,15 +307,16 @@
       "description": "Retention for monitor history used by graphs and service baselines, including database aggregates.",
       "examples": [
         {
-          "retention": "30d"
+          "retention": "7d"
         }
       ],
       "properties": {
         "retention": {
           "$ref": "#/$defs/ConfigDuration",
-          "default": "2592000000ms",
-          "description": "Maximum age of persisted monitor samples and database run summaries; defaults to 30d.",
+          "default": "604800000ms",
+          "description": "Maximum age of persisted monitor samples and database run summaries; defaults to 7d.",
           "examples": [
+            "7d",
             "30d"
           ]
         }
@@ -601,83 +602,28 @@
         "${{ lane.index }}"
       ]
     },
-    "Terminal": {
-      "description": "Terminal application used by open-in-terminal actions.",
-      "examples": [
-        "iterm2",
-        "ghostty",
-        "wezterm",
-        "kitty",
-        "terminal"
-      ],
-      "oneOf": [
-        {
-          "const": "iterm2",
-          "description": "Open a session in iTerm2 on macOS.",
-          "examples": [
-            "iterm2"
-          ],
-          "type": "string"
-        },
-        {
-          "const": "ghostty",
-          "description": "Open a session in Ghostty.",
-          "examples": [
-            "ghostty"
-          ],
-          "type": "string"
-        },
-        {
-          "const": "wezterm",
-          "description": "Open a session in WezTerm.",
-          "examples": [
-            "wezterm"
-          ],
-          "type": "string"
-        },
-        {
-          "const": "kitty",
-          "description": "Open a session in kitty.",
-          "examples": [
-            "kitty"
-          ],
-          "type": "string"
-        },
-        {
-          "const": "terminal",
-          "description": "Open a session in macOS Terminal.app.",
-          "examples": [
-            "terminal"
-          ],
-          "type": "string"
-        }
-      ]
-    },
     "TerminalConfig": {
       "anyOf": [
         {
-          "$ref": "#/$defs/Terminal",
-          "description": "Terminal app used by open-in-terminal actions; progress stays on auto.",
+          "description": "A terminal app name from when devlanes opened units in a new terminal\nwindow; that feature is gone, so the name is ignored with a warning.",
           "examples": [
             "ghostty"
-          ]
+          ],
+          "type": "string"
         },
         {
           "$ref": "#/$defs/TerminalSettings",
-          "description": "Terminal app and progress-bar setting written as separate fields.",
+          "description": "How devlanes uses the terminal's own progress bar.",
           "examples": [
             {
-              "app": "wezterm",
               "progress": "never"
             }
           ]
         }
       ],
-      "description": "The terminal app name alone, or a mapping with the app and the progress-bar setting.",
+      "description": "How devlanes uses the terminal, or (from older configs) a terminal app\nname, which is ignored.",
       "examples": [
-        "ghostty",
         {
-          "app": "ghostty",
           "progress": "auto"
         }
       ]
@@ -718,10 +664,9 @@
     },
     "TerminalSettings": {
       "additionalProperties": false,
-      "description": "Terminal app and how devlanes uses the terminal's own progress bar.",
+      "description": "How devlanes uses the terminal's own progress bar.",
       "examples": [
         {
-          "app": "ghostty",
           "progress": "auto"
         },
         {
@@ -729,22 +674,6 @@
         }
       ],
       "properties": {
-        "app": {
-          "anyOf": [
-            {
-              "$ref": "#/$defs/Terminal"
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "default": null,
-          "description": "Terminal app used by open-in-terminal actions; unset picks Terminal.app on macOS, else the first one installed.",
-          "examples": [
-            "ghostty",
-            "iterm2"
-          ]
-        },
         "progress": {
           "$ref": "#/$defs/TerminalProgress",
           "default": "auto",
@@ -865,9 +794,36 @@
       "examples": [
         {
           "open_on_start": false
+        },
+        {
+          "glyphs": "ascii",
+          "theme": "light"
+        },
+        {
+          "on_quit": "keep"
         }
       ],
       "properties": {
+        "glyphs": {
+          "$ref": "#/$defs/TuiGlyphs",
+          "default": "auto",
+          "description": "Symbols the TUI draws states and markers with; defaults to auto.",
+          "examples": [
+            "auto",
+            "unicode",
+            "ascii"
+          ]
+        },
+        "on_quit": {
+          "$ref": "#/$defs/TuiOnQuit",
+          "default": "ask",
+          "description": "What quitting the TUI does while lanes of the project on screen run; defaults to ask. The quit dialog's \"remember\" box writes it.",
+          "examples": [
+            "ask",
+            "keep",
+            "stop"
+          ]
+        },
         "open_on_start": {
           "default": true,
           "description": "Run `start`, `restart`, `lane resume` and `lane new --start` inside the TUI when typed at a terminal; defaults to true. false prints them as text, like `--no-ui` or DEVLANES_NO_UI=1.",
@@ -876,10 +832,132 @@
             false
           ],
           "type": "boolean"
+        },
+        "theme": {
+          "$ref": "#/$defs/TuiTheme",
+          "default": "auto",
+          "description": "Colors of the TUI; defaults to auto. NO_COLOR always turns colors off.",
+          "examples": [
+            "auto",
+            "dark",
+            "light",
+            "ansi"
+          ]
         }
       },
       "type": "object"
     },
+    "TuiGlyphs": {
+      "description": "Symbols the TUI draws with.",
+      "examples": [
+        "auto",
+        "unicode",
+        "ascii"
+      ],
+      "oneOf": [
+        {
+          "const": "auto",
+          "description": "Unicode when the locale is UTF-8, else ASCII.",
+          "examples": [
+            "auto"
+          ],
+          "type": "string"
+        },
+        {
+          "const": "unicode",
+          "description": "Unicode symbols such as ● ✕ ▾.",
+          "examples": [
+            "unicode"
+          ],
+          "type": "string"
+        },
+        {
+          "const": "ascii",
+          "description": "Plain ASCII, for fonts or terminals that draw Unicode symbols badly.",
+          "examples": [
+            "ascii"
+          ],
+          "type": "string"
+        }
+      ]
+    },
+    "TuiOnQuit": {
+      "description": "What quitting the TUI does with running lanes.",
+      "examples": [
+        "ask",
+        "keep",
+        "stop"
+      ],
+      "oneOf": [
+        {
+          "const": "ask",
+          "description": "Ask each time whether to keep the lanes running or stop them.",
+          "examples": [
+            "ask"
+          ],
+          "type": "string"
+        },
+        {
+          "const": "keep",
+          "description": "Close the TUI and leave every lane running in the daemon.",
+          "examples": [
+            "keep"
+          ],
+          "type": "string"
+        },
+        {
+          "const": "stop",
+          "description": "Stop the running lanes of the project on screen, then close the TUI.",
+          "examples": [
+            "stop"
+          ],
+          "type": "string"
+        }
+      ]
+    },
+    "TuiTheme": {
+      "description": "Colors of the TUI.",
+      "examples": [
+        "auto",
+        "dark",
+        "light",
+        "ansi"
+      ],
+      "oneOf": [
+        {
+          "const": "auto",
+          "description": "The terminal's 16 colors, or the dark or light palette when the terminal reports true color and its background.",
+          "examples": [
+            "auto"
+          ],
+          "type": "string"
+        },
+        {
+          "const": "dark",
+          "description": "The true-color palette for a dark background.",
+          "examples": [
+            "dark"
+          ],
+          "type": "string"
+        },
+        {
+          "const": "light",
+          "description": "The true-color palette for a light background.",
+          "examples": [
+            "light"
+          ],
+          "type": "string"
+        },
+        {
+          "const": "ansi",
+          "description": "The terminal's own 16 colors, which follow its theme.",
+          "examples": [
+            "ansi"
+          ],
+          "type": "string"
+        }
+      ]
+    },
     "UpdatesConfig": {
       "additionalProperties": false,
       "description": "Release checks: the daemon reads the latest release's version once a day and\ncommands print a one-line notice. Nothing is downloaded or installed.",
@@ -902,7 +980,7 @@
       "type": "object"
     }
   },
-  "$id": "https://devlanes.run/schema/user-v1.json",
+  "$id": "https://devlanes.run/v1/user-schema.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "additionalProperties": false,
   "description": "Per-user machine settings, separate from project configuration.",
@@ -914,7 +992,9 @@
       "ports": {
         "range": "20000-32767"
       },
-      "terminal": "ghostty"
+      "terminal": {
+        "progress": "auto"
+      }
     }
   ],
   "properties": {
@@ -922,13 +1002,13 @@
       "$ref": "#/$defs/HistoryConfig",
       "default": {
         "remote_hosts_retention": "7776000000ms",
-        "retention": "2592000000ms"
+        "retention": "604800000ms"
       },
       "description": "Retention for finished unit/task history and disconnected remote hosts in the database.",
       "examples": [
         {
           "remote_hosts_retention": "90d",
-          "retention": "30d"
+          "retention": "7d"
         }
       ]
     },
@@ -974,12 +1054,12 @@
     "metrics": {
       "$ref": "#/$defs/MetricsConfig",
       "default": {
-        "retention": "2592000000ms"
+        "retention": "604800000ms"
       },
       "description": "Retention for monitor history, including aggregates stored in the database.",
       "examples": [
         {
-          "retention": "30d"
+          "retention": "7d"
         }
       ]
     },
@@ -1059,11 +1139,9 @@
         }
       ],
       "default": null,
-      "description": "Terminal app for open-in-terminal actions, alone or with the progress-bar setting.",
+      "description": "How devlanes uses the terminal tab's progress bar during starts.",
       "examples": [
-        "ghostty",
         {
-          "app": "ghostty",
           "progress": "auto"
         }
       ]
@@ -1088,12 +1166,22 @@
     "tui": {
       "$ref": "#/$defs/TuiConfig",
       "default": {
-        "open_on_start": true
+        "glyphs": "auto",
+        "on_quit": "ask",
+        "open_on_start": true,
+        "theme": "auto"
       },
       "description": "How commands use the terminal UI.",
       "examples": [
         {
           "open_on_start": false
+        },
+        {
+          "glyphs": "ascii",
+          "theme": "light"
+        },
+        {
+          "on_quit": "keep"
         }
       ]
     },