feat: empty implement VSCode proposed API: registerMultiDocumentHighlightProvider #4172
Conversation
Walkthrough此拉取请求引入了多个与多文档高亮相关的功能。主要更改包括在 Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 eslint
warning [email protected]: This version is no longer supported. Please see https://eslint.org/version-support for other options. Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (10)
packages/extension/src/hosted/api/vscode/ext.host.language.ts (1)
364-373: 空实现符合预期，等待 Monaco 1.85.0+当前的空实现是合理的，因为该功能依赖于尚未发布的 Monaco 编辑器 1.85.0 版本。
建议添加更详细的 TODO 注释，说明具体实现计划：
/** * @monaco-todo: wait until API is available in Monaco (1.85.0+) */ + // TODO: 实现完整的多文档高亮提供者功能 + // 1. 等待 Monaco 1.85.0+ 发布 + // 2. 参考 VSCode 提案实现对应的接口 + // 3. 添加必要的单元测试packages/extension/src/common/vscode/ext-types.ts (1)
1462-1483: 代码实现良好，建议完善文档注释！类的实现遵循了 TypeScript 最佳实践，结构清晰。建议在类级别添加 JSDoc 文档，说明该类的主要用途和使用场景。
建议添加如下类级别文档:
+/** + * 表示单个文档中的所有高亮信息。 + * 作为 VSCode 多文档高亮 API 的一部分，用于在多个文档间同步高亮显示相关内容。 + */ @es5ClassCompat export class MultiDocumentHighlight {packages/types/vscode/typings/vscode.proposed.multiDocumentHighlightProvider.d.ts (1)
53-53: 修正文档注释中的链接格式注释中的链接
{@link languages.match score}格式可能不正确。建议将链接修改为{@link languages.match}，以确保在生成文档时正确解析。建议应用以下修改：
- * by their {@link languages.match score} and groups sequentially asked for document highlights. + * by their {@link languages.match} score and groups sequentially asked for document highlights.packages/types/vscode/typings/vscode.language.d.ts (7)
Line range hint
386-386: 建议：为registerDocumentDropEditProvider添加缺失的文档注释在第386行，新增了
registerDocumentDropEditProvider函数，但缺少相应的文档注释。为了提高代码的可读性和维护性，建议为该函数添加详细的文档注释，说明其用途、参数和返回值。
Line range hint
388-388: 建议：为registerEvaluatableExpressionProvider添加缺失的文档注释在第388行，新增了
registerEvaluatableExpressionProvider函数，但没有提供文档注释。为了帮助开发者理解该函数的作用，建议添加详细的文档注释，包括函数的功能描述、参数说明和返回值信息。
Line range hint
419-421: 建议：完善InlayHintKind枚举的文档注释在第419至421行，定义了新的枚举类型
InlayHintKind，但缺少对枚举成员Type和Parameter的说明。建议为每个枚举成员添加文档注释，解释其含义和使用场景，以提高代码的可读性。
Line range hint
445-474: 建议：为InlayHintLabelPart类及其成员添加文档注释在第445至474行，引入了新的
InlayHintLabelPart类，但缺少对类和属性的文档注释。为了提高代码的可维护性，建议为该类和其属性添加详细的文档注释，说明其用途和使用方法。
Line range hint
451-451: 优化类型声明在第451行，属性
tooltip的类型声明为string | MarkdownString | undefined。由于tooltip已经被声明为可选属性（使用了?标记），undefined类型可以省略。建议修改如下：- tooltip?: string | MarkdownString | undefined; + tooltip?: string | MarkdownString;
Line range hint
476-547: 建议：为InlayHint类及其成员添加文档注释在第476至547行，新增了
InlayHint类，但缺少对类、属性和方法的文档注释。为提高代码的清晰度和可读性，建议为该类及其成员添加详细的文档注释，帮助开发者理解其功能和用法。
Line range hint
529-530: 代码风格建议：属性声明格式统一在第529和530行，属性
paddingLeft和paddingRight的声明格式不统一。建议在属性声明之间添加空行，以提高代码的可读性，或将相似的属性合并，提高代码整洁度。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (5)
packages/extension/src/common/vscode/ext-types.ts(1 hunks)packages/extension/src/hosted/api/vscode/ext.host.language.ts(1 hunks)packages/types/vscode.d.ts(1 hunks)packages/types/vscode/typings/vscode.language.d.ts(1 hunks)packages/types/vscode/typings/vscode.proposed.multiDocumentHighlightProvider.d.ts(1 hunks)
🔇 Additional comments (2)
packages/types/vscode.d.ts (1)
46-46: 新增的类型定义引用路径位置合适！
新增的 multiDocumentHighlightProvider 类型定义引用被正确地放置在其他提议的 API 类型定义之间，保持了良好的代码组织结构。
让我们验证一下 Monaco 编辑器的版本依赖：
✅ Verification successful
类型定义引用添加正确，实现完整且符合预期！
通过验证，我们发现：
multiDocumentHighlightProvider的类型定义文件已完整实现，包含了所有必要的接口和类型声明- 该功能作为一个提议的（proposed）API 被正确引用
- 虽然在主 package.json 中没有直接声明 Monaco 编辑器的版本依赖，但从 CHANGELOG.md 可以看到项目使用的是 Monaco 0.45.0 版本，足以支持此功能
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# 描述：检查项目中 Monaco 编辑器的版本要求
# 搜索 package.json 中的 Monaco 编辑器版本
echo "检查 package.json 中的 Monaco 编辑器版本要求："
fd -t f "package.json" -x grep -l "monaco-editor" {} \; -exec cat {} \; | jq '.dependencies["monaco-editor"] // .devDependencies["monaco-editor"]'
# 搜索任何与 Monaco 版本相关的配置
echo "检查其他与 Monaco 版本相关的配置："
rg -g '!node_modules' -g '!dist' "monaco.*version|version.*monaco" .
Length of output: 1417
Script:
#!/bin/bash
# 检查 package.json 中的 Monaco 编辑器版本要求
echo "检查 package.json 中的 Monaco 编辑器版本要求："
cat package.json | jq '.dependencies["monaco-editor"] // .devDependencies["monaco-editor"]'
# 检查 Monaco 编辑器相关的依赖配置
echo "检查 Monaco 编辑器相关的依赖配置："
rg -g '!node_modules' -g '!dist' '"monaco-editor".*version' .
# 检查 multiDocumentHighlightProvider 的实现
echo "检查 multiDocumentHighlightProvider 的实现："
cat packages/types/vscode/typings/vscode.proposed.multiDocumentHighlightProvider.d.ts
Length of output: 3024
packages/extension/src/common/vscode/ext-types.ts (1)
1462-1483: 集成良好，符合现有代码组织结构！
新增的 MultiDocumentHighlight 类:
- 正确复用了现有的
Uri和DocumentHighlight类型 - 保持了与文件中其他类似实现的一致性
- 位置放置合适，便于维护
packages/types/vscode/typings/vscode.proposed.multiDocumentHighlightProvider.d.ts
Show resolved
Hide resolved
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4172 +/- ##
==========================================
- Coverage 54.08% 54.07% -0.01%
==========================================
Files 1611 1611
Lines 97846 97852 +6
Branches 20031 20031
==========================================
- Hits 52917 52915 -2
- Misses 37325 37332 +7
- Partials 7604 7605 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
bk1012
deleted the
feat/support-registerMultiDocumentHighlightProvider
branch
Types
Background or solution
Empty implement VSCode proposed API: registerMultiDocumentHighlightProvider
这个 API 依赖 monaco > 1.85 ，因此暂时空实现
cc @Ricbet
Changelog
Summary by CodeRabbit
新功能
MultiDocumentHighlight类，用于处理多个文档的高亮显示。registerMultiDocumentHighlightProvider方法，允许注册多文档高亮提供者。registerDocumentDropEditProvider和registerEvaluatableExpressionProvider方法，提供文档编辑和可评估表达式的支持。onDidChangeDiagnostics事件，监控诊断信息的变化。getDiagnostics方法，支持获取所有资源的诊断信息。文档