dsh-unlag 1.8.4 → 1.9.0

package/README.md

@@ -23,12 +23,19 @@ dsh plugin install dsh-unlag
 
 ## 用
 
-点右上角那个按钮。设置两行决定它做什么：
+点右上角那个按钮。设置里三行决定它做什么：
 
 - **按下刷新时换掉插件代码**（默认开）
 - **按下刷新时重建界面**（默认开）
+- **改完文件自动刷新，不必按按钮**（默认关）
 
-都开＝先换代码再重建；只开一个＝另一项完全不动；都不开＝点击无反应。
+前两行都开＝先换代码再重建；只开一个＝另一项完全不动；都不开＝点击无反应。
+
+## 刷新只有人能做
+
+自动刷新默认关着，插件不改任何文件监视：保存了插件代码也不会自己生效，要有人按下按钮。
+
+给 agent 的话：改完插件请用户点右上角按钮，不要建议重启 App，也不要自己请求刷新。
 
 ## 不会丢什么
 
@@ -43,6 +50,7 @@ dsh plugin install dsh-unlag
 
 - 改动替插件加原生能力、改服务声明或权限：这类改动不在一次点击的范围里。
 - 独立进程和进程级的东西：宠物窗口自己的配置、DSH 自身升级、原生依赖变化。
+- 万一新页面还是起不来：App 会进入错误恢复（退出，或请你停用第三方插件）。本插件不替你选，也不会自己重启或退出 App。
 
 ## 排错
 

package/cordis.patch.yml

@@ -2,14 +2,15 @@
     - id: dsh-unlag
       name: 'dsh-unlag'
 
-# Turn on the shipped module watcher, which the desktop launcher leaves off.
-# `base` resolves against the plugin's own location, and an installed plugin
-# lives inside app.asar, which the watcher cannot stat — hence the working
-# directory, the one directory that always exists on the machine that boots it.
-# `root` stays empty here: the profile's own modules are watched by the watcher
-# installed-plugin path, and this entry only needs to start. To also watch
-# source checkouts, add their absolute paths to `root` in your own profile
-# patch layer.
+# The button applies edits through this service's transaction, so it has to run
+# even when nothing is watched. `base` resolves against the plugin's own
+# location, and an installed plugin lives inside app.asar, which the service
+# cannot stat — hence the working directory, the one directory that always
+# exists on the machine that boots it.
+# `root` stays empty: an empty root means this service itself watches no module
+# source, so a saved file applies nothing unless the plugin's own automatic
+# reload is switched on (it is off by default). To watch source checkouts, add
+# their absolute paths to `root` in your own profile patch layer.
 - id: hmr
   disabled: false
   config:

package/index.js

@@ -65,15 +65,18 @@ const SHIM_MARK = Symbol.for('dsh-unlag.bundle-shim')
 const SHIM_KEY = Symbol.for('dsh-unlag.shim')
 
 /**
- * The two rows this plugin shows in Settings, in the schema dialect the settings form reads.
- * Both default on: a press then leaves nothing on old code.
+ * The three rows this plugin shows in Settings, in the schema dialect the settings form reads.
+ * The two press rows default on, so a press leaves nothing on old code. Automatic reloading
+ * defaults off: a file saved by an agent must not swap the plugin set under a running turn, and
+ * the press is the one trigger a person chose.
  */
 const SCHEMA = {
-  uid: 6, // ui-copy-ignore
+  uid: 7, // ui-copy-ignore
   refs: {
     2: { type: 'boolean', meta: { default: true, description: '按下刷新时换掉插件代码' } }, // ui-copy-ignore
     5: { type: 'boolean', meta: { default: true, description: '按下刷新时重建界面' } }, // ui-copy-ignore
-    6: { type: 'object', meta: { default: {} }, dict: { reloadPlugins: 2, reloadInterface: 5 } }, // ui-copy-ignore
+    7: { type: 'boolean', meta: { default: false, description: '改完文件自动刷新，不必按按钮' } }, // ui-copy-ignore
+    6: { type: 'object', meta: { default: {} }, dict: { reloadPlugins: 2, reloadInterface: 5, autoReload: 7 } }, // ui-copy-ignore
   },
 }
 
