From d926ed71c43a1844be93f381c0ee5dae728f7653 Mon Sep 17 00:00:00 2001 From: Nicholas023 Date: Thu, 5 Nov 2026 00:32:13 +0800 Subject: [PATCH] docs: correct the test count, state install caveats, ignore dsh-ops residue README: - 331 -> 491 tests (the number drifted since the rewrite). - The install section now says what installing actually means (drop the package into the profile node_modules and restart) and warns that the npm name dsh-code-review belongs to someone else, so `pnpm add dsh-code-review` installs a different project. - Drops a duplicated upgrade note; the install section owns it now. .gitignore: - Ignores .dsh-ops/ and its update lock files. A scan of this repo found that .dsh-ops/panel/session-*.json/.ndjson (up to 5 MB) sat untracked in the working tree, carrying the local Windows user name and absolute paths, and nothing ignored them - one `git add -A` from a public commit. --- .gitignore | 7 +++++++ README.md | 14 ++++++++++---- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index 761c6e7..5ba83c0 100644 --- a/.gitignore +++ b/.gitignore @@ -111,3 +111,10 @@ bin/ # gh CLI 在仓库内留下的本地状态(不应提交) .local/ + +# dsh-ops 的运行时产物(含会话记录:真实 Windows 用户名、本地绝对路径、 +# 未修复漏洞的利用细节)——绝不能进公开仓库。 +# 目录形态 + 它散落在各子目录里的更新锁文件,两种都要拦。 +.dsh-ops/ +*/.dsh-ops/ +.dsh-ops-update-*.lock diff --git a/README.md b/README.md index 417bc98..ae1f43f 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,15 @@ npm install npm run build ``` -然后在 DSH 中启用插件(`package.json` 的 `main` 指向 `dist/plugin/index.js`)。 +然后把整个包目录放进 profile 的 `node_modules/` 下,重启 DSH,在「插件」页启用 +(`package.json` 的 `main` 指向 `dist/plugin/index.js`)。 + +> **npm 上没有本包。** `dsh-code-review` 这个名字已被他人占用(v0.1.2), +> 所以 `npm i dsh-code-review` / `pnpm add dsh-code-review` 装到的是别人的东西。 +> 请用 GitHub Release 的 tar.gz 或本地目录安装。 + +> **从 0.1.x 升级?不支持。** 0.2.0 是重写版本(引擎、配置真源都换了), +> 请卸载后重新安装并重填设置,详见 [UPGRADING.md](./UPGRADING.md)。 ## 配置 @@ -81,8 +89,6 @@ npm run build 三项单价 + `budget.currency`(CNY / USD)。**三项全 0 就完全不计费**——不统计金额、也不设限; 填了任意一项才启用 `budget.maxCost`。上限只在每次模型调用前检查,单次调用可能超支(超了报告里会点名)。 -> 从 0.1.x 过来?**不支持原地升级**,请卸载后重装:见 [UPGRADING.md](UPGRADING.md)。 - > 面板的「保存」只提交**改动过的字段** —— 没动的字段不会被重写,避免覆盖别人刚存的值。 > 红线:端点或凭据缺失时,评审会在**发出任何请求之前**失败并提示去配置, @@ -115,7 +121,7 @@ npm run build ```bash npm run typecheck # 类型检查 -npm run test # 331 个测试 +npm run test # 491 个测试 npm run build # 构建到 dist/ npm run bench # token 基准(不联网) ```