dsh-napcat-keeper 2.7.2 → 2.7.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 2.7.3 — 修「设置页保存不进去」+ README 补「装不上」的两条排障
+- **修了个真 bug，2.7.0 起就有**：设置页点「保存」、「用这个」、或者「清除密码」，值当场弹回原样，什么都没存下来。起因是 2.7.0 把插件自己的文件收进 `~/.dsh/dsh-napcat-keeper/` 时，只把**读取**改成了新目录，**写入**还留在老地方 `~/.dsh/config.json` —— 于是存进一个没人读的文件，界面重新渲染时拿到的还是旧值。2.7.0 / 2.7.1 / 2.7.2 都中招。
+- 现在读和写认同一个目录（`saveAndApply` 与「清除密码」都改走 `keeperDir()`）。
+- **老版本留下的那份被误写的配置会被自动认领**：启动时如果发现 `~/.dsh/config.json` 里有 `shellDir` / `onebotPort` 这类自家字段、而且比插件目录里的配置新，就把它的内容并进真配置（多半正是你当初点了保存却没生效的那次），原文归档进 `legacy/config.adopted-*.json`，认领前的旧配置备份成 `legacy/config.before-adopt.json`。不像插件配置的 `config.json` 一概不碰，也不会拿旧文件顶掉更新的配置。
+- 补了 `pnpm selftest:save`（12 项）：保存真的落到新目录、认领逻辑、keeper 更新时不认领、别人的 `config.json` 不动。
+- **没发版，顺带补了 README 两条排障**：有人从 GitHub 装插件报 `'git' is not recognized as an internal or external command`，查下来是对方机器没装 Git —— `github:` 规格要 pnpm 调外部 `git ls-remote`，插件一个字节都还没下载，跟插件本身无关（npm 上的 2.7.2 一直正常）。
+- 「安装」那节加了一句：**别加 `github:` 前缀**，用 npm 名装全程不碰 git。
+- 「常见问题」补一条，三条路：npm 名装 / 装 Git 后**彻底重启 DSH**（子进程继承 DSH 启动时的 PATH，不重启照旧报错）/ 无 git 时走 `codeload` 的 tarball。
+- 又有人报 `无法识别这个包名或地址：not a package name the registry accepts`：那是 DSH「设置 → 插件 → 添加插件」输入框的**规格校验**，跟插件和网络都无关 —— 他把整条命令（或 `add dsh-napcat-keeper` 这种）粘进了只认「包名 / 仓库地址 / 本地目录」的那一栏。桌面版安装目录里根本没有 `dsh` 命令，用户只能走界面，于是把命令行原样贴进去。
+- README「安装」改成**先桌面版点界面、再命令行**两条路，并点明那一栏只填 `dsh-napcat-keeper`；「常见问题」再加一条，用表格列清楚哪些写法会被拒（整条命令 / 多出的 `add` / 大写 / 全角标点）。
+- 已经在 2.7.0~2.7.2 上装过的，升级到 2.7.3 就行：配置会被自动认领回来，不用手改任何文件。
+
 ## 2.7.2 — 根上一点不留
 - **修的什么**：2.7.0 的搬迁兜底扫描会跳过「规范老名字」（`napcat-keeper-state.json` 这种已经安排好去处的），本意是别把刚搬完的东西又归一次档。但碰上**目标位已经有同名文件**的情况（新目录里先躺着一份 `state.json`），根上那份老的既搬不走、也不归档，就永远留在 `~/.dsh` 根上了 —— 正是这次要收拾的那种乱。
 - 现在兜底扫描不再挑名字：只要还留在根上、名字对得上插件的老命名，一律归档进 `legacy/`；被别的进程攥着搬不动的，下次启动再搬。跑完根上一个不剩。

package/README.md

@@ -40,10 +40,26 @@
 
 ## 安装
 
+**桌面版（点界面的）**：设置 → 插件 → **添加插件**，「包名或地址」那一栏只填包名 ——
+
+```
+dsh-napcat-keeper
+```
+
+> 只填包名，**别把整条命令粘进去**：那一栏是按「包名 / 仓库地址 / 本地目录」解析的，
+> 多一个空格、多一个 `add`、多一个大写字母，就会报 `无法识别这个包名或地址：not a package name the registry accepts`。
+> 顺带一提，桌面版装完之后 DSH 目录里并没有 `dsh` 命令，所以下面那条命令行不是人人都能跑 —— 用不了就走上面这条路。
+
+**命令行**：
+
 ```bash
 dsh plugin --profile <profile> add dsh-napcat-keeper
 ```
 
