Expose shell integration command knowledge to extensions

Shell integration in the terminal could enable APIs like being able to listen to commands that run and get their output/exit code.

Rough example:

interface Terminal {
  executeCommand(command): Thenable<TerminalCommandResult>;
}

I came here to request this, and here it is already.
Being in Backlog means it'll get on the work plan eventually?

Cheers, looking forward to this, it's the missing link for my 'debug last command line' extension!

ClockworkV

ClockworkV backlog means it's a valid item and it may be worked on in the future. I'm pretty sure this one will happen within the next year

Alex Ross (@alexr00)

Proposal:

registerQuickFixProvider(...options: ITerminalQuickFixOptions[]): void;


export interface ITerminalQuickFixOptions {
	commandLineMatcher: string | RegExp;
	outputMatcher?: ITerminalOutputMatcher;
	getQuickFixes: TerminalQuickFixCallback;
	exitStatus?: boolean;
}
export type TerminalQuickFixMatchResult = { commandLineMatch: RegExpMatchArray; outputMatch?: RegExpMatchArray | null };
export type TerminalQuickFixAction = IAction | ITerminalQuickFixCommandAction | ITerminalQuickFixOpenerAction;
export type TerminalQuickFixCallback = (matchResult: TerminalQuickFixMatchResult, command: ITerminalCommand) => TerminalQuickFixAction[] | TerminalQuickFixAction | undefined;

export interface ITerminalQuickFixCommandAction {
	type: 'command';
	command: string;
	addNewLine: boolean;
}
export interface ITerminalQuickFixOpenerAction {
	type: 'opener';
	uri: URI;
}
export interface ITerminalOutputMatcher {
	/**
	 * A string or regex to match against the unwrapped line. If this is a regex with the multiline
	 * flag, it will scan an amount of lines equal to `\n` instances in the regex + 1.
	 */
	lineMatcher: string | RegExp;
	/**
	 * Which side of the output to anchor the {@link offset} and {@link length} against.
	 */
	anchor: 'top' | 'bottom';
	/**
	 * How far from either the top or the bottom of the butter to start matching against.
	 */
	offset: number;
	/**
	 * The number of rows to match against, this should be as small as possible for performance
	 * reasons.
	 */
	length: number;
}

Alex Ross (@alexr00) and Ladislau Szomoru (@lszomoru) how does this look to you, as you'll be adopting this for the git extension?

Megan Rogge (@meganrogge)

Megan Rogge (@meganrogge) I've forked this off to #162950 as I realized this issue is more about general listening to commands

Voting for this issue. The proposed interface would exactly solve a problem I have developing an extension.

+1 for this, can we get it on a roadmap plz?

Megan Rogge (@meganrogge)

Hi Megan Rogge (@meganrogge) and Daniel Imms (@Tyriar) - I've noticed this issue has been on an "iteration plan" in Nov and Oct of 2022. I'm wondering if you think it will be picked up any time soon? Thanks, really appreciate all the hard work!

Moving to July for Python to adopt first and give feedback before finalizing.

Is there any way to receive a stream of raw data from a terminal that does not have shell integration? For example if I create a terminal with any command of my choice by setting shellPath to argv[0] and shellArgs to argv[1...].

Since there's only one command that could plausibly be run in that terminal it's not necessary to try and guess which command the output comes from. The current API doesn't seem to offer anything to cover this use case, and I think it would be too limiting for my purpose.

Catherine (@whitequark)

Catherine (@whitequark) no, this is only for when shell integration is enabled. There is the related proposal for buffer access which allows reading the buffer which would probably cover your use case. #207504

Daniel Imms (@Tyriar)

Daniel Imms (@Tyriar) Thank you, this really helps!

Clarify TerminalShellExecutionEndEvent.exitCode

I have a quick question. What is the difference between this API and vscode.proposed.terminalExecuteCommandEvent.d.ts? My current use case is grabbing the output from an executed command, and I am using vscode.proposed.terminalExecuteCommandEvent.d.ts to do so. I suppose we can also use read() from vscode.proposed.terminalShellIntegration.d.ts to read the output stream but feel free to correct me. I wonder which one would you think have a higher chance for public release. Before these two APIs I remembered having to work around with the old vscode.proposed.terminalDataWriteEvent.d.ts, so I truly appreciate the current more stable approaches you have made available. Thanks!

Tri Pham (@itstreefam)

Tri Pham (@itstreefam) terminalExecuteCommandEvent is old and will be removed, terminalDataWriteEvent is unlikely to get finalized and may be replaced eventually with improvements upon terminalShellIntegration. terminalShellIntegration should be finalized very soon, I just need a fix a few bugs with it.

Johannes Rieken (@jrieken)

Plan:

Fix the 2 bugs that have been found, these are impl-related, not API shape related TerminalShellExecution.read() shows extra comma #221405, Don't fire onDidEndTerminalShellExecution with exitCode undefined immediately after first onDidChangeTerminalShellIntegration #221399
Get final sign off from Johannes Rieken (@jrieken)
Finalize for August

Finalize shellIntegration API

Update distro

Navigation Menu

Repository navigation

Expose shell integration command knowledge to extensions #145234

133 remaining items

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Expose shell integration command knowledge to extensions #145234

Description

Activity

ClockworkV commented on Mar 17, 2022

Tyriar commented on Jul 8, 2022

meganrogge commented on Oct 5, 2022

Tyriar commented on Oct 7, 2022

mmisiewicz commented on Jun 3, 2023

lroberts7 commented on Jun 5, 2023

mmisiewicz-yext commented on Jun 30, 2023

133 remaining items

Tyriar commented on Jun 18, 2024

whitequark commented on Jun 25, 2024

Tyriar commented on Jun 25, 2024

whitequark commented on Jun 25, 2024

itstreefam commented on Jul 25, 2024

Tyriar commented on Jul 25, 2024

Tyriar commented on Jul 30, 2024

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions