@theia/terminal 1.70.0-next.71 → 1.70.0

package/src/browser/terminal-widget-impl.ts

@@ -14,7 +14,7 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 // *****************************************************************************
 
-import { Terminal } from 'xterm';
+import { Terminal, IMarker } from 'xterm';
 import { FitAddon } from 'xterm-addon-fit';
 import { WebglAddon } from 'xterm-addon-webgl';
 import { inject, injectable, named, postConstruct } from '@theia/core/shared/inversify';
@@ -32,7 +32,9 @@ import { TerminalWatcher } from '../common/terminal-watcher';
 import {
     TerminalWidgetOptions, TerminalWidget, TerminalDimensions, TerminalExitStatus, TerminalLocationOptions,
     TerminalLocation,
-    TerminalBuffer
+    TerminalBuffer,
+    TerminalBlock,
+    TerminalCommandHistoryState
 } from './base/terminal-widget';
 import { Deferred } from '@theia/core/lib/common/promise-util';
 import { TerminalPreferences } from '../common/terminal-preferences';
@@ -52,6 +54,7 @@ import { MarkdownRenderer, MarkdownRendererFactory } from '@theia/core/lib/brows
 import { RemoteConnectionProvider, ServiceConnectionProvider } from '@theia/core/lib/browser/messaging/service-connection-provider';
 import { ColorRegistry } from '@theia/core/lib/browser/color-registry';
 import { cleanTerminalTitle, guessShellTypeFromExecutable } from '../common/shell-type';
+import { TerminalCommandHistoryStateFactory } from './terminal-command-history';
 
 export const TERMINAL_WIDGET_FACTORY_ID = 'terminal';
 
@@ -143,6 +146,7 @@ export class TerminalWidgetImpl extends TerminalWidget implements StatefulWidget
     @inject(ShellCommandBuilder) protected readonly shellCommandBuilder: ShellCommandBuilder;
     @inject(ContextMenuRenderer) protected readonly contextMenuRenderer: ContextMenuRenderer;
     @inject(MarkdownRendererFactory) protected readonly markdownRendererFactory: MarkdownRendererFactory;
+    @inject(TerminalCommandHistoryStateFactory) protected readonly commandHistoryStateFactory: TerminalCommandHistoryStateFactory;
 
     protected _markdownRenderer: MarkdownRenderer | undefined;
     protected get markdownRenderer(): MarkdownRenderer {
@@ -179,6 +183,12 @@ export class TerminalWidgetImpl extends TerminalWidget implements StatefulWidget
 
     protected readonly toDisposeOnConnect = new DisposableCollection();
 
+    protected readonly commandSeparatorDecorations = new DisposableCollection();
+
+    protected readonly toDisposeOnCommandHistory = new DisposableCollection();
+    protected outputStartMarker: IMarker | undefined;
+    protected promptStartMarker: IMarker | undefined;
+
     private _buffer: TerminalBuffer;
     override get buffer(): TerminalBuffer {
         return this._buffer;
@@ -186,6 +196,13 @@ export class TerminalWidgetImpl extends TerminalWidget implements StatefulWidget
 
     private _currentTerminalOutput: string[];
 
+    private _commandHistoryState?: TerminalCommandHistoryState;
+    override get commandHistoryState(): TerminalCommandHistoryState | undefined {
+        return this._commandHistoryState;
+    }
+
+    protected enableCommandSeparator: boolean;
+
     @postConstruct()
     protected init(): void {
         this.id = this._terminalDOMId;
@@ -222,7 +239,9 @@ export class TerminalWidgetImpl extends TerminalWidget implements StatefulWidget
             lineHeight: this.preferences['terminal.integrated.lineHeight'],
             scrollback: this.preferences['terminal.integrated.scrollback'],
             fastScrollSensitivity: this.preferences['terminal.integrated.fastScrollSensitivity'],
-            theme: this.themeService.theme
+            theme: this.themeService.theme,
+            // Enables proposed API to allow parsing of OSC 133 sequences for command tracking.
+            allowProposedApi: this.preferences['terminal.integrated.enableCommandHistory']
         });
         this._buffer = new TerminalBufferImpl(this.term);
         this._currentTerminalOutput = [];
@@ -237,9 +256,14 @@ export class TerminalWidgetImpl extends TerminalWidget implements StatefulWidget
 
         this.toDispose.push(this.preferences.onPreferenceChanged(change => {
             this.updateConfig();
+            if (change.preferenceName === 'terminal.integrated.enableCommandHistory') {
+                this.updateCommandHistoryHandlers();
+            }
             this.needsResize = true;
             this.update();
         }));
+        this.updateCommandHistoryConfig();
+        this.updateCommandHistoryHandlers();
 
         this.toDispose.push(this.themeService.onDidChange(() => {
             this.term.options.theme = this.themeService.theme;
@@ -282,12 +306,19 @@ export class TerminalWidgetImpl extends TerminalWidget implements StatefulWidget
                 } else {
                     this.exitStatus = { code, reason: TerminalExitReason.Process };
                 }
+                // Ensure any in-progress command block is closed even if the process exits
+                // before its OSC prompt_started bytes are flushed from the ring buffer.
+                if (this._commandHistoryState?.currentCommand) {
+                    this.finishCurrentCommand();
+                }
                 if (!attached) {
                     this.dispose();
                 }
             }
         }));
         this.toDispose.push(this.toDisposeOnConnect);
+        this.toDispose.push(this.commandSeparatorDecorations);
+        this.toDispose.push(this.toDisposeOnCommandHistory);
         this.toDispose.push(this.shellTerminalServer.onDidCloseConnection(() => {
             const disposable = this.shellTerminalServer.onDidOpenConnection(() => {
                 disposable.dispose();
@@ -384,6 +415,135 @@ export class TerminalWidgetImpl extends TerminalWidget implements StatefulWidget
         this.term.options.lineHeight = this.preferences.get('terminal.integrated.lineHeight');
         this.term.options.scrollback = this.preferences.get('terminal.integrated.scrollback');
         this.term.options.fastScrollSensitivity = this.preferences.get('terminal.integrated.fastScrollSensitivity');
+        this.updateCommandHistoryConfig();
+    }
+
+    protected updateCommandHistoryConfig(): void {
+        const enabled = this.preferences.get('terminal.integrated.enableCommandHistory', false);
+        this.term.options.allowProposedApi = enabled;
+        this.enableCommandSeparator = enabled
+            ? this.preferences.get('terminal.integrated.enableCommandSeparator', false)
+            : false;
+
+        if (enabled && !this._commandHistoryState) {
+            this._commandHistoryState = this.commandHistoryStateFactory();
+            this.toDispose.push(this._commandHistoryState);
+        } else if (!enabled && this._commandHistoryState) {
+            this._commandHistoryState.dispose();
+            this._commandHistoryState = undefined;
+        }
+    }
+
+    /**
+     * Registers or deregisters command history handlers based on the current preference state.
+     *
+     * Manages the OSC 133 handler that tracks command lifecycle events. OSC 133 is an iTerm2
+     * escape-sequence family marking events such as command start and prompt display
+     * (see https://iterm2.com/documentation-escape-codes.html). We use a customized subset:
+     *
+     *   - prompt_started: emitted when the prompt is shown (command output ends)
+     *   - command_started;<hex-encoded-command>: emitted when a command begins
+     *
+     * Command output is read directly from xterm's buffer using markers to track line positions,
+     * avoiding the need to intercept and sanitize raw terminal data.
+     */
+    protected updateCommandHistoryHandlers(): void {
+        this.toDisposeOnCommandHistory.dispose();
+        this.resetCommandOutputMarker();
+        this.resetCommandMarker();
+        if (!this._commandHistoryState) {
+            return;
+        }
+        this.toDisposeOnCommandHistory.push(
+            this.term.parser.registerOscHandler(133, (oscPayload: string) => {
+                if (!this._commandHistoryState) {
+                    return false;
+                }
+                if (oscPayload === 'prompt_started') {
+                    if (this._commandHistoryState.currentCommand) {
+                        this.finishCurrentCommand();
+                    }
+                    this.promptStartMarker?.dispose();
+                    this.promptStartMarker = this.term.registerMarker(0);
+                    if (this.enableCommandSeparator) {
+                        this.addCommandSeparator();
+                    }
+                } else if (oscPayload.startsWith('command_started')) {
+                    const command = oscPayload.split(';')[1];
+                    if (!command) {
+                        return false;
+                    }
+                    this.startNewCommand(command);
+                }
+                return true;
+            })
+        );
+    }
+
+    protected resetCommandOutputMarker(): void {
+        this.outputStartMarker?.dispose();
+        this.outputStartMarker = undefined;
+    }
+
+    protected resetCommandMarker(): void {
+        this.promptStartMarker?.dispose();
+        this.promptStartMarker = undefined;
+    }
+
+    protected startNewCommand(hexEncodedCommand: string): void {
+        if (!this._commandHistoryState) {
+            return;
+        }
+        this.outputStartMarker?.dispose();
+        this.outputStartMarker = this.term.registerMarker(0);
+        this._commandHistoryState.startCommand(hexEncodedCommand);
+    }
+
+    protected finishCurrentCommand(): void {
+        if (!this._commandHistoryState) {
+            return;
+        }
+        const startMarker = this.outputStartMarker;
+        const endMarker = this.term.registerMarker(0);
+        const startLine = startMarker?.line ?? -1;
+        const endLine = endMarker?.line ?? -1;
+        endMarker.dispose();
+
+        let output = '';
+        if (startLine >= 0 && endLine >= 0) {
+            output = this._buffer.getLines(startLine, endLine - startLine, true).join('\n');
+        }
+
+        const block: TerminalBlock = {
+            command: this._commandHistoryState.currentCommand,
+            output,
+        };
+
+        this.logger.debug('Terminal command result captured:', { command: block.command, output: block.output, outputLength: block.output.length });
+        this._commandHistoryState.finishCommand(block);
+        this.outputStartMarker = undefined;
+        this.promptStartMarker = undefined;
+    }
+
+    private addCommandSeparator(): void {
+        const marker = this.term.registerMarker(0);
+        if (!marker) {
+            return;
+        }
+
+        const deco = this.term.registerDecoration({ marker });
+        if (!deco) {
+            marker.dispose();
+            return;
+        }
+
+        const renderListener = deco.onRender(e => {
+            e.classList.add('terminal-command-separator');
+        });
+
+        this.commandSeparatorDecorations.push(marker);
+        this.commandSeparatorDecorations.push(deco);
+        this.commandSeparatorDecorations.push(renderListener);
     }
 
     protected setIconClass(): void {
@@ -649,7 +809,8 @@ export class TerminalWidgetImpl extends TerminalWidget implements StatefulWidget
             isPseudo: this.options.isPseudoTerminal,
             rootURI,
             cols,
-            rows
+            rows,
+            enableShellIntegration: this.preferences['terminal.integrated.enableCommandHistory'] ?? false,
         });
         if (IBaseTerminalServer.validateId(terminalId)) {
             const processInfo = await this.shellTerminalServer.getProcessInfo(terminalId);
@@ -847,6 +1008,10 @@ export class TerminalWidgetImpl extends TerminalWidget implements StatefulWidget
 
     async executeCommand(commandOptions: CommandLineOptions): Promise<void> {
         this.sendText(this.shellCommandBuilder.buildCommand(await this.processInfo, commandOptions) + OS.backend.EOL);
+        this.resetCommandOutputMarker();
+        if (this._commandHistoryState) {
+            this._commandHistoryState.clearCommandCollectionState();
+        }
     }
 
     scrollLineUp(): void {
@@ -903,6 +1068,7 @@ export class TerminalWidgetImpl extends TerminalWidget implements StatefulWidget
         }
         this.styleElement?.remove();
         this.webglAddon?.dispose();
+        this._commandHistoryState?.dispose();
         super.dispose();
     }
 
@@ -1057,4 +1223,5 @@ export class TerminalWidgetImpl extends TerminalWidget implements StatefulWidget
 
         return this.enhancedPreviewNode;
     }
+
 }

package/src/common/shell-terminal-protocol.ts

@@ -58,6 +58,12 @@ export interface IShellTerminalServerOptions extends IBaseTerminalServerOptions
     env?: { [key: string]: string | null },
     strictEnv?: boolean,
     isPseudo?: boolean,
+    /**
+     * Whether to inject shell integration scripts for command tracking.
+     * When enabled, shell integration scripts are injected to emit OSC 133 sequences.
+     * @default false
+     */
+    enableShellIntegration?: boolean;
 }
 
 export const ShellTerminalServerProxy = Symbol('ShellTerminalServerProxy');

