fix: add method to check if doc is ignored

[erha19]

Types

• 🐛 Bug Fixes

Background or solution

close #4319.

Changelog

add method to check if doc is ignored

Summary by CodeRabbit

• 新功能
  • 优化了文档处理逻辑，对部分特殊文档类型进行了智能过滤，避免了不必要的事件处理，从而提升了系统的响应速度和整体性能。

[hacke2]

LGTM

[coderabbitai]

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

该 PR 在 MainThreadExtensionDocumentData 类中新增了公有方法 isDocIgnored，用于判断传入文档的 URI scheme 是否等于 Schemes.walkThroughSnippet。同时，对多个文档事件处理方法（如内容变化、保存前、选项变更、文档创建、移除及保存事件）增加了该判断，若文档符合被忽略条件，则提前返回，阻断后续处理。

Changes

File(s)	Change Summary
packages/extension/.../main.thread.doc.ts	新增 isDocIgnored 方法；在 onEditorDocumentModelContentChangeEvent、onEditorDocumentModelWillSaveEvent、onEditorDocumentModelOptionChangedEvent、 onEditorDocumentModelContentCreationEvent、onEditorDocumentModelRemovedEvent 及 onEditorDocumentModelSavingEvent 中增加对忽略文档的判断，符合条件时提前返回。

Sequence Diagram(s)

sequenceDiagram
    participant Event as EditorEvent
    participant Data as MainThreadExtensionDocumentData
    participant Process as 后续处理

    Event->>Data: 触发文档事件
    Data->>Data: 调用 isDocIgnored(uri)
    alt 文档被忽略
        Data-->>Event: 提前返回，不进行处理
    else 文档未被忽略
        Data->>Process: 执行后续处理
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
防止 outputChannel.appendLine 导致的事件循环 [#4319]	✅

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5472a76 and 8ad0a76.

📒 Files selected for processing (1)

• packages/extension/src/browser/vscode/api/main.thread.doc.ts (7 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (8)

• GitHub Check: unittest (ubuntu-latest, 18.x, jsdom)
• GitHub Check: build-windows
• GitHub Check: unittest (ubuntu-latest, 18.x, node)
• GitHub Check: unittest (macos-latest, 18.x, jsdom)
• GitHub Check: build (ubuntu-latest, 20.x)
• GitHub Check: build (macos-latest, 20.x)
• GitHub Check: unittest (macos-latest, 18.x, node)
• GitHub Check: ubuntu-latest, Node.js 20.x

🔇 Additional comments (2)

packages/extension/src/browser/vscode/api/main.thread.doc.ts (2)

127-129: 实现正确且简洁！

该方法实现了对 walkThroughSnippet 类型文档的判断，逻辑清晰。

---

155-155: 文档事件处理逻辑统一且完整！

所有事件处理方法都统一添加了 isDocIgnored 检查，与 isDocSyncEnabled 检查配合使用，确保了对 walkThroughSnippet 类型文档的一致性处理。

建议添加单元测试以验证新增的忽略逻辑。

需要我帮您生成相关的单元测试代码吗？

Also applies to: 172-172, 184-184, 197-197, 212-212, 222-222

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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

Attention: Patch coverage is 50.00000% with 4 lines in your changes missing coverage. Please review.

Project coverage is 54.22%. Comparing base (5472a76) to head (8ad0a76).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
...xtension/src/browser/vscode/api/main.thread.doc.ts	50.00%	0 Missing and 4 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4341      +/-   ##
==========================================
- Coverage   54.23%   54.22%   -0.01%     
==========================================
  Files        1638     1638              
  Lines      100153   100155       +2     
  Branches    21738    21738              
==========================================
- Hits        54318    54313       -5     
- Misses      38087    38093       +6     
- Partials     7748     7749       +1     

Flag	Coverage Δ
jsdom	49.70% <50.00%> (-0.01%)	⬇️
node	12.29% <0.00%> (-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.