@lexwdex-org/opencode-dcp 3.4.10 → 3.4.11

package/README.md

@@ -1,296 +1,92 @@
 # 动态上下文剪枝插件
 
-[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/dansmolsky)
 [![npm version](https://img.shields.io/npm/v/@lexwdex-org/opencode-dcp.svg)](https://www.npmjs.com/package/@lexwdex-org/opencode-dcp)
 
 [**English**](./README.en.md) | **中文**
 
-通过管理对话上下文，自动减少 OpenCode 中的 token 消耗。
-
-![DCP in action](assets/images/dcp-demo9.png)
-
-## 安装
-
-从 CLI 安装：
-
-```bash
-opencode plugin @lexwdex-org/opencode-dcp@latest --global
-```
-
-这会安装该包并将其添加到全局 OpenCode 配置中。
+DCP 为 OpenCode 原生 compaction 提供语义剪枝策略。它不再维护消息标记、消息 ID、压缩块、锚点、占位符或第二套摘要状态机。
 
 ## 工作原理
 
-DCP 通过压缩工具和自动清理来减小上下文大小。会话历史记录不会被修改——DCP 会在向 LLM 发送请求之前用占位符替换已剪枝的内容。
+OpenCode 原生 compaction 负责生成和保存一个滚动检查点，并在后续模型请求中只发送：
 
-### 压缩
+```text
+最新剪枝检查点 + 尚未压缩的近期尾部
+```
 
-Compress 是一个暴露给模型的工具，它会将已关闭的、过时的对话内容替换为高保真度的技术摘要。你可以将其视为 OpenCode 原生合并过程的更智能版本。它不是在你的会话达到最大上下文时才静态触发并对整个编码会话生效，而是允许模型根据任务完成情况自主选择何时激活，并且只压缩那些不再需要逐字保留的特定消息。
+DCP 只在 `experimental.session.compacting` 阶段提供专用提示词。提示词会：
 
-DCP 支持两种压缩模式：
+- 删除无关闲聊、其他项目内容、重复解释和已推翻方案；
+- 把多次工具试错折叠为最终成功结果，必要时保留一次根因；
+- 把同一内容的重复修改折叠为最终状态和仍有效的决策；
+- 把小型已完成主题压缩为一句结果；
+- 保留继续工作需要的目标、约束、决策、实现状态、风险和下一步。
 
-- `range` 模式将连续的多段对话压缩为一个或多个摘要。
-- `message` 模式（实验性）独立压缩单条原始消息，让模型能够更精细地管理上下文。
+压缩后的旧前缀不会再发送给模型，但 OpenCode 数据库中的原始会话历史不会被物理删除。下一次压缩会把旧检查点和新增尾部合并为一个新检查点，不会形成嵌套摘要或压缩块 DAG。
 
-在 `range` 模式下，当新的压缩与先前的压缩重叠时，先前的摘要会被嵌套到新的摘要中，这样信息在多层压缩中得到保留而非被稀释。在两种模式下，受保护的工具输出（如子 agent 和技能）以及受保护的文件模式都会保留在压缩摘要中，确保最重要的信息永不会丢失。你还可以启用 `protectUserMessages` 来在压缩期间保留你的消息原样，但请注意，大型提示（例如在提示中粘贴日志文件）将永远不会被压缩掉。
+## 安装
 
-### 去重
+```bash
+opencode plugin @lexwdex-org/opencode-dcp@latest --global
+```
 
-识别重复的工具调用（相同工具、相同参数），只保留最近一次的输出。在压缩工具运行时重新计算，因此提示缓存仅在与压缩同时发生时受到影响。
+## 触发压缩
 
-### 清除错误
+- OpenCode 自动 compaction：达到宿主阈值时自动运行。
+- OpenCode 原生 `/compact`：手动触发同一条 compaction 路径。
+- `/dcp summarize`：调用原生 `session.summarize()`，一次完成语义摘要和真实上下文剪枝。
 
-在可配置的消息轮次后（默认：4 轮），修剪出错工具调用的输入。错误消息会被保留，仅移除可能较大的输入内容。在使用压缩工具时重新计算。
+同一会话的并发 `/dcp summarize` 会合并为一次原生调用。失败不会提交半成品检查点，原始上下文保持可用；默认 30 秒内不会重复调用失败的请求。
 
 ## 配置
 
-DCP 使用自己的配置文件，按以下顺序搜索：
+DCP 依次读取以下配置，后面的层覆盖前面的层：
 
-1. 全局：`~/.config/opencode/dcp.jsonc`（或 `dcp.json`），首次运行时自动创建
-2. 自定义配置目录：`$OPENCODE_CONFIG_DIR/dcp.jsonc`（或 `dcp.json`），如果设置了 `OPENCODE_CONFIG_DIR`
-3. 项目：`.opencode/dcp.jsonc`（或 `dcp.json`），位于项目的 `.opencode` 目录中
-
-每个层级覆盖前一个层级，因此项目设置优先于全局设置。修改配置后请重启 OpenCode。
-
-> [!NOTE]
-> 如果你使用的是较小上下文窗口的模型，例如 GitHub Copilot 模型或本地模型，请在配置中降低 `compress.minContextLimit` 和 `compress.maxContextLimit` 以匹配可用上下文。
-
-> [!IMPORTANT]
-> 默认值会自动应用。展开此项可查看或覆盖设置。
-
-<details>
-<summary><strong>默认配置</strong>（点击展开）</summary>
+1. `~/.config/opencode/dcp.jsonc` 或 `dcp.json`
+2. `$OPENCODE_CONFIG_DIR/dcp.jsonc` 或 `dcp.json`
+3. 项目的 `.opencode/dcp.jsonc` 或 `dcp.json`
 
 ```jsonc
 {
     "$schema": "https://raw.githubusercontent.com/LeXwDeX/opencode-dynamic-context-pruning/master/dcp.schema.json",
-    // Enable or disable the plugin
     "enabled": true,
-    // Check npm for a newer DCP release and show an update notification.
-    // The plugin never deletes or replaces its active installation.
     "autoUpdate": true,
-    // Enable debug logging to ~/.config/opencode/logs/dcp/
     "debug": false,
-    // Notification display: "off", "minimal", or "detailed"
-    "pruneNotification": "detailed",
-    // Notification type: "chat" (in-conversation) or "toast" (system toast)
-    "pruneNotificationType": "chat",
-    // Slash commands configuration
     "commands": {
         "enabled": true,
-        // Additional tools to protect from pruning via commands (e.g., /dcp sweep)
-        "protectedTools": [],
     },
-    // Manual mode: disables autonomous context management,
-    // tools only run when explicitly triggered via /dcp commands
-    "manualMode": {
-        "enabled": false,
-        // When true, automatic cleanup (deduplication, purgeErrors)
-        // still runs even in manual mode
-        "automaticStrategies": true,
-    },
-    // Protect from pruning for <turns> message turns past tool invocation
-    "turnProtection": {
-        "enabled": false,
-        "turns": 4,
-    },
-    // Experimental settings
     "experimental": {
-        // Allow DCP processing in subagent sessions
-        "allowSubAgents": false,
-        // Enable user-editable prompt overrides under dcp-prompts directories
-        // When false (default), prompt override files/directories are ignored
         "customPrompts": false,
     },
-    // Protect file operations from pruning via glob patterns
-    // Patterns match tool parameters.filePath (e.g. read/write/edit)
-    "protectedFilePatterns": [],
-    // Unified context compression tool and behavior settings
-    "compress": {
-        // Compression mode: "range" (compress spans into block summaries)
-        // or experimental "message" (compress individual raw messages)
-        "mode": "range",
-        // Permission mode: "allow" (no prompt), "ask" (prompt), "deny" (tool not registered)
-        "permission": "allow",
-        // Show compression content in a chat notification
-        "showCompression": false,
-        // Let active summary tokens extend the effective maxContextLimit
-        "summaryBuffer": true,
-        // Soft upper threshold: above this, DCP keeps injecting strong
-        // compression nudges (based on nudgeFrequency), so compression is
-        // much more likely. Accepts: number or "X%" of model context window.
-        "maxContextLimit": "85%",
-        // Soft lower threshold for reminder nudges: below this, turn/iteration
-        // reminders are off (compression less likely). At/above this, reminders
-        // are on. Accepts: number or "X%" of model context window.
-        "minContextLimit": "50%",
-        // When true (default), DCP injects a soft turn-boundary reminder at every
-        // new user turn, after session.idle, and after vcs.branch.updated events —
-        // regardless of minContextLimit, and only while below maxContextLimit —
-        // asking the model to compress the previous task when the topic changed
-        // (throttled by nudgeFrequency).
-        "boundaryNudge": true,
-        // Optional per-model override for maxContextLimit by providerID/modelID.
-        // If present, this wins over the global maxContextLimit.
-        // Accepts: number or "X%".
-        // Example:
-        // "modelMaxLimits": {
-        //     "openai/gpt-5.3-codex": 120000,
-        //     "anthropic/claude-sonnet-4.6": "80%"
-        // },
-        // Optional per-model override for minContextLimit.
-        // If present, this wins over the global minContextLimit.
-        // "modelMinLimits": {
-        //     "openai/gpt-5.3-codex": 50000,
-        //     "anthropic/claude-sonnet-4.6": "25%"
-        // },
-        // How often the context-limit nudge fires (1 = every fetch, 2 = every 2nd)
-        "nudgeFrequency": 2,
-        // Start adding compression reminders after this many
-        // messages have happened since the last user message
-        "iterationNudgeThreshold": 15,
-        // Controls how likely compression is after user messages
-        // ("strong" = more likely, "soft" = less likely)
-        "nudgeForce": "strong",
-        // Tool names whose completed outputs are appended to the compression
-        "protectedTools": [],
-        // Preserve text wrapped in <protect>...</protect> when compressed
-        "protectTags": false,
-        // Preserve your messages during compression.
-        // Warning: large copy-pasted prompts will never be compressed away
-        "protectUserMessages": false,
-    },
-    // Automatic pruning strategies
-    "strategies": {
-        // Remove duplicate tool calls (same tool with same arguments)
-        "deduplication": {
-            "enabled": true,
-            // Additional tools to protect from pruning
-            "protectedTools": [],
-        },
-        // Prune tool inputs for errored tools after X turns
-        "purgeErrors": {
-            "enabled": true,
-            // Number of turns before errored tool inputs are pruned
-            "turns": 4,
-            // Additional tools to protect from pruning
-            "protectedTools": [],
-        },
+    "summarize": {
+        "failureCooldownMs": 30000,
     },
 }
 ```
 
-</details>
-
-### 命令
-
-DCP 提供 `/dcp` 斜杠命令：
-
-- `/dcp` — 显示可用的 DCP 命令
-- `/dcp context` — 显示当前会话按类别（system、user、assistant、tools 等）划分的 token 使用明细以及通过剪枝节省的量。
-- `/dcp stats` — 显示跨所有会话的累积剪枝统计信息。
-- `/dcp sweep` — 修剪自上次用户消息以来的所有工具。接受可选数量：`/dcp sweep 10` 修剪最后 10 个工具。遵循 `commands.protectedTools`。
-- `/dcp manual [on|off]` — 切换手动模式或设置显式状态。开启时，AI 不会自主使用上下文管理工具。
-- `/dcp compress [focus]` — 触发一次压缩工具执行。可选的 focus 文本指示要压缩的内容，遵循当前的 `compress.mode`。
-- `/dcp decompress <n>` — 按 ID 恢复特定的活跃压缩（例如 `/dcp decompress 2`）。不加参数运行时显示可用的压缩 ID、token 大小和主题。
-- `/dcp recompress <n>` — 按 ID 重新压缩用户已解压的压缩（例如 `/dcp recompress 2`）。不加参数运行时显示可重新压缩的 ID、token 大小和主题。
-
-### 提示词覆盖
-
-DCP 暴露了六个可编辑的提示词：
-
-- `system`
-- `compress-range`
-- `compress-message`
-- `context-limit-nudge`
-- `turn-nudge`
-- `iteration-nudge`
+启用 `experimental.customPrompts` 后，可将生成的
+`~/.config/opencode/dcp-prompts/defaults/compaction.md` 复制到以下任一覆盖位置：
 
-此功能默认禁用。在你的 DCP 配置中将 `experimental.customPrompts` 设置为 `true` 来激活它。
+- 项目：`.opencode/dcp-prompts/overrides/compaction.md`
+- 自定义配置目录：`$OPENCODE_CONFIG_DIR/dcp-prompts/overrides/compaction.md`
+- 全局：`~/.config/opencode/dcp-prompts/overrides/compaction.md`
 
-启用后，管理的默认值会以纯文本提示词文件的形式写入 `~/.config/opencode/dcp-prompts/defaults/`。该目录中的 `README.md` 文件会解释每个提示词以及如何创建覆盖。
+## 从 3.x 旧压缩管线迁移
 
-如需自定义行为，请在覆盖目录下添加同名文件并编辑为纯文本。
+旧配置 `compress`、`manualMode`、`strategies`、`turnProtection`、
+`pruneNotification`、`protectedFilePatterns` 及旧命令保护字段均已删除。DCP 会显示迁移警告并忽略这些字段，不会静默继续旧行为。
 
-要重置覆盖，请从覆盖目录中删除对应的文件。
+以下功能已删除：`compress` / `compress_range` 模型工具、`/dcp compress`、
+`/dcp decompress`、`/dcp recompress`、`/dcp sweep`、消息标记、nudge 和插件压缩状态持久化。磁盘上已有的旧 DCP 会话状态文件不会被读取、改写或删除，可在确认不再回退旧版本后自行清理。
 
-### 受保护工具
-
-默认情况下，以下工具始终受保护不被修剪：
-`task`、`skill`、`todowrite`、`todoread`、`compress`、`batch`、`plan_enter`、`plan_exit`、`write`、`edit`
-
-`commands` 和 `strategies` 中的 `protectedTools` 数组会追加到这个默认列表。
-
-对于 `compress` 工具，`compress.protectedTools` 确保特定工具的输出会被附加到压缩摘要中。默认包含 `task`、`skill`、`todowrite` 和 `todoread`。
-
-### 外部模型压缩
-
-将压缩摘要的生成工作卸载到更便宜的模型，而不是使用昂贵的主模型。
-
-#### 优先级链
-
-| 优先级    | 来源     | 说明                                                   |
-| --------- | -------- | ------------------------------------------------------ |
-| 1（最高） | 环境变量 | `OPENCODE_DCP_EXTERNAL_COMPRESS_*`                     |
-| 2         | 项目配置 | `<project>/.opencode/dcp.jsonc:compress.externalModel` |
-| 3         | 全局配置 | `~/.config/opencode/dcp.jsonc:compress.externalModel`  |
-| 4（兜底） | 主模型   | 原始行为不变                                           |
-
-#### 使用方法
-
-**方法 1 — 环境变量（推荐用于快速设置）：**
+## 开发验证
 
 ```bash
-export OPENCODE_DCP_EXTERNAL_COMPRESS_URL="http://your-proxy-url/v1"
-export OPENCODE_DCP_EXTERNAL_COMPRESS_MODEL="your-model-name"
-# Optional:
-export OPENCODE_DCP_EXTERNAL_COMPRESS_KEY="your-api-key"
-export OPENCODE_DCP_EXTERNAL_COMPRESS_TIMEOUT="120000"
-export OPENCODE_DCP_EXTERNAL_COMPRESS_RETRIES="1"
-```
-
-在 shell RC 文件（`~/.zshrc`、`~/.bashrc`）中持久化，以便跨会话自动可用。
-
-**方法 2 — 配置文件（`dcp.jsonc`）：**
-
-```jsonc
-{
-    "compress": {
-        "externalModel": {
-            "url": "http://your-proxy-url/v1",
-            "model": "your-model-name",
-            "apiKey": "your-api-key",
-            "timeout": 120000,
-            "retries": 1,
-        },
-    },
-}
+npm test
+npm run typecheck
+npm run build
+npm run format:check
+npm run check:package
 ```
 
-#### 行为说明
-
-| 场景                              | 行为                                             |
-| --------------------------------- | ------------------------------------------------ |
-| 配置了外部模型 + 未提供 `summary` | 插件获取范围内容 → 调用外部模型 → 存储生成的摘要 |
-| 配置了外部模型 + 提供了 `summary` | 插件直接使用提供的 `summary`（向后兼容）         |
-| 外部模型调用失败                  | 工具抛出错误；主模型使用回退摘要重试             |
-| 未配置                            | 一切不变——主模型像以前一样编写摘要               |
-| `url` 不兼容 OpenAI               | 外部模型调用失败 → 进入上述错误路径              |
-
-**兼容性：** 仅支持兼容 OpenAI 的 `/chat/completions` 端点（本地代理、OpenAI、DeepSeek 等）。
-
-## 对提示词缓存的影响
-
-LLM 提供商基于精确前缀匹配来缓存提示词。当 DCP 剪枝内容时，它会修改消息，从而从该位置开始使缓存的提示词前缀失效。
-
-**权衡：** 你会损失一些缓存命中，但通过减小上下文尺寸和减少因过时上下文导致的幻觉来获得 token 节省。在大多数情况下，尤其是在长会话中，节省量超过了缓存未命中的成本。
-
-> [!NOTE]
-> 测试中，使用 DCP 的缓存命中率约为 85%，而未使用时约为 90%。
-
-**无影响的情况：**
-
-- **按请求计费** — 按请求收费而非按 token 收费的提供商，如 GitHub Copilot。
-- **统一 token 定价** — 对缓存和未缓存 token 按相同费率计费的提供商，如 Cerebras。
-
-## License
+许可：AGPL-3.0-or-later。

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAoBjD,QAAA,MAAM,MAAM,EAAE,MA4GK,CAAA;AAEnB,eAAe,MAAM,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAQjD,QAAA,MAAM,MAAM,EAAE,MA8BK,CAAA;AAEnB,eAAe,MAAM,CAAA"}