+> **别加 `github:` 前缀。** 写成 `add github:waning-sun/dsh-napcat-keeper` 走的是 git 通道，pnpm 会去调外部 `git ls-remote`；
+> 机器上没装 Git（或者 Git 不在 PATH 里）就当场报 `'git' is not recognized as an internal or external command`。
+> 上面这条是 npm 名安装，全程不碰 git。真踩到了看「常见问题」里 `'git' is not recognized` 那条。
+
 装完重启一次 DSH（第一次装载才生效），然后去 **设置 → napcat桥**。
 
 ## 首次配置：其实就三个空
@@ -293,6 +309,36 @@ npm run check:privacy              # 只查隐私（发版前必跑）
 2.2.1 之前是 `settings.section` 钩子签名对不上新版 DSH（抛 `Cannot add property N, object is not extensible`），异常冒到设置面板层，整个面板一起白。升级后重开 DSH 即可。
 另外设置页会轮询 `/state`，2.2.1 起热路径有 300 秒进程快照缓存，不再每次都新起 PowerShell；如果你自己写脚本调这个接口，加 `?light=1` 只读缓存、不扫描进程。
 
+**装的时候报 `'git' is not recognized as an internal or external command`？**
+不是插件的问题。那句是 pnpm 在解析 **git 规格的依赖**（`github:owner/repo`、`git+https://…`）时调的外部 `git`；
+DSH 自带的 pnpm 不捎带 git，Windows 上又默认没装，于是就卡在「拉代码」这一步，插件一个字节都还没下载。
+包里的 `lib/` 本来就是入库的、没有构建步骤，所以跟「源码要编译」也没关系。三条路，越靠前越省事：
+
+1. **用 npm 名装** —— 就是上面「安装」那节那条命令，全程不碰 git。
+2. **装 Git**：`winget install --id Git.Git -e`，或者从 [git-scm.com](https://git-scm.com/download/win) 下安装包。
+   装完 **必须彻底退出 DSH 再重开**：pnpm 是 DSH 的子进程，继承的是 DSH 启动那一刻的 PATH，
+   不重启会继续报一模一样的错（很多人以为白装了）。重开后在新的终端里 `git --version` 有输出，再去装插件。
+3. **不装 git、又非要从 GitHub 拉**：改用源码 tarball，pnpm 走 HTTPS 下载、不调 git ——
+   `dsh plugin --profile <profile> add https://codeload.github.com/waning-sun/dsh-napcat-keeper/tar.gz/refs/heads/main`
+   仓库目前没打 tag，所以只能指 `refs/heads/main`；缺点是版本号只能读包里的 `package.json`，也不跟着发版更新。
+
+**装的时候报 `无法识别这个包名或地址：not a package name the registry accepts`？**
+这句是 DSH 在**解析你填的那串字**，还没到下载那一步 —— 跟插件、跟网络都没关系。它是「设置 → 插件 → 添加插件」
+那个输入框的校验：那一栏认三种东西，**npm 包名**（`dsh-napcat-keeper`、`@作者/名字`）、**仓库地址**（`https://github.com/…`）、
+**本地目录**。包名只允许小写字母、数字和 `. _ ~ -`，所以下面这些写法一律被拒：
+
+| 填进去的 | 结果 |
+| --- | --- |
+| `dsh-napcat-keeper` | ✅ |
+| `dsh-napcat-keeper@2.7.3` | ✅（指定版本） |
+| `dsh plugin --profile desktop add dsh-napcat-keeper` | ❌ 整条命令 |
+| `add dsh-napcat-keeper` | ❌ 多了 `add` |
+| `Dsh-napcat-keeper` | ❌ 大写 |
+| `dsh-napcat-keeper。`、`dsh-napcat-keeper；` | ❌ 全角标点 |
+
+改法就一句：**那一栏只填 `dsh-napcat-keeper`**（要指定版本就 `dsh-napcat-keeper@2.7.3`）。想跑命令行的话，得在终端里跑，
+不是在输入框里跑。
+
 ## License
 
 MIT

package/lib/index.js

@@ -1,9 +1,15 @@
 /**
- * dsh-napcat-keeper —— NapCat 看门狗 v2.7.2（可发布通用版）
+ * dsh-napcat-keeper —— NapCat 看门狗 v2.7.3（可发布通用版）
  *
  * 解决的问题：DSH 是桌面应用，重启 DSH 时 NapCat(QQ 协议端) 不会跟着起来，
  * 于是 dsh-qq-bridge 一直轮询一个死端口，你在 QQ 里说的话就石沉大海。
  *
+ * v2.7.3：设置页保存不再空转
+ *   - 2.7.0 把配置文件收进 keeperDir 时只改了「读」，saveAndApply / clearPassword
+ *     还在写 ~/.dsh/config.json，于是点保存 / 点「用这个」之后值立刻弹回原样；
+ *   - 现在读写都走 keeperDir；启动时还会把那份误写的 ~/.dsh/config.json 认领回来
+ *     （带自家字段且比 keeper 里的新才认领，原文归档进 legacy/）。
+ *
  * v2.7.2：根上一点不留
  *   - 搬迁的兜底扫描原先跳过「规范老名字」，于是目标位已经有同名文件时（比如新目录里
  *     已经躺着一份 state.json），根上那份老文件既搬不走、也不归档，永远留在那儿；
@@ -132,7 +138,7 @@ import { homedir, tmpdir } from 'node:os'
 import path from 'node:path'
 
 export const name = 'napcat-keeper'
-export const version = '2.7.2'
+export const version = '2.7.3'
 
 /** tools 用来注册 napcat_* 工具；webServer 用来挂设置界面接口。拿不到也不至于把 DSH 拖崩。 */
 export const inject = ['tools', 'webServer']
@@ -309,6 +315,59 @@ function moveOne(from, to) {
   }
 }
 
