@epoch-agent/plugin-lsp 0.1.0

package/LICENSE

@@ -0,0 +1,219 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+--------------------------------------------------------------------------------
+
+epoch-agent
+Copyright 2024-2026 bowen
+
+Portions of this software are derived from the Gemini CLI
+(https://github.com/google-gemini/gemini-cli), Copyright 2025 Google LLC,
+licensed under the Apache License, Version 2.0. Those files have been modified;
+each one retains its original copyright notice and SPDX-License-Identifier
+header. See the NOTICE file in the project source repository for the complete
+list of derived files.
+
+This software also quotes, with attribution, two lines of prose from OpenAI
+Codex (https://github.com/openai/codex), Copyright 2025 OpenAI, licensed under
+the Apache License, Version 2.0. No source file is a derived work of Codex.
+See the NOTICE file for details.

package/README.md

@@ -0,0 +1,185 @@
+# @epoch-agent/plugin-lsp
+
+LSP 诊断插件。**一个工具**：`lsp_diagnostics` —— 用**项目自己的** language server
+回答「我刚改的这几个文件，编译器怎么说」。
+
+- ✅ **做**：探测 language server（项目 `node_modules` → PATH）、起一个常驻连接、
+  `didOpen` / `didChange` 后收 `publishDiagnostics`、判「收全了没」、排版给模型看
+- ❌ **不做**：**不捆绑任何 server**（探不到就如实报「跳过 + 装法」）、不做补全 /
+  跳转 / 重命名、不做项目级构建、不自己 spawn（进程一律走
+  [infra](../../infra) 的 `startLongLivedProcess`）
+- **依赖**：[protocol](../../protocol) + [infra](../../infra) +
+  `vscode-jsonrpc` / `vscode-languageserver-protocol`
+
+## 工具参数
+
+```json
+{ "paths": ["src/a.ts", "src/b.tsx"] }
+```
+
+| 参数    | 必填 | 说明                                                     |
+| ------- | ---- | -------------------------------------------------------- |
+| `paths` | ✅   | 文件路径数组，相对工作目录或绝对路径。一次最多 50 个文件 |
+
+单个路径写成字符串（`"paths": "src/a.ts"`）也收 —— 那是很自然的手误，
+为它回一条参数错误等于白烧一轮。
+
+当前认得 8 个扩展名：`.cjs` `.cts` `.js` `.jsx` `.mjs` `.mts` `.ts` `.tsx`
+（唯一真源是 [servers.ts](src/servers.ts) 的 `supportedExtensions()`，
+工具描述和报错提示都从那儿取）。不认的扩展名进 `unsupported`，
+工作目录外的路径进 `rejected`，**都不会让这次调用失败**。
+
+## 输出是文本，不是 JSON 数组
+
+```
+2 条诊断（1 error · 1 warning） · 已检查 2 个文件
+
+src/a.ts:12:5  error typescript(2322): 不能将类型 "string" 分配给类型 "number"
+src/b.tsx:3:10  warning typescript(6133): "unused" 已声明但从未读取
+```
+
+core 的 tool-executor 对非字符串 `output` 一律 `JSON.stringify`，那一行 JSON 里
+每条诊断都要重复七个键名 —— 对 30 条诊断是白烧一倍多的 token，而模型从
+`src/a.ts:12:5  error …` 里读到的信息一模一样（它每天在 tsc / eslint 的输出里
+见的就是这个）。字段一个没少，只是换了排布。
+
+**三件事一定在输出里**：检查了哪些文件（没这行，「没发现问题」和「一个文件都没
+检查」长得一样）、跳过的语言 + 安装命令、被截断了多少（上限 100 条，
+按 severity 优先保留 error）。
+
+## 两处与方案 38 原文的偏差
+
+1. **`paths` 是必填的。** 方案里「不传就检查本轮改过的文件」要拿
+   `CheckpointManager` 那份本轮改动清单，而插件的 `ToolContext` 只有
+   `{sessionId, workDir, extraRoots, permissionLevel, signal, onOutput}` —— 补这条得改
+   core 的 checkpoint 接口。先做成必填（模型知道自己刚改了哪几个文件），那条留给后续 PR
+   （[验收记录 8.2](../../../docs/verify/VERIFY_RECORD-38-lsp-diagnostics.md)）。
+2. **输出是排好版的文本而不是 `[{file, line, ...}]`**，理由见上一节。
+
+## 三级探测，一个 server 都不捆绑
+
+```
+1. 项目本地  node_modules/<pkg>   ← TypeScript 那条「版本跟项目走」的硬要求
+2. PATH
+3. 都没有 → 该语言 skipped + 安装命令，其它语言不受影响
+```
+
+和 [infra 的 ripgrep 探测](../../infra/src/ripgrep.ts)反着来：那边捆绑一个 6MB
+单文件，这边一个都不捆。language server 是一堆文件，而且**强绑定用户的项目配置**
+—— 拿全局的 tsc 去检查一个 pin 了 5.8 的项目，报出来的错是假的。所以还额外把项目
+自己那份 `node_modules/typescript/lib/tsserver.js` 显式传进
+`initializationOptions.tsserver.path`：server 自己也会找 workspace 版本，
+但那是它内部的一条兜底顺序，它升一版换个顺序我们就悄悄换了 TS 版本报错。
+
+**故意不碰 `node_modules/.bin`。** Windows 上那儿躺的是 npm 生成的 `.cmd` 垫片，
+Node 的 `spawn` 不过 shell 就执行不了；而 pnpm 下它是符号链接，跟到哪儿要看安装
+布局。走 `node_modules/<pkg>/package.json` 的 `bin` 字段拿真实入口、用
+`process.execPath` 跑它，两个平台同一条代码路径，且**必然是项目里那一份**。
+PATH 命中 `.cmd` / `.bat` 时才走 `cmd.exe /d /s /c "<整条命令>"` + `verbatim`。
+
+> ⚠️ **项目本地那一档带 `ELECTRON_RUN_AS_NODE=1`**（`launch.env`，值来自 infra 的
+> `EXEC_PATH_AS_NODE_ENV`）。嵌进 Electron 主进程的宿主里 `process.execPath`
+> **不是 node** 而是宿主自己的可执行文件，少了那一格，起 language server 等于
+> 启动第二个 app 实例。PATH 那两档起的是真可执行文件，不需要。
+> 全仓「谁把 execPath 当 node 使」由根 `__tests__/exec-path-as-node.test.ts` 数着。
+
+> PATH 扫描**保留绝对路径**去 spawn，而不是像 ripgrep 那样丢掉路径 spawn 裸名字。
+> 因为这个工具的输入正是「别人的仓库」：`shell: true` + 裸名字在 Windows 上，
+> 目标仓库根目录里放一个同名 `.cmd` 就能劫持。我们的扫描列表里没有 cwd。
+
+## 诊断是**推**过来的，所以「收全了没」要自己判
+
+LSP 里没有「诊断请求」这种东西 —— typescript-language-server 4.4 也不支持 3.17 的
+pull 模式（`initialize` 的结果里没有 `diagnosticProvider`）。server 想发就发，
+而 tsserver 一个文件会**分三次**发（语法 / 语义 / 建议，各自 50ms 去抖），
+先到的那一份是不全的。
+
+**判据是静默**：请求的文件都答过了，且最近一次动静距今超过 `settleMs`（默认 400ms，
+`fallbackMs` 1.5s，硬超时 15s）。
+
+还有一条更阴的：**内容没变时 server 干脆不发。** `FileDiagnostics.update()` 里有
+一句「这一类上次是空、这次还是空就不推送」，于是一个干净的文件被诊断第二次时
+一条消息都收不到。按「没答复 = 没结果」处理就会把最正常的那种情况报成
+「server 没回答」。所以有第二条判据：**没答复但有上一次的结果，就用上一次的**。
+[e2e.test.ts](__tests__/e2e.test.ts) 拿真 server 盯着这一条。
+
+## 进程池：懒启动 / 10 分钟回收 / 崩一次重启一次
+
+| 策略       | 值                                            |
+| ---------- | --------------------------------------------- |
+| 启动时机   | 懒启动 —— 第一次 `lsp_diagnostics` 才起       |
+| 空闲回收   | 10 分钟没用就关（大项目的 tsserver 吃几个 G） |
+| 并发       | 每种语言一个实例，**按项目根隔离**            |
+| 初始化超时 | 每种 server 自己给（TypeScript 是 30s）       |
+| 崩溃       | 下次调用重启一次；再崩就本会话内不再试        |
+
+池是**模块级单例**：工具每次调用都是一次新的 `execute`，而 language server 的意义
+全在于「活着、缓存着上次的语法树」。挂在调用上等于每次冷启一个 tsserver，
+那比让模型自己跑 tsc 还慢。
+
+「不可用」的每一条路径 —— 没装、起不来、初始化超时、崩了 —— 交出来的都是
+`{ ok: false, reason }` 而不是 throw。一个 server 起不来只该让它那门语言的文件被
+跳过。**「没装」不计入失败次数**：那不是「试了没成」，计进去的话用户装完 server
+还得重启 epoch 才能用上。
+
+**退出时宿主什么都不用做**：进程在 infra 的进程表里，`cleanupBackgroundProcesses()`
+会一并收掉。`disposeLspServers()` 是给「想早点收、且要走 LSP `shutdown` 礼节」的
+宿主用的。
+
+## 为什么是 `file_read` 而不是 `command`
+
+```ts
+annotations: { readOnlyHint: true, idempotentHint: false, openWorldHint: false }
+operation: 'file_read'
+```
+
+这个工具对外的语义就是「读几个文件、报问题」。底下确实起了子进程，但那个进程是
+**我们表里写死的**（[servers.ts](src/servers.ts)），参数里没有任何一段来自模型。
+归到 `command` 只会让每次诊断都弹一次审批 —— 而 core 的 system prompt 恰恰要求
+模型每轮改完都调它。`idempotentHint: false` 是因为文件内容会变：同一批路径
+这一秒和下一秒的诊断可以不一样。
+
+`describeTarget` 给的是文件清单，不给就退回 `JSON.stringify(args)`，
+换个顺序传同样几个文件就不命中审批缓存了。
+
+## 加一门语言 = 往 `SERVERS` 里加一条
+
+[servers.ts](src/servers.ts) 的 `SERVERS` 是**唯一**需要改的地方，client / pool /
+diagnose 一行都不用动。别让语言判定漏到别处去。Python / Rust / Go 是方案 38 的
+PR-3，**刻意砍掉的**（不是做到一半放弃）—— 砍的判据和真要做时的两条成本写在
+[验收记录 8.1](../../../docs/verify/VERIFY_RECORD-38-lsp-diagnostics.md)。
+
+## 文件
+
+| 文件          | 内容                                                        |
+| ------------- | ----------------------------------------------------------- |
+| `index.ts`    | `lspPlugin` + 模块级池 + `disposeLspServers()`              |
+| `servers.ts`  | 支持哪些语言、怎么起、`tsserver.path` 怎么找                |
+| `detect.ts`   | 三级探测（不 spawn，纯文件系统问题）                        |
+| `client.ts`   | 一个 server 连接：五条消息 + 静默判据 + 崩溃回调 + 优雅退出 |
+| `pool.ts`     | 懒启动 / 空闲回收 / 并发去重 / 失败计数                     |
+| `diagnose.ts` | 编排：路径归一 → 边界校验 → 按 server 分组 → 收结果         |
+| `format.ts`   | 渲染成模型读的那段文字（截断 + 按 severity 优先）           |
+| `find-up.ts`  | 逐级往上找一个相对路径                                      |
+| `types.ts`    | 本包的类型                                                  |
+
+错误码占 **8xxx 段**：`8001` 参数不对、`8002` 我们没想到的形态。别复用别人的段 ——
+用户报错时那四位数是唯一能一眼定位到哪个包的东西。
+
+## 开发
+
+```bash
+pnpm --filter @epoch-agent/plugin-lsp test
+```
+
+七个用例文件。两处值得先看：
+
+- [fixtures/fake-server.mjs](__tests__/fixtures/fake-server.mjs) 是一个**手写分帧**
+  的假 LSP server（故意不用 `vscode-jsonrpc`，那样才是一份独立的参照实现）。
+  `process.argv[2]` 选行为：`normal` / `three-kinds` / `silent` / `once` /
+  `hang-init` / `crash-on-open`
+- [e2e.test.ts](__tests__/e2e.test.ts) 用**真的** typescript-language-server，
+  被检查的文件写在临时目录里 —— 故意报错的 fixture 不该进本仓库的 tsc / lint 范围
+
+`vitest.config.ts` 的 `testTimeout` 是 60s：起一个真 tsserver 加初始化，
+默认的 5000ms 不够。