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: empty impl VSCode TerminalShellIntegration API #4210

Merged
merged 2 commits into from
Dec 10, 2024

Conversation

bk1012
Copy link
Member

@bk1012 bk1012 commented Dec 10, 2024

Types

  • 🎉 New Features

Background or solution

Changelog

Summary by CodeRabbit

  • 新功能

    • 添加了新的枚举 TerminalShellExecutionCommandLineConfidence,提供低、中、高三个信心级别。
    • Terminal 类中新增 shellIntegration 属性,增强终端功能。
    • 引入多个与终端命令执行相关的新事件,允许扩展响应终端事件变化。
  • 文档

    • 更新了类型定义,新增与终端壳集成相关的接口和事件。

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

coderabbitai bot commented Dec 10, 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 > file-entry-cache > flat-cache > rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
warning eslint > @humanwhocodes/config-array > @humanwhocodes/object-schema@2.0.3: Use @eslint/object-schema instead
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

此拉取请求引入了一系列与终端 shell 集成功能相关的更改,包括添加新的枚举、接口和事件。这些更改旨在扩展终端的能力,使其能够更好地处理命令执行和集成事件。具体而言,新增的 TerminalShellExecutionCommandLineConfidence 枚举、shellIntegration 属性以及多个事件常量,都为终端命令的执行和集成提供了更丰富的类型定义和事件处理机制。

Changes

文件路径 更改摘要
packages/extension/src/common/vscode/ext-types.ts 新增枚举:TerminalShellExecutionCommandLineConfidence
packages/extension/src/hosted/api/vscode/ext.host.terminal.ts 新增属性:`shellIntegration: vscode.TerminalShellIntegration
packages/extension/src/hosted/api/vscode/ext.host.window.api.impl.ts 更新方法签名:createWindowApiFactory(...),新增事件属性 onDidChangeTerminalShellIntegrationonDidEndTerminalShellExecutiononDidStartTerminalShellExecution
packages/types/vscode/typings/vscode.d.ts 新增属性:`readonly shellIntegration: TerminalShellIntegration
packages/types/vscode/typings/vscode.window.d.ts 新增事件常量:onDidChangeTerminalShellIntegrationonDidStartTerminalShellExecutiononDidEndTerminalShellExecution

Possibly related PRs

Suggested labels

🎨 feature

Suggested reviewers

  • Ricbet

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: 2

🧹 Outside diff range and nitpick comments (1)
packages/extension/src/hosted/api/vscode/ext.host.window.api.impl.ts (1)

301-306: 修正注释和属性名称中的拼写错误

注释和属性名称中的 "Ingration" 应修改为 "Integration"。请确保注释和代码中的拼写一致,以提高代码的可读性和维护性。

建议应用以下修改:

-        /** @stubbed Terminal Shell Ingration */
+        /** @stubbed Terminal Shell Integration */
         onDidChangeTerminalShellIntegration: Event.None,
-        /** @stubbed Terminal Shell Ingration */
+        /** @stubbed Terminal Shell Integration */
         onDidEndTerminalShellExecution: Event.None,
-        /** @stubbed Terminal Shell Ingration */
+        /** @stubbed Terminal Shell Integration */
         onDidStartTerminalShellExecution: Event.None,
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 48699f8 and f2c790b.

📒 Files selected for processing (5)
  • packages/extension/src/common/vscode/ext-types.ts (1 hunks)
  • packages/extension/src/hosted/api/vscode/ext.host.terminal.ts (1 hunks)
  • packages/extension/src/hosted/api/vscode/ext.host.window.api.impl.ts (2 hunks)
  • packages/types/vscode/typings/vscode.d.ts (2 hunks)
  • packages/types/vscode/typings/vscode.window.d.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/extension/src/common/vscode/ext-types.ts
🔇 Additional comments (2)
packages/extension/src/hosted/api/vscode/ext.host.terminal.ts (1)

710-711: 代码实现良好

Terminal 类添加了 shellIntegration 属性,其实现符合预期。

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

3119-3130: 代码实现良好

Terminal 接口中新增的 shellIntegration 属性定义合理,文档描述清晰。

Copy link

codecov bot commented Dec 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.04%. Comparing base (6e24e5b) to head (f2c790b).
Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4210   +/-   ##
=======================================
  Coverage   54.03%   54.04%           
=======================================
  Files        1616     1616           
  Lines       97996    98003    +7     
  Branches    20061    20062    +1     
=======================================
+ Hits        52955    52966   +11     
+ Misses      37420    37416    -4     
  Partials     7621     7621           
Flag Coverage Δ
jsdom 49.62% <100.00%> (+<0.01%) ⬆️
node 15.55% <66.66%> (+<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 10, 2024 10:50
@bk1012 bk1012 merged commit 26b505f into main Dec 10, 2024
13 checks passed
@bk1012 bk1012 deleted the feat/support-Terminal.shellIntegration branch December 10, 2024 10:51
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