package/src/common/terminal-preferences.ts

@@ -372,6 +372,18 @@ export const TerminalConfigSchema: PreferenceSchema = {
             description: nls.localizeByDefault('Persist terminal sessions/history for the workspace across window reloads.'),
             default: true
         },
+        'terminal.integrated.enableCommandHistory': {
+            type: 'boolean',
+            markdownDescription: nls.localize('theia/terminal/enableCommandHistory', 'Track terminal commands and their output separately using shell injection. This enables use cases such as visually distinguishing commands in the UI and giving AI agents more structured access to terminals. Toggling this setting will not affect terminals that are already open.\n\n \n\nThis feature is currently only supported by task terminals and user terminals running bash or zsh.'),
+            default: false,
+            tags: ['experimental']
+        },
+        'terminal.integrated.enableCommandSeparator': {
+            type: 'boolean',
+            markdownDescription: nls.localize('theia/terminal/enableCommandSeparator', 'Enable a visual separator between executed commands and their output in the terminal. Changes only apply to commands executed after this setting is modified. Only works when {0} is enabled.', '`#terminal.integrated.enableCommandHistory#`'),
+            default: false,
+            tags: ['experimental']
+        },
         'terminal.integrated.defaultProfile.windows': {
             type: 'string',
             description: nls.localize('theia/terminal/defaultProfile', 'The default profile used on {0}', OS.Type.Windows.toString())
@@ -556,6 +568,8 @@ export interface TerminalConfiguration {
     'terminal.integrated.profiles.osx': Profiles,
     'terminal.integrated.confirmOnExit': ConfirmOnExitType
     'terminal.integrated.enablePersistentSessions': boolean
+    'terminal.integrated.enableCommandHistory': boolean
+    'terminal.integrated.enableCommandSeparator': boolean
 }
 
 type FontWeight = 'normal' | 'bold' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900';

package/src/node/shell-integration-injector.ts

@@ -0,0 +1,94 @@
+// *****************************************************************************
+// Copyright (C) 2025 EclipseSource GmbH and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import path = require('path');
+import * as fs from 'fs';
+import { GeneralShellType, guessShellTypeFromExecutable } from '../common/shell-type';
+import { ShellProcess, ShellProcessOptions } from './shell-process';
+import { injectable } from '@theia/core/shared/inversify';
+
+@injectable()
+export class ShellIntegrationInjector {
+
+    protected readonly INTEGRATION_ROOT_DIR = 'shell-integrations';
+
+    protected readonly BASH_RCFILE_FLAG = '--rcfile';
+    protected readonly BASH_INTEGRATION_SCRIPT_PATH = 'bash/bash-integration.bash';
+
+    protected readonly ZSH_INTEGRATION_ENV_VAR = 'THEIA_ZSH_DIR';
+    protected readonly ZSH_INTEGRATION_DIR = 'zsh';
+    protected readonly ZDOTDIR_ENV_VAR = 'ZDOTDIR';
+    protected readonly ZDOTDIR_RELATIVE_DIR = '/zsh/zdotdir/';
+    protected readonly ZDOTDIR_ORIGINAL_ENV_VAR = 'THEIA_ORIGINAL_ZDOTDIR';
+
+    injectShellIntegration(options: ShellProcessOptions): ShellProcessOptions {
+        const shellExecutable = options.shell ?? ShellProcess.getShellExecutablePath();
+        const shellType = guessShellTypeFromExecutable(shellExecutable);
+        if (shellType === GeneralShellType.Bash) {
+            const scriptPath = this.getShellIntegrationPath(this.BASH_INTEGRATION_SCRIPT_PATH);
+            if (!scriptPath) {
+                return options;
+            }
+            // strips the login flag if present to avoid conflicts with --rcfile
+            const filteredArgs = this.stripLoginFlag(options.args);
+            return {
+                ...options,
+                args: [
+                    this.BASH_RCFILE_FLAG, scriptPath,
+                    ...(filteredArgs ?? []),
+                ],
+            };
+        } else if (shellType === GeneralShellType.Zsh) {
+            const zdotdirPath = this.getShellIntegrationPath(this.ZDOTDIR_RELATIVE_DIR);
+            const zshDirPath = this.getShellIntegrationPath(this.ZSH_INTEGRATION_DIR);
+            if (!zdotdirPath || !zshDirPath) {
+                return options;
+            }
+            return {
+                ...options,
+                env: {
+                    ...options.env,
+                    [this.ZDOTDIR_ENV_VAR]: zdotdirPath,
+                    [this.ZSH_INTEGRATION_ENV_VAR]: zshDirPath,
+                    [this.ZDOTDIR_ORIGINAL_ENV_VAR]: options.env?.ZDOTDIR ?? process.env.ZDOTDIR ?? ''
+                },
+            };
+        } else {
+            return options;
+        }
+    }
+
+    protected getShellIntegrationPath(relativePath: string): string | undefined {
+        const fullPath = path.join(__dirname, this.INTEGRATION_ROOT_DIR, relativePath);
+        if (!fs.existsSync(fullPath)) {
+            console.warn(`Shell integration file not found (application may not be bundled correctly): ${fullPath}`);
+            return undefined;
+        }
+        return fullPath;
+    }
+
+    protected stripLoginFlag(args: string | string[] | undefined): string[] | undefined {
+        if (args === undefined) {
+            return args;
+        }
+        if (typeof args === 'string') {
+            // split string on any amount of whitespace into an array
+            return args.trim().split(/\s+/).filter(arg => arg !== '-l' && arg !== '--login');
+        }
+        return args.filter(arg => arg !== '-l' && arg !== '--login');
+    }
+
+}

package/src/node/shell-integrations/bash/bash-integration.bash

@@ -0,0 +1,86 @@
+#!/bin/bash
+# *****************************************************************************
+# Copyright (C) 2000-2025 JetBrains s.r.o.
+# Modifications (C) 2025 EclipseSource GmbH and others.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions
+# and limitations under the License.
+#
+# Modifications:
+# - Rebranded internals from JetBrains/IntelliJ to Theia (`JETBRAINS_INTELLIJ_BASH_DIR` -> `THEIA_BASH_DIR`,
+#   `__jetbrains_intellij_restore_posix_flag` -> `__theia_restore_posix_flag`).
+# - Removed IntelliJ-provided environment injection (`_INTELLIJ_FORCE_SET_*` / `_INTELLIJ_FORCE_PREPEND_*` processing),
+#   plus optional sourcing of `JEDITERM_USER_RCFILE` and `JEDITERM_SOURCE` (+ args).
+# - Dropped keybinding setup for Ctrl-left/right word movement.
+# - Dropped IntelliJ command-history hook (`__INTELLIJ_COMMAND_HISTFILE__` + EXIT trap).
+# - Only sources `command-block-support.bash` (no `command-block-support-reworked.bash`), without readability checks.
+#
+# Source:
+# https://github.com/JetBrains/intellij-community/blob/8d02751ced444e5b70784fe0a757f960fe495a67/plugins/terminal/resources/shell-integrations/bash/bash-integration.bash
+# *****************************************************************************
+
+if [ -n "$LOGIN_SHELL" ]; then
+  unset LOGIN_SHELL
+
+  #       When bash is invoked as an interactive login shell, or as a  non-interac-
+  #       tive  shell with the --login option, it first reads and executes commands
+  #       from the file /etc/profile, if that  file  exists.   After  reading  that
+  #       file,  it  looks  for  ~/.bash_profile, ~/.bash_login, and ~/.profile, in
+  #       that order, and reads and executes  commands  from  the  first  one  that
+  #       exists  and  is  readable.
+
+  if [ -f /etc/profile ]; then
+     source /etc/profile
+  fi
+
+  if [ -f ~/.bash_profile ]; then
+    source ~/.bash_profile
+  else
+    if [ -f ~/.bash_login ]; then
+      source ~/.bash_login
+    else
+      if [ -f ~/.profile ]; then
+        source ~/.profile
+      fi
+    fi
+  fi
+else
+  if [ -f ~/.bashrc ]; then
+    source ~/.bashrc
+  fi
+fi
+
+function disable_posix() {
+  if shopt -qo posix
+  then
+    set +o posix
+    __theia_restore_posix_flag=1
+  fi
+}
+
+function restore_posix() {
+  if [ -n "${__theia_restore_posix_flag-}" ]
+  then
+    set -o posix
+    unset __theia_restore_posix_flag
+  fi
+}
+
+disable_posix
+
+THEIA_BASH_DIR="$(dirname "${BASH_SOURCE[0]}")"
+source "${THEIA_BASH_DIR}/command-block-support.bash"
+
+unset THEIA_BASH_DIR
+
+restore_posix
+unset -f disable_posix
+unset -f restore_posix