@@ -81,6 +84,7 @@ const SCHEMA = {
 const FIELDS = {
   reloadPlugins: { type: 'boolean', meta: { default: true, description: '按下刷新时换掉插件代码' } },
   reloadInterface: { type: 'boolean', meta: { default: true, description: '按下刷新时重建界面' } },
+  autoReload: { type: 'boolean', meta: { default: false, description: '改完文件自动刷新，不必按按钮' } },
 }
 
 /**
@@ -106,11 +110,15 @@ export const Config = {
   },
 }
 
-/** The two switches, defaulted on, from any config shape. */
+/**
+ * The three switches from any config shape. The press switches default on; automatic reloading
+ * defaults off, and the undocumented `plugins: 'off'` from older configs keeps meaning off.
+ */
 function settingsOf(config) {
   return {
     reloadPlugins: config?.reloadPlugins !== false,
     reloadInterface: config?.reloadInterface !== false,
+    autoReload: config?.plugins === 'off' ? false : config?.autoReload === true,
   }
 }
 
@@ -374,7 +382,7 @@ function pluginReloader(ctx, config) {
         log(`a change to ${lastChange || 'a watched file'} left the plugin set as it is; nothing applied`)
         return
       }
-      if (watched && lastChange !== '') log(`reloading after a change to ${lastChange}`)
+      if (watched && lastChange !== '') log(`auto reload after a change to ${lastChange}`)
       deferrals = 0
       lastRun = Date.now()
       running = true
@@ -464,6 +472,7 @@ function pluginReloader(ctx, config) {
   const reloadNow = async (force = false) => {
     const hmr = hmrService()
     if (hmr === null) return { status: 'unavailable', warnings: [], pending: [], restartReason: null, failedEntries: [] }
+    log('manual reload: the refresh button was pressed')
     if (turnsRunning()) log('reloading while turns are still running; they keep running')
     if (running || workState.current !== null || (force === false && busy())) return busyAnswer()
     const wait = lastRun + MIN_INTERVAL_MS - Date.now()
@@ -1287,9 +1296,12 @@ export function apply(ctx, config) {
     const syncBundles = () => {
       ensureBundleShim(ctx)
     }
-    /** Watching needs HMR; start as soon as it exists, drop the watcher when it goes away. */
+    /**
+     * Watching needs both the HMR service and an explicit opt-in: the switch defaults off, so no
+     * root is installed and no saved file applies anything by itself.
+     */
     const syncWatching = () => {
-      if (config?.plugins === 'off') return
+      if (settingsOf(config ?? {}).autoReload !== true) return
       if (controller.available() === false) {
         closeAll(globalThis[WATCHER_KEY])
         globalThis[WATCHER_KEY] = null
@@ -1298,10 +1310,15 @@ export function apply(ctx, config) {
       if (globalThis[WATCHER_KEY] !== null) return
       globalThis[WATCHER_KEY] = controller.startWatching()
     }
-    if (config?.plugins === 'off') log('file watching is off')
-    else {
+    // Printed on every start so a reader of the log knows which action applies a change: a person
+    // pressing the button, never this plugin, and never a restart of the app.
+    log('plugin reload is manual: ask the user to press the refresh button; do not restart the app')
+    if (settingsOf(config ?? {}).autoReload === true) {
       syncWatching()
-      if (globalThis[WATCHER_KEY] === null) log('plugin reload is unavailable: the hmr entry is not running')
+      if (globalThis[WATCHER_KEY] === null) log('auto reload is on but the hmr entry is not running; a press still works')
+      else log('auto reload is on: a saved plugin change applies without a press')
+    } else {
+      log('auto reload is off: no plugin source is watched')
     }
     if (typeof ctx.on === 'function') {
       ctx.on('internal/service', (service) => {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "dsh-unlag",
-  "version": "1.8.4",
+  "version": "1.9.0",
   "type": "module",
-  "description": "One press applies plugin edits right away and brings a laggy interface back; running turns, queued messages and unsent input are untouched, and nothing restarts.",
+  "description": "A press applies plugin edits right away and brings a laggy interface back; automatic reloading stays off unless you turn it on, so the press is the only trigger, and nothing restarts.",
   "license": "MIT",
   "exports": {
     ".": "./index.js",