+/**
+ * 认领 2.7.0~2.7.2 因保存 bug 误写到 ~/.dsh/config.json 的那份配置。
+ *
+ * 那三个版本的 saveAndApply 写的是 dshHome()/config.json，而所有读取都走 keeperDir()，
+ * 于是用户每次「保存设置」只是往一个没人读的文件里抄了一遍 —— 值当场弹回旧的样子。
+ * 升级到修好的版本后，把那份（可能是用户最后一次真正想保存的内容）并进真配置里，原文归档进 legacy/。
+ *
+ * 只在不含糊的前提下动手：根上得有 config.json、得能解析成对象、得带至少两个自家字段
+ * （别把别的程序放在 ~/.dsh 的 config.json 抢走），而且它得比 keeper 里的新 ——
+ * 修好以后再保存就会写 keeper，mtime 立刻反超，这条认领自然不会再触发。
+ */
+function adoptStrayConfig(dir) {
+  const home = dshHome()
+  const stray = path.join(home, 'config.json')
+  const target = configFilePath(dir)
+  let strayAt
+  try {
+    strayAt = statSync(stray).mtimeMs
+  } catch {
+    return 0
+  }
+  let mine = false
+  let parsed = null
+  try {
+    parsed = JSON.parse(readFileSync(stray, 'utf8').replace(/^\uFEFF/, ''))
+  } catch {
+    return 0
+  }
+  if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) return 0
+  const marks = ['shellDir', 'onebotPort', 'launchAccount', 'taskName', 'procPathMatch', 'scanTimeoutSec']
+  if (marks.filter((k) => Object.prototype.hasOwnProperty.call(parsed, k)).length < 2) return 0
+  try {
+    mine = statSync(target).mtimeMs < strayAt
+  } catch {
+    mine = true // keeper 里还没有配置，那它就是唯一的一份
+  }
+  if (!mine) return 0
+  const keep = readConfigFile(dir)
+  const merged = { ...keep, ...parsed }
+  try {
+    mkdirSync(path.join(dir, 'legacy'), { recursive: true })
+    if (existsSync(target)) {
+      copyFileSync(target, path.join(dir, 'legacy', 'config.before-adopt.json'))
+    }
+    writeConfigFile(dir, merged)
+    // 归档原文，不留一份会被下次认领的副本
+    moveOne(stray, path.join(dir, 'legacy', `config.adopted-${new Date().toISOString().replace(/[:.]/g, '-')}.json`))
+    return 1
+  } catch {
+    return 0
+  }
+}
+
 /** 把老版本散在 ~/.dsh 根上的文件搬进 keeperDir；重复调用是空操作，返回搬了几个 */
 function migrateLegacyFiles(dir) {
   const target = dir || keeperDir()
@@ -343,6 +402,8 @@ function migrateLegacyFiles(dir) {
       } catch {}
     }
   } catch {}
+  // 根上那份 config.json 是 2.7.0~2.7.2 的保存 bug 留下的，认领回来
+  if (adoptStrayConfig(target)) moved += 1
   lastMigrated = moved
   return moved
 }
