Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support VSCode API: TextEditorLineNumbersStyle.Interval #4216

Merged
merged 1 commit into from
Dec 12, 2024

Conversation

bk1012
Copy link
Member

@bk1012 bk1012 commented Dec 11, 2024

Types

  • 🎉 New Features

Background or solution

Changelog

Summary by CodeRabbit

  • 新功能

    • 编辑器配置中新增“间隔”选项,允许每10行显示一次行号。
    • 改进了差异信息的检索能力,增强了错误处理机制。
  • 文档

    • 添加了新行号样式“间隔”的枚举值,扩展了行号渲染选项。

@opensumi opensumi bot added the 🎨 feature feature required label Dec 11, 2024
Copy link
Contributor

coderabbitai bot commented Dec 11, 2024

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

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

warning eslint@8.57.1: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning eslint > @humanwhocodes/config-array@0.13.0: Use @eslint/config-array instead
warning eslint > @humanwhocodes/config-array > @humanwhocodes/object-schema@2.0.3: Use @eslint/object-schema instead
warning eslint > file-entry-cache > flat-cache > rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob > inflight@1.0.6: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
warning eslint-import-resolver-typescript > glob@7.2.3: Glob versions prior to v9 are no longer supported
error Couldn't find any versions for "@opensumi/ide-dev-tool" that matches "workspace:*"

Walkthrough

该拉取请求对 MainThreadEditorService 类进行了修改,增强了编辑器配置和装饰的处理能力。新增了 lineNumbers 属性中的 interval 选项,允许四种可能的值:onoffrelativeinterval。此外,更新了 getDiffInformation 方法,以改善从差异编辑器中检索行更改的能力,并增强了错误处理机制,以提供更清晰的反馈。

Changes

文件路径 变更摘要
packages/extension/src/browser/vscode/api/main.thread.editor.ts 更新 MainThreadEditorService 类,新增 lineNumbersinterval 选项,改进 getDiffInformation 方法的错误处理和行更改检索逻辑。
packages/extension/src/common/vscode/converter.ts 更新 TextEditorLineNumbersStyle 命名空间,新增 Interval 行号样式,更新 fromto 函数以支持该样式,新增 gutterIconSize 属性。
packages/extension/src/common/vscode/ext-types.ts 新增 TextEditorLineNumbersStyle 枚举成员 Interval,赋值为 3
packages/types/sumi-worker/worker.editor.d.ts TextEditorLineNumbersStyle 枚举中新增 Interval 值,赋值为 3
packages/types/vscode/typings/vscode.editor.d.ts TextEditorLineNumbersStyle 枚举中新增 Interval 值,赋值为 3

Possibly related PRs

Suggested labels

🎨 feature

Suggested reviewers

  • Ricbet
  • erha19

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
🪧 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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
packages/extension/src/common/vscode/ext-types.ts (1)

989-989: 建议为新的枚举值添加文档注释

为了保持与其他枚举值的一致性和代码可读性,建议为 Interval 添加类似于其他枚举值的文档注释,说明其用途。

建议添加如下注释:

  Relative = 2,
+ /**
+  * 按间隔显示行号。
+  */
  Interval = 3,
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4a624df and 65ef1c5.

📒 Files selected for processing (5)
  • packages/extension/src/browser/vscode/api/main.thread.editor.ts (1 hunks)
  • packages/extension/src/common/vscode/converter.ts (2 hunks)
  • packages/extension/src/common/vscode/ext-types.ts (1 hunks)
  • packages/types/sumi-worker/worker.editor.d.ts (1 hunks)
  • packages/types/vscode/typings/vscode.editor.d.ts (1 hunks)
🔇 Additional comments (4)
packages/types/sumi-worker/worker.editor.d.ts (1)

127-130: 新增的行号显示样式实现正确!

枚举值的添加符合 VSCode API 规范,注释清晰地说明了每隔 10 行显示行号的功能。

packages/extension/src/browser/vscode/api/main.thread.editor.ts (1)

519-529: 行号间隔显示模式的实现完整且正确!

switch 语句中正确处理了新增的 interval 选项,与 TextEditorLineNumbersStyle 枚举的更新保持一致。

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

127-130: VSCode API 类型定义更新正确!

TextEditorLineNumbersStyle 枚举中新增的 Interval 选项定义完整,注释准确描述了每隔 10 行显示行号的功能。

packages/extension/src/common/vscode/converter.ts (1)

720-721: 转换器实现正确且完整

TextEditorLineNumbersStyle 命名空间中的 from() 和 to() 方法正确实现了 Interval 枚举值的双向转换,代码结构清晰。

Also applies to: 733-734

Copy link

codecov bot commented Dec 11, 2024

Codecov Report

Attention: Patch coverage is 12.50000% with 7 lines in your changes missing coverage. Please review.

Project coverage is 54.02%. Comparing base (01363d9) to head (65ef1c5).
Report is 4 commits behind head on main.

Files with missing lines Patch % Lines
packages/extension/src/common/vscode/converter.ts 0.00% 4 Missing ⚠️
...nsion/src/browser/vscode/api/main.thread.editor.ts 0.00% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4216      +/-   ##
==========================================
- Coverage   54.02%   54.02%   -0.01%     
==========================================
  Files        1616     1616              
  Lines       98044    98052       +8     
  Branches    20063    20058       -5     
==========================================
+ Hits        52967    52970       +3     
- Misses      37451    37457       +6     
+ Partials     7626     7625       -1     
Flag Coverage Δ
jsdom 49.60% <12.50%> (-0.01%) ⬇️
node 15.55% <12.50%> (-0.01%) ⬇️

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.

@bk1012 bk1012 requested a review from winjo December 12, 2024 02:47
@bk1012 bk1012 merged commit 99ba1a3 into main Dec 12, 2024
13 checks passed
@bk1012 bk1012 deleted the feat/support-TextEditorLineNumbersStyle.Interval branch December 12, 2024 02:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🎨 feature feature required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants