Skip to content

on cursor move, clear and recreate terminal initial hint #286803

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.

Sign up for GitHub

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

Open
meganrogge wants to merge 2 commits into
base: release/1.108
Choose a base branch
from
+21 −9
Open

on cursor move, clear and recreate terminal initial hint #286803

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
608355f
on cursor move, clear and recreate terminal initial hint (#286392)
meganrogge Jan 8, 2026
2383dc0
revert changes to unrelated file
meganrogge Jan 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions ...workbench/contrib/terminalContrib/inlineHint/browser/terminal.initialHint.contribution.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,9 @@ export class TerminalInitialHintContribution extends Disposable implements ITerm
static get(instance: ITerminalInstance | IDetachedTerminalInstance): TerminalInitialHintContribution | null {
return instance.getContribution<TerminalInitialHintContribution>(TerminalInitialHintContribution.ID);
}
private _decoration: IDecoration | undefined;
private readonly _decoration = this._register(new MutableDisposable<IDecoration>());
private _xterm: IXtermTerminal & { raw: RawXtermTerminal } | undefined;
private readonly _cursorMoveListener = this._register(new MutableDisposable());

constructor(
private readonly _ctx: ITerminalContributionContext | IDetachedCompatibleTerminalContributionContext,
Expand All @@ -108,6 +109,12 @@ export class TerminalInitialHintContribution extends Disposable implements ITerm
this._register(this._addon.onDidRequestCreateHint(() => this._createHint()));
}

private _disposeHint(): void {
this._hintWidget?.remove();
this._hintWidget = undefined;
this._decoration.clear();
}

private _createHint(): void {
const instance = this._ctx.instance instanceof TerminalInstance ? this._ctx.instance : undefined;
const commandDetectionCapability = instance?.capabilities.get(TerminalCapability.CommandDetection);
Expand All @@ -119,7 +126,7 @@ export class TerminalInitialHintContribution extends Disposable implements ITerm
return;
}

if (!this._decoration) {
if (!this._decoration.value) {
const marker = this._xterm.raw.registerMarker();
if (!marker) {
return;
Expand All @@ -129,13 +136,10 @@ export class TerminalInitialHintContribution extends Disposable implements ITerm
return;
}
this._register(marker);
this._decoration = this._xterm.raw.registerDecoration({
this._decoration.value = this._xterm.raw.registerDecoration({
marker,
x: this._xterm.raw.buffer.active.cursorX + 1,
});
if (this._decoration) {
this._register(this._decoration);
}
}

this._register(this._xterm.raw.onKey(() => this.dispose()));
Expand All @@ -155,11 +159,19 @@ export class TerminalInitialHintContribution extends Disposable implements ITerm
}));
}

if (!this._decoration) {
// Listen to cursor move and recreate the hint (only if no input has been received)
// Fixes #286080 an issue where the hint would not reposition correctly when the terminal's prompt changed
this._cursorMoveListener.value = this._xterm.raw.onCursorMove(() => {
if (!inputModel?.value) {
this._disposeHint();
this._createHint();
}
});

if (!this._decoration.value) {
return;
}
this._register(this._decoration);
this._register(this._decoration.onRender((e) => {
this._register(this._decoration.value.onRender((e) => {
if (!this._hintWidget && this._xterm?.isFocused) {
const widget = this._register(this._instantiationService.createInstance(TerminalInitialHintWidget, instance));
this._addon?.dispose();
Expand Down
Loading