dsh-wsl-tool 1.9.0 → 1.9.1

package/README.md

@@ -134,13 +134,16 @@ A background job is owned by the calling session (`owner: exec.agent.id`), which
 is what lets the model read it back with `job_output`/`job_kill` and what keeps
 other sessions out; an execution with no agent starts the job unowned.
 
-## A WSL terminal in the sidebar
+## Optional: a WSL terminal in the sidebar
 
-Installing this plugin also gives the desktop app's sidebar terminal a **WSL**
-shell. `cordis.patch.yml` overrides the composed `terminal-controller` row, whose
-configured shell is listed **first** and selected by default; the shells that row
-discovers (`powershell`, `cmd`, `bash`, …) stay selectable, so 新建终端 offers WSL
-next to them.
+The desktop app's sidebar terminal can open WSL instead of a Windows shell. It is
+**opt-in** — installing this plugin does not change which shell your terminals
+open — and the patch that enables it ships in the package as
+[`extras/terminal-wsl.patch.yml`](extras/terminal-wsl.patch.yml).
+
+To turn it on, copy that entry into your profile's own patch layer
+(`$DSH_HOME/profiles/<profile>/cordis.patch.yml`); a CLI launch can instead pass
+`--patch <path to the installed file>`. It applies at the next app start.
 
 ```yaml
 - id: terminal-controller
@@ -151,26 +154,19 @@ next to them.
       args: ['-e', 'bash', '-l']
 ```
 
+- The sidebar's 新建终端 list is built from the composed `terminal-controller`
+  row: it lists the configured `shell` first and keeps the shells it discovers
+  (`powershell`, `cmd`, `bash`, …) selectable. The picker is core UI, so overriding
+  that row is the supported way in — which is also why this cannot be a plain
+  plugin entry.
 - No distribution is pinned, so `wsl.exe` follows the system default — the same
-  rule the tools use when `DSH_WSL_DISTRO` is unset.
+  rule the tools use when `DSH_WSL_DISTRO` is unset. Add `-d <name>` to `args` to
+  pin one.
 - The session workspace is a Windows path that `wsl.exe` translates, so the
   terminal opens in `/mnt/<drive>/…` exactly like the Windows shells do; and it is
   a real PTY (`xterm-256color`), so full-screen programs work.
-- **Pinning a distribution, or choosing a different default, is a later patch
-  layer** — a profile's own `cordis.patch.yml` wins over this bundle:
-
-  ```yaml
-  - id: terminal-controller
-    config:
-      shell:
-        path: 'C:\Windows\System32\wsl.exe'
-        name: WSL
-        args: ['-d', 'Ubuntu-22.04', '-e', 'bash', '-l']
-  ```
-
-  An id-targeted patch replaces that row's whole config, so restate anything else
-  you had set on it.
-- Applies at the next app start.
+- An id-targeted patch replaces that row's whole config, so restate anything else
+  you had set on it (terminal limits, scrollback, a custom `shellCandidates` list).
 
 ## `wsl` parameters
 

package/README.zh-CN.md

@@ -116,11 +116,14 @@ DSH_SUBPROCESS_LOCAL=/path/to/dsh/node_modules npm run test:real
 `job_output`/`job_kill` 读回它的依据，也是其他会话读不到它的围栏；exec 里没有 agent 时
 任务则是无主的。
 
-## 在侧边栏开一个 WSL 终端
+## 可选：在侧边栏开一个 WSL 终端
 
