返回 CodeWhale
LSP_PHP_CUSTOM.zh-CN.md
根目录 / docs / LSP_PHP_CUSTOM.zh-CN.md
1 # LSP:PHP 内置支持与自定义语言服务器扩展
2
3 > v0.8.65+ | `codex/lsp-php-custom-servers`
4
5 ## 概述
6
7 本次改动将 **PHP** 加入内置 LSP 语言注册表,并新增 `[lsp.custom]` 配置段,
8 允许用户按文件扩展名注册任意 LSP 服务器——覆盖内置 `Language` 枚举未包含的
9 语言(Ruby、C#、Swift、Lua 等)。
10
11 ## 改动内容
12
13 ### 1. PHP 内置支持
14
15 - 在 `crates/tui/src/lsp/registry.rs` 的 `Language` 枚举中添加 `Php` 变体
16 - `.php` 文件自动检测,默认路由至 `intelephense --stdio`
17 - 用户可通过 `[lsp.servers].php` 覆盖默认命令
18
19 ### 2. 自定义 LSP 服务器扩展
20
21 新增 `CustomLspDef` 结构体(定义于 `crates/tui/src/lsp/mod.rs`,同步至
22 `crates/config/src/lib.rs`):
23
24 ```rust
25 pub struct CustomLspDef {
26 pub language_id: String, // textDocument/didOpen 使用的 LSP languageId
27 pub command: String, // 要启动的可执行文件
28 pub args: Vec<String>, // 参数(默认为空)
29 }
30 ```
31
32 新增配置字段 `LspConfig.custom: HashMap<String, CustomLspDef>` —— 以文件扩展名
33 (不含前导点)为键,如 `"rb"`、`"cs"`、`"swift"`。
34
35 `LspManager::diagnostics_for` 中,当内置注册表返回 `Language::Other` 时,管理器
36 会先检查用户自定义表再放弃。自定义服务器拥有独立的懒加载 transport 映射和
37 每个扩展名仅一次的缺失告警(避免日志刷屏)。
38
39 ### 3. Transport 通用化
40
41 `StdioLspTransport::spawn` 现接受 `&str language_id` 而非 `Language`,内置和
42 自定义服务器共享同一传输实现。`client.rs` 中移除了旧的 `Language` 导入。
43
44 ### 4. 提取共享轮询管线
45
46 `poll_diagnostics` 是新提取的私有方法,内置和自定义诊断路径共用,消除了
47 重复的调用/等待/过滤/排序/截断逻辑。
48
49 ## 配置
50
51 ### 内置 PHP(若 `intelephense` 在 PATH 中则默认启用)
52
53 ```toml
54 # 无需配置 —— .php 文件自动检测。
55 # 如需覆盖服务器:
56 [lsp.servers]
57 php = ["phpactor", "language-server"]
58 ```
59
60 ### 自定义语言服务器
61
62 ```toml
63 [lsp.custom.rb]
64 command = "ruby-lsp"
65 args = ["--stdio"]
66 language_id = "ruby"
67
68 [lsp.custom.cs]
69 command = "csharp-ls"
70 language_id = "csharp"
71
72 [lsp.custom.swift]
73 command = "sourcekit-lsp"
74 language_id = "swift"
75 ```
76
77 键为文件扩展名(不含前导点)。`args` 字段默认为空。
78 `language_id` 须与 LSP 服务器在 `textDocument/didOpen` 中期望的值匹配。
79
80 ## 架构
81
82 ```
83 edit_file / write_file / apply_patch 成功
84
85
86 LspManager.diagnostics_for(file)
87
88 ├── custom_for_extension(file) ── 命中?──► transport_for_custom(ext, def)
89 │ │
90 ├── detect_language(file) ── Other?──► 返回 None(跳过)
91
92 └── transport_for(lang)
93
94
95 poll_diagnostics(file, text, transport)
96
97
98 DiagnosticBlock → 注入会话消息流
99 ```
100
101 ## 验证
102
103 ```
104 cargo test -p codewhale-tui --bin codewhale-tui lsp::
105 # 32 个测试通过(新增 3 个:detects_php_extension、language_ids_for_php、
106 # server_for_php_is_intelephense)
107 cargo clippy -p codewhale-tui --bin codewhale-tui
108 # lsp 模块:零新增警告
109 ```
110
111 ## 涉及文件
112
113 | 文件 | 改动 |
114 |------|------|
115 | `crates/tui/src/lsp/registry.rs` | +Php 变体、检测、服务器映射、测试 |
116 | `crates/tui/src/lsp/mod.rs` | +CustomLspDef、LspConfig.custom、LspManager 自定义回退 |
117 | `crates/tui/src/lsp/client.rs` | spawn 接受 &str language_id |
118 | `crates/tui/src/config.rs` | LspConfigToml.custom + into_runtime |
119 | `crates/config/src/lib.rs` | LspConfigToml.custom + CustomLspDef |
120 | `config.example.toml` | PHP 文档 + 自定义扩展示例 |
121
121 lines MARKDOWN