@@ -3069,8 +3130,12 @@ function uiStateFull(cfg) {
 
 /** 保存配置：写文件 → 重新解析 → 热应用（不用重启 DSH） */
 function saveAndApply(ctx, patch) {
-  const home = dshHome()
-  const fileCfg = { ...readConfigFile(home) }
+  // ⚠ 必须读写的都是 keeperDir()：resolveConfig 读的是 <keeperDir>/config.json。
+  // 2.7.0 把配置收进 keeperDir 时只改了「读」，这两行还留着 dshHome()，
+  // 于是 2.7.0~2.7.2 的「保存设置」全写进了 ~/.dsh/config.json —— 谁都不读它。
+  // 表现：设置页点保存/点「用这个」之后，值立刻弹回空。
+  const dir = keeperDir()
+  const fileCfg = { ...readConfigFile(dir) }
   for (const [key, value] of Object.entries(patch || {})) {
     if (!Object.prototype.hasOwnProperty.call(DEFAULTS, key)) continue
     if (key === 'quickPassword') {
@@ -3098,7 +3163,7 @@ function saveAndApply(ctx, patch) {
     }
     fileCfg[key] = value == null ? '' : String(value).trim()
   }
-  const written = writeConfigFile(home, fileCfg)
+  const written = writeConfigFile(dir, fileCfg)
   const prev = state.cfg
   const next = resolveConfig(state.patchConfig || {})
   state.cfg = next
@@ -3190,11 +3255,12 @@ async function doAction(ctx, cfg, action, payload) {
     }
     case 'clearPassword': {
       // 把密码从本机彻底删掉：配置文件两条 + 中间层 bat，再让任务回到不带密码的样子
-      const home = dshHome()
-      const fileCfg = { ...readConfigFile(home) }
+      // 同样必须落在 keeperDir() 的 config.json 上，否则删的是一份没人读的文件（见 saveAndApply 注释）
+      const dir = keeperDir()
+      const fileCfg = { ...readConfigFile(dir) }
       fileCfg.rememberPassword = false
       fileCfg.quickPassword = ''
-      writeConfigFile(home, fileCfg)
+      writeConfigFile(dir, fileCfg)
       const next = resolveConfig(state.patchConfig || {})
       state.cfg = next
       removeEnvBat(next)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-napcat-keeper",
-  "version": "2.7.2",
+  "version": "2.7.3",
   "description": "发现没有能够随着dsh打开自动启动napcat的插件，遂使用大肥鱼制作此插件，建议搭配Yuuyuko-uu的dsh-qq-bridge使用~",
   "type": "module",
   "main": "lib/index.js",
@@ -24,6 +24,7 @@
     "check:fix": "node scripts/check-manifest.mjs --fix",
     "smoke:client": "node scripts/smoke-client.mjs",
     "selftest:scan": "node scripts/selftest-scan.mjs",
+    "selftest:save": "node scripts/selftest-save.mjs",
     "selftest:setup": "node scripts/selftest-setup.mjs"
   },
   "keywords": [

package/scripts/selftest-save.mjs

@@ -0,0 +1,100 @@
+/**
+ * 「保存设置」回归自检。
+ *
+ * 守的是 2.7.0 引入、2.7.3 修掉的那个 bug：saveAndApply 写的是 $DSH_HOME/config.json，
+ * 而所有读取都走 <keeperDir>/config.json，于是设置页点保存/点「用这个」之后值立刻弹回空。
+ *
+ * 全程在临时 DSH_HOME 里跑，不碰真实配置。
+ *   node scripts/selftest-save.mjs
+ */
+import { existsSync, mkdtempSync, readFileSync, readdirSync, utimesSync, writeFileSync, mkdirSync } from 'node:fs'
+import { tmpdir } from 'node:os'
+import path from 'node:path'
+
+let pass = 0
+let fail = 0
+const ok = (cond, name, extra = '') => {
+  if (cond) {
+    pass += 1
+    console.log(`  ✓ ${name}`)
+  } else {
+    fail += 1
+    console.log(`  ✗ ${name}${extra ? ' — ' + extra : ''}`)
+  }
+}
+
+const freshHome = (tag) => {
+  const home = mkdtempSync(path.join(tmpdir(), `npk-save-${tag}-`))
+  process.env.DSH_HOME = home
+  return { home, dir: path.join(home, 'dsh-napcat-keeper') }
+}
+
+const loadInternals = async () => (await import('../lib/index.js?t=' + Date.now())).__internals
+
+const fakeCtx = { effect: (fn) => fn(), logger: null, tools: { register() {} } }
+const readJson = (file) => JSON.parse(readFileSync(file, 'utf8').replace(/^\uFEFF/, ''))
+
+/* 1. 保存必须落到 keeperDir/config.json，回读一致 --------------------------- */
+console.log('1) saveAndApply 真的写进 keeperDir 了吗')
+{
+  const { home, dir } = freshHome('write')
+  const { resolveConfig, saveAndApply } = await loadInternals()
+  const target = 'D:/fake/NapCat.Shell'
+  const next = saveAndApply(fakeCtx, { shellDir: target, onebotPort: 3011 })
+  ok(next.shellDir === target, 'saveAndApply 返回值里就有新值', JSON.stringify(next.shellDir))
+  ok(existsSync(path.join(dir, 'config.json')), 'keeperDir/config.json 被写出来了')
+  ok(readJson(path.join(dir, 'config.json')).shellDir === target, '落盘内容对得上')
+  ok(!existsSync(path.join(home, 'config.json')), '根上没再冒出 config.json')
+  ok(resolveConfig({}).shellDir === target, '重新 resolveConfig 读回新值（重启 DSH 后也生效）')
+}
+
+/* 2. 老版本误写的那份要被认领回来 ------------------------------------------- */
+console.log('\n2) 认领 2.7.0~2.7.2 误写到根上的 config.json')
+{
+  const { home, dir } = freshHome('adopt')
+  mkdirSync(dir, { recursive: true })
+  writeFileSync(path.join(dir, 'config.json'), JSON.stringify({ shellDir: '', onebotPort: 3000 }, null, 2) + '\n')
+  // 根上那份是「用户最后一次点保存」的内容，比 keeper 的新
+  const stray = path.join(home, 'config.json')
+  writeFileSync(stray, JSON.stringify({ shellDir: 'E:/NapCat.Shell', onebotPort: 3000, launchAccount: '10001' }, null, 2) + '\n')
+  const old = (Date.now() - 60000) / 1000
+  utimesSync(path.join(dir, 'config.json'), old, old)
+
+  const { resolveConfig } = await loadInternals()
+  ok(resolveConfig({}).shellDir === 'E:/NapCat.Shell', '认领后读到的就是用户当初想存的那份')
+  ok(!existsSync(stray), '根上那份已归档，不会下次又被认领一遍')
+  const leg = readdirSync(path.join(dir, 'legacy'))
+  ok(leg.some((f) => f.startsWith('config.adopted-')), '原文留在 legacy/ 里（可回滚）', leg.join(','))
+}
+
+/* 3. keeper 更新时不许被根上那份覆盖 ---------------------------------------- */
+console.log('\n3) keeper 比根上新时不认领（别把新配置写旧）')
+{
+  const { home, dir } = freshHome('noadopt')
+  mkdirSync(dir, { recursive: true })
+  writeFileSync(path.join(dir, 'config.json'), JSON.stringify({ shellDir: 'F:/good', onebotPort: 3000, launchAccount: '1' }, null, 2) + '\n')
+  const stray = path.join(home, 'config.json')
+  writeFileSync(stray, JSON.stringify({ shellDir: 'G:/stale', onebotPort: 3000, launchAccount: '1' }, null, 2) + '\n')
+  const old = (Date.now() - 120000) / 1000
+  utimesSync(stray, old, old)
+
+  const { resolveConfig } = await loadInternals()
+  ok(resolveConfig({}).shellDir === 'F:/good', 'keeper 里的值没被旧文件顶掉')
+  ok(existsSync(stray), '不认领就不动它')
+}
+
+/* 4. 不是自家的 config.json 不许抢 ----------------------------------------- */
+console.log('\n4) 根上的 config.json 若不像插件的，一概不碰')
+{
+  const { home, dir } = freshHome('foreign')
+  mkdirSync(dir, { recursive: true })
+  const stray = path.join(home, 'config.json')
+  writeFileSync(stray, JSON.stringify({ theme: 'dark', language: 'zh-CN' }, null, 2) + '\n')
+  const { resolveConfig } = await loadInternals()
+  resolveConfig({})
+  ok(existsSync(stray), '别人的 config.json 原样留着')
+  ok(!existsSync(path.join(dir, 'config.json')), '也没凭空造一份 keeper 配置')
+}
+
+console.log(`\n结果：${pass} 通过，${fail} 失败`)
+process.exit(fail ? 1 : 0)