SCM - refactor history item hover for the graph #278778
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the SCM history item hover rendering to support arrays of MarkdownString objects for the graph view. The main changes enable VS Code to inject reference badges with appropriate colors into history item hovers, since extensions don't have access to the graph coloring information.
- Extends the tooltip API to support arrays of MarkdownString objects instead of just strings or single MarkdownStrings
- Moves hover rendering logic from the git extension to VS Code's SCM view layer
- Creates a new shared
hover.tsmodule in the git extension for reusable hover generation functions - Updates CSS selectors to support the new multi-markdown structure
Reviewed changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/vscode-dts/vscode.proposed.scmHistoryProvider.d.ts | Updates tooltip API to support MarkdownString | Array<MarkdownString> instead of string | MarkdownString |
| src/vs/workbench/contrib/scm/common/history.ts | Updates internal tooltip type to match the new API definition |
| src/vs/workbench/contrib/scm/browser/scmHistoryViewPane.ts | Adds _renderHoverContent method to handle tooltip arrays and inject reference badges with colors |
| src/vs/workbench/contrib/scm/browser/media/scm.css | Updates CSS selectors to target the new .history-item-hover-container and .rendered-markdown structure |
| src/vs/workbench/api/common/extHostSCM.ts | Converts extension tooltip data using MarkdownString.fromMany for arrays |
| src/vs/workbench/api/common/extHost.protocol.ts | Updates the DTO type definition to match the new API |
| extensions/git/src/hover.ts | New file containing shared hover generation functions extracted from historyProvider.ts |
| extensions/git/src/historyProvider.ts | Removes hover rendering logic and references/backgroundColor properties from history item refs |
| extensions/git/src/timelineProvider.ts | Updates to use the new hover functions from hover.ts |
| extensions/git/src/blame.ts | Updates to use the new hover functions from hover.ts |
| } | ||
|
|
||
| markdownString.appendMarkdown(`\n\n---\n\n`); | ||
| historyItem.tooltip.splice(historyItem.tooltip.length - 1, 0, markdownString); |
There was a problem hiding this comment.
Direct mutation of the tooltip array should be avoided as it modifies the original data structure from the extension. This can lead to unexpected behavior if the tooltip is rendered multiple times or cached by the extension. Consider creating a new array instead:
const tooltipWithReferences = [...historyItem.tooltip];
tooltipWithReferences.splice(tooltipWithReferences.length - 1, 0, markdownString);Then iterate over tooltipWithReferences in the loop below instead of historyItem.tooltip.
bpasero
previously approved these changes
Nov 21, 2025
joaomoreno
approved these changes
Nov 21, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.