Terminal shell integration proposed api #208257
Merged
Conversation
This file contains 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
karrtikr
reviewed
Mar 25, 2024
Comment on lines
+62
to
+70
| export interface Terminal { | ||
| /** | ||
| * An object that contains [shell integration](https://code.visualstudio.com/docs/terminal/shell-integration)-powered | ||
| * features for the terminal. This will always be undefined immediately after the terminal | ||
| * is created. Listen to {@link window.onDidActivateTerminalShellIntegration} to be notified | ||
| * when shell integration is activated for a terminal. | ||
| */ | ||
| shellIntegration: TerminalShellIntegration | undefined; | ||
| } |
There was a problem hiding this comment.
Should probably include a note that shell integration may never activate for a terminal. For eg. One common case is command prompt
| * The current working directory of the terminal. This will be a {@link Uri} if the string | ||
| * reported by the shell can reliably be mapped to the connected machine. | ||
| */ | ||
| cwd: Uri | string | undefined; |
There was a problem hiding this comment.
Should probably be readonly
Comment on lines
+176
to
+185
| export interface TerminalShellIntegrationChangeEvent { | ||
| /** | ||
| * The terminal that shell integration has been activated in. | ||
| */ | ||
| terminal: Terminal; | ||
| /** | ||
| * The shell integration object. | ||
| */ | ||
| shellIntegration: TerminalShellIntegration; | ||
| } |
Comment on lines
+15
to
+43
| terminal: Terminal; | ||
|
|
||
| /** | ||
| * The full command line that was executed, including both the command and arguments. | ||
| * The accuracy of this value depends on the shell integration implementation: | ||
| * | ||
| * - It may be undefined or the empty string until {@link onDidEndTerminalShellExecution} is | ||
| * fired. | ||
| * - It may be inaccurate initially if the command line is pulled from the buffer directly | ||
| * via the [`OSC 633/133 ; A`, `B` and `C` sequences](https://code.visualstudio.com/docs/terminal/shell-integration#_vs-code-custom-sequences-osc-633-st). | ||
| * - It may contain line continuation characters and/or parts of the right prompt. | ||
| * - It may be inaccurate if the shell integration does not support command line reporting | ||
| * via the [`OSC 633 ; E` sequence](https://code.visualstudio.com/docs/terminal/shell-integration#_vs-code-custom-sequences-osc-633-st). | ||
| */ | ||
| commandLine: string | undefined; | ||
|
|
||
| /** | ||
| * The working directory that was reported by the shell when this command executed. This | ||
| * will be a {@link Uri} if the string reported by the shell can reliably be mapped to the | ||
| * connected machine. This requires the shell integration to support working directory | ||
| * reporting via the [`OSC 633 ; P`](https://code.visualstudio.com/docs/terminal/shell-integration#_vs-code-custom-sequences-osc-633-st) | ||
| * or `OSC 1337 ; CurrentDir=<Cwd> ST` sequences. | ||
| */ | ||
| cwd: Uri | string | undefined; | ||
|
|
||
| /** | ||
| * The exit code reported by the shell. | ||
| */ | ||
| exitCode: Thenable<number | undefined>; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Part of #145234
This is the initial implementation of the new
Terminal.shellIntegrationand related proposed APIs. There are a few TODOs still in the code but these will get resolved before finalization.@karrtikr these still aren't set in stone but it is probably worth trying to implement something against it for feedback once merged.