-装了这个插件，桌面版侧边栏终端就多出一个 **WSL** shell：插件的 `cordis.patch.yml` 覆盖组合里的
-`terminal-controller` 行，而该行配置的 shell 会排在**第一位**并成为默认；它由 `shellCandidates`
-发现的 `powershell`/`cmd`/`bash` 等仍然可选，所以「新建终端」里 WSL 与它们并列。
+桌面版侧边栏终端可以开 WSL 而不是 Windows shell。这是**可选**的 —— 装插件**不会**改你终端默认
+开什么 —— 启用用的 patch 随包提供：[`extras/terminal-wsl.patch.yml`](extras/terminal-wsl.patch.yml)。
+
+启用方式：把里面的条目复制进你自己 profile 的 patch 层
+（`$DSH_HOME/profiles/<profile>/cordis.patch.yml`）；命令行启动也可以改成
+`--patch <已安装文件路径>`。**下次启动应用时生效。**
 
 ```yaml
 - id: terminal-controller
@@ -131,23 +134,15 @@ DSH_SUBPROCESS_LOCAL=/path/to/dsh/node_modules npm run test:real
       args: ['-e', 'bash', '-l']
 ```
 
-- **不锁定发行版**：`wsl.exe` 跟随系统默认，与工具在未设 `DSH_WSL_DISTRO` 时的规则一致。
+- 「新建终端」的列表来自组合里的 `terminal-controller` 行：它把配置的 `shell` 排在最前，同时保留
+  它发现的 `powershell`/`cmd`/`bash` 等可选。那个选择列表属于核心 UI，所以**按 id 覆盖该行**是
+  受支持的入口 —— 这也是它没法做成普通插件条目的原因。
+- **不锁定发行版**：`wsl.exe` 跟随系统默认，与工具在未设 `DSH_WSL_DISTRO` 时的规则一致。要锁定就
+  在 `args` 里加 `-d <名字>`。
 - 会话工作区是 Windows 路径，`wsl.exe` 会自动翻译，因此终端像 Windows shell 一样落在
   `/mnt/<盘>/…`；而且是**真 PTY**（`xterm-256color`），全屏程序可用。
-- **要锁定发行版或换默认 shell**，在更靠后的 patch 层里重述该行即可 —— profile 自己的
-  `cordis.patch.yml` 优先于本组合包：
-
-  ```yaml
-  - id: terminal-controller
-    config:
-      shell:
-        path: 'C:\Windows\System32\wsl.exe'
-        name: WSL
-        args: ['-d', 'Ubuntu-22.04', '-e', 'bash', '-l']
-  ```
-
-  按 id 的 patch 会**整段替换**该行 config，其他设置要一并重述。
-- **下次启动应用时生效。**
+- 按 id 的 patch 会**整段替换**该行 config，你之前在该行上设过的东西（终端上限、scrollback、
+  自定义 `shellCandidates`）要一并重述。
 
 ## `wsl` 参数
 

package/cordis.patch.yml

@@ -6,6 +6,10 @@
 # `tool "wsl" is already registered in this scope`. To keep the tools out of a
 # composition, override this row by id in a later patch layer (`- id: tool-wsl`
 # with `disabled: true`) instead of duplicating it.
+#
+# This file deliberately changes nothing else: installing a tool plugin must not
+# reshape someone's session. Pointing the desktop app's sidebar terminal at WSL is
+# offered as an opt-in instead — see `extras/terminal-wsl.patch.yml`.
 
 # The entry name is PATH-RELATIVE on purpose. DSH anchors a relative `name:` to
 # the directory of the patch file that declared it (`anchorInsertedPluginNames`),
@@ -19,35 +23,3 @@
 - insert:
     - id: tool-wsl
       name: './index.js'
