fix: passthrough icon and color for extension terminal #4515

ensorrow · Apr 18, 2025

Types

🐛 Bug Fixes

Background or solution

fix: passthrough icon and color for extension terminal

Changelog

fix: passthrough icon and color for extension terminal

Summary by CodeRabbit

新功能
- 终端现在支持为扩展终端指定图标和颜色，并可设置为临时终端。

coderabbitai · Apr 18, 2025

Walkthrough

本次变更主要扩展了终端创建逻辑，在扩展终端创建方法中增加了可选的 iconPath 和 color 参数，并在创建终端时将其传递给代理对象。同时，所有通过扩展 API 创建的终端现在都会被标记为 isTransient: true。相关调用处也同步调整，确保新的参数能够正确传递。

Changes

文件/路径	变更摘要
packages/extension/src/hosted/api/vscode/ext.host.terminal.ts	`Terminal` 类的 `createExtensionTerminal` 方法签名增加了 `iconPath` 和 `color` 可选参数，创建终端时将这两个参数及 `isTransient: true` 一起传递给代理。`ExtHostTerminal` 类中相应调用也做了参数传递调整。

Sequence Diagram(s)

sequenceDiagram
    participant Extension as 扩展
    participant ExtHostTerminal as ExtHostTerminal
    participant Terminal as Terminal
    participant Proxy as 代理

    Extension->>ExtHostTerminal: 调用 createExtensionTerminal(options)
    ExtHostTerminal->>Terminal: createExtensionTerminal(id, iconPath, color)
    Terminal->>Proxy: $createTerminal({id, iconPath, color, isTransient: true})
    Proxy-->>Terminal: 返回终端实例
    Terminal-->>ExtHostTerminal: 返回
    ExtHostTerminal-->>Extension: 返回

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.

yarn install v1.22.22
[1/4] Resolving packages...
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:*"
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 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 4a34280 and 5c086d6.

📒 Files selected for processing (1)

packages/extension/src/hosted/api/vscode/ext.host.terminal.ts (2 hunks)

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

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

🔇 Additional comments (2)

packages/extension/src/hosted/api/vscode/ext.host.terminal.ts (2)

226-226: 方法调用已更新以传递图标和颜色参数

在 ExtHostTerminal.createExtensionTerminal 方法中，已更新对 terminal.createExtensionTerminal 的调用，以传递 options.iconPath 和 options.color 参数。这确保了扩展终端的图标和颜色设置能够正确传递到终端创建逻辑中。

776-780: 终端创建方法已正确扩展以支持图标和颜色

Terminal.createExtensionTerminal 方法已更新，现在接受额外的 iconPath 和 color 参数，并在调用 proxy.$createTerminal 时将它们包含在选项中。同时，所有通过扩展 API 创建的终端现在都被标记为 isTransient: true，这有助于正确管理终端的生命周期。

这些更改直接解决了 PR 的目标，确保扩展终端能够正确显示自定义图标和颜色。

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
@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 · Apr 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 53.13%. Comparing base (4a34280) to head (5c086d6).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4515      +/-   ##
==========================================
- Coverage   53.14%   53.13%   -0.01%     
==========================================
  Files        1665     1665              
  Lines      102681   102681              
  Branches    22229    22229              
==========================================
- Hits        54567    54564       -3     
- Misses      40025    40027       +2     
- Partials     8089     8090       +1

Flag	Coverage Δ
jsdom	`48.63% <100.00%> (-0.01%)`	⬇️
node	`12.12% <0.00%> (ø)`

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.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

fix: passthrough icon and color for extension terminal

5c086d6

ensorrow requested review from erha19, frankLife and hacke2 April 18, 2025 07:47

opensumi bot added the 🐞 bug Something isn't working label Apr 18, 2025

ensorrow requested a review from life2015 April 18, 2025 07:47

erha19 approved these changes Apr 18, 2025

View reviewed changes

ensorrow merged commit 5f6ca59 into main Apr 18, 2025
16 of 17 checks passed

ensorrow deleted the fix/extension-terminal-icon branch April 18, 2025 08:26

erha19 mentioned this pull request May 20, 2025

chore(release): v3.9.0 #4565

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: passthrough icon and color for extension terminal #4515

fix: passthrough icon and color for extension terminal #4515

Uh oh!

ensorrow commented Apr 18, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 18, 2025

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov bot commented Apr 18, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Search code, repositories, users, issues, pull requests...

fix: passthrough icon and color for extension terminal #4515

fix: passthrough icon and color for extension terminal #4515

Uh oh!

Conversation

ensorrow commented Apr 18, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Types

Background or solution

Changelog

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 18, 2025

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

ensorrow commented Apr 18, 2025 •

edited by coderabbitai bot

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Apr 18, 2025 •

edited

Loading