feat: support VSCode API: provideDocumentRangesFormattingEdits

[bk1012]

Types

• 🎉 New Features

Background or solution

目前使用的 monaco 版本还不支持这个函数，因此这里暂时空实现，等后续升级 monaco 版本时再提供实现

Changelog

Summary by CodeRabbit

• 新功能
  • 在 DocumentRangeFormattingEditProvider 接口中新增了可选方法 provideDocumentRangesFormattingEdits，允许一次性格式化文档中的多个范围，提高了格式化请求的效率。

[coderabbitai]

Walkthrough

此拉取请求引入了在vscode模块的DocumentRangeFormattingEditProvider接口中新增的可选方法provideDocumentRangesFormattingEdits。该方法允许提供者在文档中格式化多个范围，从而提高了格式化请求的效率。方法签名定义了所需的参数和返回类型，同时保留了现有的provideDocumentRangeFormattingEdits方法，以继续处理单个范围的格式化请求。

Changes

文件路径	更改摘要
packages/types/vscode/typings/vscode.language.d.ts	新增可选方法provideDocumentRangesFormattingEdits，允许格式化多个范围，保留现有方法不变。

Possibly related PRs

• feat: implement line change code edits api #4106: 此PR涉及新API的实现，用于行更改触发器，可能与文档中多个范围的格式化相关，因为两者都涉及以结构化方式处理编辑。

Suggested reviewers

• hacke2
• erha19

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3383a0d and 8def3a6.

📒 Files selected for processing (1)

• packages/types/vscode/typings/vscode.language.d.ts (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

packages/types/vscode/typings/vscode.language.d.ts (1)

2378-2396: 新增的多范围格式化方法实现正确

该实现符合VSCode API的规范，通过提供可选的provideDocumentRangesFormattingEdits方法来支持多范围格式化。这种实现方式可以提高处理多个选择或修改范围时的格式化性能。

运行以下脚本验证实现是否与VSCode API保持一致：

✅ Verification successful

Let me gather more information to verify the implementation against VSCode's API.

---

Let me generate the final response based on the verification results.

多范围格式化方法的实现完全符合规范

该实现完全符合以下几点：

• 作为DocumentRangeFormattingEditProvider接口的可选方法正确添加
• 方法签名与参数类型完全匹配预期
• 文档注释完整准确地描述了该功能的用途和行为
• 与现有的单范围格式化方法provideDocumentRangeFormattingEdits保持了一致的设计风格

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 验证实现是否与VSCode API一致
rg -A 5 "provideDocumentRangesFormattingEdits" 

Length of output: 648

---

Script:

#!/bin/bash
# Search for DocumentRangeFormattingEditProvider interface definition
ast-grep --pattern 'interface DocumentRangeFormattingEditProvider {
  $$$
}'

# Search for any existing usage of the new method
rg "provideDocumentRangesFormattingEdits" -B 2 -A 2

Length of output: 6685

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.25%. Comparing base (3383a0d) to head (8def3a6).
Report is 3 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #4116   +/-   ##
=======================================
  Coverage   54.25%   54.25%           
=======================================
  Files        1598     1598           
  Lines       97561    97561           
  Branches    19948    19948           
=======================================
  Hits        52935    52935           
  Misses      37076    37076           
  Partials     7550     7550           

Flag	Coverage Δ
jsdom	49.81% <ø> (ø)
node	15.60% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.