-
-# ── Sidebar terminal: a WSL shell, listed first and selected by default ────────
-#
-# The desktop app's 新建终端 list is built from the composed `terminal-controller`
-# row: it discovers shells from `shellCandidates` and puts the configured `shell`
-# first. Overriding that row here is what makes installing this plugin also give
-# you a Linux terminal in the sidebar. (A candidate entry cannot do it: a shell
-# discovered by name gets `-i` appended, and `wsl.exe -i` is a hard error.)
-#
-# The path is absolute because the configured shell must resolve, and a shell that
-# cannot resolve makes every new terminal fail rather than just this one: wsl.exe
-# ships with Windows at a fixed location, so this resolves even where no
-# distribution is installed yet.
-#
-# No distro is pinned, so `wsl.exe` follows the system default — the same rule the
-# tools use when DSH_WSL_DISTRO is unset. Add `-d <name>` to `args` to pin one.
-#
-# This changes the default terminal shell, which is deliberate for a WSL plugin
-# and reversible: a later patch layer wins, so restating the row in a profile's own
-# cordis.patch.yml overrides it (and a profile that sets its own `shell` there is
-# unaffected by this row).
-#
-# An id-targeted patch replaces the whole config, so anything the layer below set
-# on this row (limits, scrollback, a custom shellCandidates list) falls back to its
-# schema default. Only `shell` is set here on purpose. Never add `disabled:` here:
-# that would switch off the terminal feature for the user instead of just this row.
-- id: terminal-controller
-  config:
-    shell:
-      path: 'C:\Windows\System32\wsl.exe'
-      name: WSL
-      args: ['-e', 'bash', '-l']

package/extras/terminal-wsl.patch.yml

@@ -0,0 +1,34 @@
+# OPTIONAL — give the desktop app's sidebar terminal a WSL shell.
+#
+# This is deliberately NOT part of the bundle patch: installing a tool plugin must
+# not change which shell someone's terminals open by default. To opt in, copy the
+# entry below into the profile's own patch layer
+# (`$DSH_HOME/profiles/<profile>/cordis.patch.yml`), or hand this file to a CLI
+# launch with `--patch <path to this file>`. It applies at the next app start.
+#
+# Why an id-targeted override: the sidebar's 新建终端 list is built from the
+# composed `terminal-controller` row, which discovers shells from
+# `shellCandidates` and lists the configured `shell` first. A candidate entry
+# cannot do it — a shell found by name gets `-i` appended, and `wsl.exe -i` is a
+# hard error. The picker itself is core UI, so a plugin cannot add an entry to it;
+# overriding the row is the supported way in.
+#
+# The path is absolute because a configured shell that fails to resolve makes every
+# new terminal fail, not just this one, and wsl.exe ships with Windows at a fixed
+# location whether or not a distribution is installed yet.
+#
+# No distribution is pinned, so `wsl.exe` follows the system default — the same
+# rule the tools use when `DSH_WSL_DISTRO` is unset. Add `-d <name>` to `args` to
+# pin one.
+#
+# An id-targeted patch replaces that row's whole config, so anything a layer below
+# set on it (terminal limits, scrollback, a custom `shellCandidates` list) falls
+# back to its schema default; only `shell` is set here on purpose. Never add
+# `disabled:` — that would switch the whole terminal feature off instead of
+# adjusting it.
+- id: terminal-controller
+  config:
+    shell:
+      path: 'C:\Windows\System32\wsl.exe'
+      name: WSL
+      args: ['-e', 'bash', '-l']

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dsh-wsl-tool",
-  "version": "1.9.0",
-  "description": "Run Linux commands from Windows through WSL, essentially matching a native Linux DSH for command execution: background jobs, stdin, path translation, a destructive-command guard and a WSL capability report. WSL calls run below the DSH sandbox, and a project on a Windows drive keeps Windows filesystem semantics.",
+  "version": "1.9.1",
+  "description": "Run Linux commands from Windows through WSL, essentially matching a native Linux DSH for command execution: background jobs, stdin, path translation, a destructive-command guard and a WSL capability report. Optionally gives the desktop app's sidebar terminal a WSL shell. WSL calls run below the DSH sandbox, and a project on a Windows drive keeps Windows filesystem semantics.",
   "type": "module",
   "main": "index.js",
   "license": "MIT",
@@ -30,6 +30,7 @@
     "README.md",
     "README.zh-CN.md",
     "PUBLISHING.md",
+    "extras",
     "screenshots.json",
     "assets",
     "LICENSE"