Skip to content

Clear promptInput's value onCommandFinished #287139

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

Merged
anthonykim1 merged 4 commits into from
Jan 14, 2026
Merged

Clear promptInput's value onCommandFinished #287139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a2752ec
Clear promptInputModel value onDidCommandFinish
anthonykim1 Jan 12, 2026
2c33701
Add test
anthonykim1 Jan 12, 2026
d604ce4
Remove stale state that doesnt exist anymore
anthonykim1 Jan 12, 2026
f936493
Fire Empty _onDidChangeInput on promptInputModel _handlecommandFinish
anthonykim1 Jan 13, 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
9 changes: 9 additions & 0 deletions src/vs/platform/terminal/common/capabilities/commandDetection/promptInputModel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ export class PromptInputModel extends Disposable implements IPromptInputModel {
onCommandStart: Event<ITerminalCommand>,
onCommandStartChanged: Event<void>,
onCommandExecuted: Event<ITerminalCommand>,
onCommandFinished: Event<ITerminalCommand>,
@ILogService private readonly _logService: ILogService
) {
super();
Expand All @@ -127,6 +128,7 @@ export class PromptInputModel extends Disposable implements IPromptInputModel {
this._register(onCommandStart(e => this._handleCommandStart(e as { marker: IMarker })));
this._register(onCommandStartChanged(() => this._handleCommandStartChanged()));
this._register(onCommandExecuted(() => this._handleCommandExecuted()));
this._register(onCommandFinished(() => this._handleCommandFinished()));

this._register(this.onDidStartInput(() => this._logCombinedStringIfTrace('PromptInputModel#onDidStartInput')));
this._register(this.onDidChangeInput(() => this._logCombinedStringIfTrace('PromptInputModel#onDidChangeInput')));
Expand Down Expand Up @@ -261,6 +263,13 @@ export class PromptInputModel extends Disposable implements IPromptInputModel {
this._onDidChangeInput.fire(event);
}

private _handleCommandFinished() {
// Clear the prompt input value when command finishes to prepare for the next command
Comment thread
anthonykim1 marked this conversation as resolved.
// This prevents runCommand from detecting leftover text and sending ^C unnecessarily
Comment thread
anthonykim1 marked this conversation as resolved.
this._value = '';
Comment thread
anthonykim1 marked this conversation as resolved.
Comment thread
anthonykim1 marked this conversation as resolved.
Copy link
Copy Markdown
Contributor Author

@anthonykim1 anthonykim1 Jan 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if it will be good idea to fire an empty _onDidChangeInput here, because we havent started the "new" input yet.

Copy link
Copy Markdown
Contributor

@Tyriar Tyriar Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we're changing the value, let's fire it to be consistent and see if there are any problems.

this._onDidChangeInput.fire(this._createStateObject());
}

@throttle(0)
private _sync() {
try {
Expand Down
2 changes: 1 addition & 1 deletion src/vs/platform/terminal/common/capabilities/commandDetectionCapability.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ export class CommandDetectionCapability extends Disposable implements ICommandDe
) {
super();
this._currentCommand = new PartialTerminalCommand(this._terminal);
this._promptInputModel = this._register(new PromptInputModel(this._terminal, this.onCommandStarted, this.onCommandStartChanged, this.onCommandExecuted, this._logService));
this._promptInputModel = this._register(new PromptInputModel(this._terminal, this.onCommandStarted, this.onCommandStartChanged, this.onCommandExecuted, this.onCommandFinished, this._logService));

// Pull command line from the buffer if it was not set explicitly
this._register(this.onCommandExecuted(command => {
Expand Down
23 changes: 22 additions & 1 deletion src/vs/platform/terminal/test/common/capabilities/commandDetection/promptInputModel.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ suite('PromptInputModel', () => {
let onCommandStart: Emitter<ITerminalCommand>;
let onCommandStartChanged: Emitter<void>;
let onCommandExecuted: Emitter<ITerminalCommand>;
let onCommandFinished: Emitter<ITerminalCommand>;

async function writePromise(data: string) {
await new Promise<void>(r => xterm.write(data, r));
Expand All @@ -37,6 +38,10 @@ suite('PromptInputModel', () => {
onCommandExecuted.fire(null!);
}

function fireCommandFinished() {
onCommandFinished.fire(null!);
}

function setContinuationPrompt(prompt: string) {
promptInputModel.setContinuationPrompt(prompt);
}
Expand Down Expand Up @@ -68,7 +73,8 @@ suite('PromptInputModel', () => {
onCommandStart = store.add(new Emitter());
onCommandStartChanged = store.add(new Emitter());
onCommandExecuted = store.add(new Emitter());
promptInputModel = store.add(new PromptInputModel(xterm, onCommandStart.event, onCommandStartChanged.event, onCommandExecuted.event, new NullLogService));
onCommandFinished = store.add(new Emitter());
promptInputModel = store.add(new PromptInputModel(xterm, onCommandStart.event, onCommandStartChanged.event, onCommandExecuted.event, onCommandFinished.event, new NullLogService));
});

test('basic input and execute', async () => {
Expand Down Expand Up @@ -138,6 +144,21 @@ suite('PromptInputModel', () => {
});
});

test('should clear value when command finishes', async () => {
await writePromise('$ ');
fireCommandStart();
await assertPromptInput('|');

await writePromise('echo hello');
await assertPromptInput('echo hello|');

fireCommandExecuted();
strictEqual(promptInputModel.value, 'echo hello');

fireCommandFinished();
strictEqual(promptInputModel.value, '');
});
Comment thread
anthonykim1 marked this conversation as resolved.
Comment thread
anthonykim1 marked this conversation as resolved.
Comment thread
anthonykim1 marked this conversation as resolved.

test('cursor navigation', async () => {
await writePromise('$ ');
fireCommandStart();
Expand Down
12 changes: 0 additions & 12 deletions ...rkbench/contrib/terminal/test/browser/xterm/recordings/rich/macos_zsh_omz_echo_3_times.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,10 +137,6 @@ export const events = [
"type": "output",
"data": ""
},
{
"type": "promptInputChange",
"data": "echo a"
},
{
"type": "output",
"data": "\u001b]633;P;Cwd=/Users/tyriar/playground/test1\u0007\u001b]633;EnvSingleStart;0;448d50d0-70fe-4ab5-842e-132f3b1c159a;\u0007\u001b]633;EnvSingleEnd;448d50d0-70fe-4ab5-842e-132f3b1c159a;\u0007\r\u001b[0m\u001b[27m\u001b[24m\u001b[J\u001b]633;A\u0007tyriar@Mac test1 % \u001b]633;B\u0007\u001b[K\u001b[?2004h"
Expand Down Expand Up @@ -245,10 +241,6 @@ export const events = [
"type": "output",
"data": ""
},
{
"type": "promptInputChange",
"data": "echo b"
},
{
"type": "output",
"data": "\u001b]633;P;Cwd=/Users/tyriar/playground/test1\u0007\u001b]633;EnvSingleStart;0;448d50d0-70fe-4ab5-842e-132f3b1c159a;\u0007\u001b]633;EnvSingleEnd;448d50d0-70fe-4ab5-842e-132f3b1c159a;\u0007\r\u001b[0m\u001b[27m\u001b[24m\u001b[J\u001b]633;A\u0007tyriar@Mac test1 % \u001b]633;B\u0007\u001b[K\u001b[?2004h"
Expand Down Expand Up @@ -357,10 +349,6 @@ export const events = [
"type": "output",
"data": ""
},
{
"type": "promptInputChange",
"data": "echo c"
},
{
"type": "output",
"data": "\u001b]633;P;Cwd=/Users/tyriar/playground/test1\u0007\u001b]633;EnvSingleStart;0;448d50d0-70fe-4ab5-842e-132f3b1c159a;\u0007\u001b]633;EnvSingleEnd;448d50d0-70fe-4ab5-842e-132f3b1c159a;\u0007\r\u001b[0m\u001b[27m\u001b[24m\u001b[J\u001b]633;A\u0007tyriar@Mac test1 % \u001b]633;B\u0007\u001b[K\u001b[?2004h"
Expand Down
Loading