docs(dsh-plugin): clarify patch editing and reload behavior

This commit is contained in:
drakezhang
2026-09-08 19:34:25 +08:00
parent 187b088013
commit a3bb81bfab
+11 -3
View File
@@ -84,8 +84,10 @@ profile, the default location is `~/.dsh/profiles/web/cordis.patch.yml`. If you
`DSH_HOME`, use `$DSH_HOME/profiles/web/cordis.patch.yml` instead. Replace `web` with `DSH_HOME`, use `$DSH_HOME/profiles/web/cordis.patch.yml` instead. Replace `web` with
your profile name as needed. your profile name as needed.
Add the following entry to the file's patch list, or edit the existing If the file contains only comments and `[]`, keep the comments and replace `[]`
`id: browserskill` entry. This overrides the plugin registered by the installed bundle: with the YAML below. If it already contains patch entries, add this entry to the
existing list or edit its existing `id: browserskill` entry. Keep a single
top-level YAML list. This overrides the plugin registered by the installed bundle:
```yaml ```yaml
- id: browserskill - id: browserskill
@@ -101,7 +103,13 @@ Add the following entry to the file's patch list, or edit the existing
Change `bskPath` to the full path of your CLI binary if it is not on dsh's `PATH`. Change `bskPath` to the full path of your CLI binary if it is not on dsh's `PATH`.
A patch replaces the entry's entire `config` object, so keep all overrides you need A patch replaces the entry's entire `config` object, so keep all overrides you need
together in that object. Restart the profile to apply the configuration. together in that object.
Configuration changes follow `dsh.profile.patchReload` in the profile's
`package.json`: `live` (the default for `web`) applies changes when you save the
patch file; `startup` requires restarting the profile. Restart after upgrading
the plugin in either case.
All fields are optional; omitted fields use the defaults below: All fields are optional; omitted fields use the defaults below:
| Option | Default | Purpose | | Option | Default | Purpose |