@theia/terminal 1.45.1 → 1.46.0-next.72

package/README.md

@@ -1,30 +1,30 @@
-<div align='center'>
-
-<br />
-
-<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
-
-<h2>ECLIPSE THEIA - TERMINAL EXTENSION</h2>
-
-<hr />
-
-</div>
-
-## Description
-
-The `@theia/terminal` extension contributes the ability to spawn integrated terminals in the application which can be used in a variety of different scenarios.
-
-## Additional Information
-
-- [API documentation for `@theia/terminal`](https://eclipse-theia.github.io/theia/docs/next/modules/terminal.html)
-- [Theia - GitHub](https://github.com/eclipse-theia/theia)
-- [Theia - Website](https://theia-ide.org/)
-
-## License
-
-- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
-- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
-
-## Trademark
-"Theia" is a trademark of the Eclipse Foundation
-https://www.eclipse.org/theia
+<div align='center'>
+
+<br />
+
+<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
+
+<h2>ECLIPSE THEIA - TERMINAL EXTENSION</h2>
+
+<hr />
+
+</div>
+
+## Description
+
+The `@theia/terminal` extension contributes the ability to spawn integrated terminals in the application which can be used in a variety of different scenarios.
+
+## Additional Information
+
+- [API documentation for `@theia/terminal`](https://eclipse-theia.github.io/theia/docs/next/modules/terminal.html)
+- [Theia - GitHub](https://github.com/eclipse-theia/theia)
+- [Theia - Website](https://theia-ide.org/)
+
+## License
+
+- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
+- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
+
+## Trademark
+"Theia" is a trademark of the Eclipse Foundation
+https://www.eclipse.org/theia

package/lib/browser/base/terminal-service.d.ts

@@ -1,35 +1,35 @@
-import { Event } from '@theia/core/lib/common/event';
-import { WidgetOpenerOptions } from '@theia/core/lib/browser';
-import { TerminalWidgetOptions, TerminalWidget } from './terminal-widget';
-/**
- * Service manipulating terminal widgets.
- */
-export declare const TerminalService: unique symbol;
-export interface TerminalService {
-    /**
-     * Create new terminal with predefined options.
-     * @param options - terminal options.
-     */
-    newTerminal(options: TerminalWidgetOptions): Promise<TerminalWidget>;
-    open(terminal: TerminalWidget, options?: WidgetOpenerOptions): void;
-    readonly all: TerminalWidget[];
-    /**
-     * @param id - the widget id (NOT the terminal id!)
-     * @return the widget
-     */
-    getById(id: string): TerminalWidget | undefined;
-    /**
-     * @param id - the terminal id (NOT the terminal widget id!)
-     * @return the widget
-     */
-    getByTerminalId(terminalId: number): TerminalWidget | undefined;
-    /**
-     * Returns detected default shell.
-     */
-    getDefaultShell(): Promise<string>;
-    readonly onDidCreateTerminal: Event<TerminalWidget>;
-    readonly currentTerminal: TerminalWidget | undefined;
-    readonly onDidChangeCurrentTerminal: Event<TerminalWidget | undefined>;
-    readonly lastUsedTerminal: TerminalWidget | undefined;
-}
+import { Event } from '@theia/core/lib/common/event';
+import { WidgetOpenerOptions } from '@theia/core/lib/browser';
+import { TerminalWidgetOptions, TerminalWidget } from './terminal-widget';
+/**
+ * Service manipulating terminal widgets.
+ */
+export declare const TerminalService: unique symbol;
+export interface TerminalService {
+    /**
+     * Create new terminal with predefined options.
+     * @param options - terminal options.
+     */
+    newTerminal(options: TerminalWidgetOptions): Promise<TerminalWidget>;
+    open(terminal: TerminalWidget, options?: WidgetOpenerOptions): void;
+    readonly all: TerminalWidget[];
+    /**
+     * @param id - the widget id (NOT the terminal id!)
+     * @return the widget
+     */
+    getById(id: string): TerminalWidget | undefined;
+    /**
+     * @param id - the terminal id (NOT the terminal widget id!)
+     * @return the widget
+     */
+    getByTerminalId(terminalId: number): TerminalWidget | undefined;
+    /**
+     * Returns detected default shell.
+     */
+    getDefaultShell(): Promise<string>;
+    readonly onDidCreateTerminal: Event<TerminalWidget>;
+    readonly currentTerminal: TerminalWidget | undefined;
+    readonly onDidChangeCurrentTerminal: Event<TerminalWidget | undefined>;
+    readonly lastUsedTerminal: TerminalWidget | undefined;
+}
 //# sourceMappingURL=terminal-service.d.ts.map

package/lib/browser/base/terminal-service.js

@@ -1,8 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TerminalService = void 0;
-/**
- * Service manipulating terminal widgets.
- */
-exports.TerminalService = Symbol('TerminalService');
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TerminalService = void 0;
+/**
+ * Service manipulating terminal widgets.
+ */
+exports.TerminalService = Symbol('TerminalService');
 //# sourceMappingURL=terminal-service.js.map

package/lib/browser/base/terminal-widget.d.ts

@@ -1,193 +1,193 @@
-import { Event, ViewColumn } from '@theia/core';
-import { BaseWidget } from '@theia/core/lib/browser';
-import { CommandLineOptions } from '@theia/process/lib/common/shell-command-builder';
-import { TerminalSearchWidget } from '../search/terminal-search-widget';
-import { TerminalProcessInfo, TerminalExitReason } from '../../common/base-terminal-protocol';
-import URI from '@theia/core/lib/common/uri';
-import { MarkdownString } from '@theia/core/lib/common/markdown-rendering/markdown-string';
-export interface TerminalDimensions {
-    cols: number;
-    rows: number;
-}
-export interface TerminalExitStatus {
-    readonly code: number | undefined;
-    readonly reason: TerminalExitReason;
-}
-export declare type TerminalLocationOptions = TerminalLocation | TerminalEditorLocation | TerminalSplitLocation;
-export declare enum TerminalLocation {
-    Panel = 1,
-    Editor = 2
-}
-export interface TerminalEditorLocation {
-    readonly viewColumn: ViewColumn;
-    readonly preserveFocus?: boolean;
-}
-export interface TerminalSplitLocation {
-    readonly parentTerminal: string;
-}
-/**
- * Terminal UI widget.
- */
-export declare abstract class TerminalWidget extends BaseWidget {
-    abstract processId: Promise<number>;
-    /**
-     * Get the current executable and arguments.
-     */
-    abstract processInfo: Promise<TerminalProcessInfo>;
-    /** The ids of extensions contributing to the environment of this terminal mapped to the provided description for their changes. */
-    abstract envVarCollectionDescriptionsByExtension: Promise<Map<string, (string | MarkdownString | undefined)[]>>;
-    /** Terminal kind that indicates whether a terminal is created by a user or by some extension for a user */
-    abstract readonly kind: 'user' | string;
-    abstract readonly terminalId: number;
-    abstract readonly dimensions: TerminalDimensions;
-    abstract readonly exitStatus: TerminalExitStatus | undefined;
-    /** Terminal widget can be hidden from users until explicitly shown once. */
-    abstract readonly hiddenFromUser: boolean;
-    /** The position of the terminal widget. */
-    abstract readonly location: TerminalLocationOptions;
-    /** The last CWD assigned to the terminal, useful when attempting getCwdURI on a task terminal fails */
-    lastCwd: URI;
-    /**
-     * Start terminal and return terminal id.
-     * @param id - terminal id.
-     */
-    abstract start(id?: number): Promise<number>;
-    /**
-     * Send text to the terminal server.
-     * @param text - text content.
-     */
-    abstract sendText(text: string): void;
-    /**
-     * Resolves when the command is successfully sent, this doesn't mean that it
-     * was evaluated. Might reject if terminal wasn't properly started yet.
-     *
-     * Note that this method will try to escape your arguments as if it was
-     * someone inputting everything in a shell.
-     *
-     * Supported shells: `bash`, `cmd.exe`, `wsl.exe`, `pwsh/powershell.exe`
-     */
-    abstract executeCommand(commandOptions: CommandLineOptions): Promise<void>;
-    /** Event that fires when the terminal is connected or reconnected */
-    abstract onDidOpen: Event<void>;
-    /** Event that fires when the terminal fails to connect or reconnect */
-    abstract onDidOpenFailure: Event<void>;
-    /** Event that fires when the terminal size changed */
-    abstract onSizeChanged: Event<{
-        cols: number;
-        rows: number;
-    }>;
-    /** Event that fires when the terminal receives a key event. */
-    abstract onKey: Event<{
-        key: string;
-        domEvent: KeyboardEvent;
-    }>;
-    /** Event that fires when the terminal input data */
-    abstract onData: Event<string>;
-    abstract scrollLineUp(): void;
-    abstract scrollLineDown(): void;
-    abstract scrollToTop(): void;
-    abstract scrollToBottom(): void;
-    abstract scrollPageUp(): void;
-    abstract scrollPageDown(): void;
-    abstract resetTerminal(): void;
-    /**
-     * Event which fires when terminal did closed. Event value contains closed terminal widget definition.
-     */
-    abstract onTerminalDidClose: Event<TerminalWidget>;
-    /**
-     * Cleat terminal output.
-     */
-    abstract clearOutput(): void;
-    /**
-     * Select entire content in the terminal.
-     */
-    abstract selectAll(): void;
-    abstract writeLine(line: string): void;
-    abstract write(data: string): void;
-    abstract resize(cols: number, rows: number): void;
-    /**
-     * Return Terminal search box widget.
-     */
-    abstract getSearchBox(): TerminalSearchWidget;
-    /**
-     * Whether the terminal process has child processes.
-     */
-    abstract hasChildProcesses(): Promise<boolean>;
-    abstract setTitle(title: string): void;
-    abstract waitOnExit(waitOnExit?: boolean | string): void;
-}
-/**
- * Terminal widget options.
- */
-export declare const TerminalWidgetOptions: unique symbol;
-export interface TerminalWidgetOptions {
-    /**
-     * Human readable terminal representation on the UI.
-     */
-    readonly title?: string;
-    /**
-     * icon class
-     */
-    readonly iconClass?: string;
-    /**
-     * Path to the executable shell. For example: `/bin/bash`, `bash`, `sh`.
-     */
-    readonly shellPath?: string;
-    /**
-     * Args for the custom shell executable. A string can be used on Windows only which allows
-     * specifying shell args in [command-line format](https://msdn.microsoft.com/en-au/08dfcab2-eb6e-49a4-80eb-87d4076c98c6).
-     */
-    readonly shellArgs?: string[] | string;
-    /**
-     * Current working directory.
-     */
-    readonly cwd?: string | URI;
-    /**
-     * Environment variables for terminal.
-     */
-    readonly env?: {
-        [key: string]: string | null;
-    };
-    /**
-     * Whether the terminal process environment should be exactly as provided in `env`.
-     */
-    readonly strictEnv?: boolean;
-    /**
-     * In case `destroyTermOnClose` is true - terminal process will be destroyed on close terminal widget, otherwise will be kept
-     * alive.
-     */
-    readonly destroyTermOnClose?: boolean;
-    /**
-     * Terminal server side can send to the client `terminal title` to display this value on the UI. If
-     * useServerTitle = true then display this title, otherwise display title defined by 'title' argument.
-     */
-    readonly useServerTitle?: boolean;
-    /**
-     * Whether it is a pseudo terminal where an extension controls its input and output.
-     */
-    readonly isPseudoTerminal?: boolean;
-    /**
-     * Terminal id. Should be unique for all DOM.
-     */
-    readonly id?: string;
-    /**
-     * Terminal attributes. Can be useful to apply some implementation specific information.
-     */
-    readonly attributes?: {
-        [key: string]: string | null;
-    };
-    /**
-     * Terminal kind that indicates whether a terminal is created by a user or by some extension for a user
-     */
-    readonly kind?: 'user' | string;
-    /**
-     * When enabled the terminal will run the process as normal but not be surfaced to the user until `Terminal.show` is called.
-     */
-    readonly hideFromUser?: boolean;
-    readonly location?: TerminalLocationOptions;
-    /**
-     * When enabled, the terminal will not be persisted across window reloads.
-     */
-    readonly isTransient?: boolean;
-}
+import { Event, ViewColumn } from '@theia/core';
+import { BaseWidget } from '@theia/core/lib/browser';
+import { CommandLineOptions } from '@theia/process/lib/common/shell-command-builder';
+import { TerminalSearchWidget } from '../search/terminal-search-widget';
+import { TerminalProcessInfo, TerminalExitReason } from '../../common/base-terminal-protocol';
+import URI from '@theia/core/lib/common/uri';
+import { MarkdownString } from '@theia/core/lib/common/markdown-rendering/markdown-string';
+export interface TerminalDimensions {
+    cols: number;
+    rows: number;
+}
+export interface TerminalExitStatus {
+    readonly code: number | undefined;
+    readonly reason: TerminalExitReason;
+}
+export declare type TerminalLocationOptions = TerminalLocation | TerminalEditorLocation | TerminalSplitLocation;
+export declare enum TerminalLocation {
+    Panel = 1,
+    Editor = 2
+}
+export interface TerminalEditorLocation {
+    readonly viewColumn: ViewColumn;
+    readonly preserveFocus?: boolean;
+}
+export interface TerminalSplitLocation {
+    readonly parentTerminal: string;
+}
+/**
+ * Terminal UI widget.
+ */
+export declare abstract class TerminalWidget extends BaseWidget {
+    abstract processId: Promise<number>;
+    /**
+     * Get the current executable and arguments.
+     */
+    abstract processInfo: Promise<TerminalProcessInfo>;
+    /** The ids of extensions contributing to the environment of this terminal mapped to the provided description for their changes. */
+    abstract envVarCollectionDescriptionsByExtension: Promise<Map<string, (string | MarkdownString | undefined)[]>>;
+    /** Terminal kind that indicates whether a terminal is created by a user or by some extension for a user */
+    abstract readonly kind: 'user' | string;
+    abstract readonly terminalId: number;
+    abstract readonly dimensions: TerminalDimensions;
+    abstract readonly exitStatus: TerminalExitStatus | undefined;
+    /** Terminal widget can be hidden from users until explicitly shown once. */
+    abstract readonly hiddenFromUser: boolean;
+    /** The position of the terminal widget. */
+    abstract readonly location: TerminalLocationOptions;
+    /** The last CWD assigned to the terminal, useful when attempting getCwdURI on a task terminal fails */
+    lastCwd: URI;
+    /**
+     * Start terminal and return terminal id.
+     * @param id - terminal id.
+     */
+    abstract start(id?: number): Promise<number>;
+    /**
+     * Send text to the terminal server.
+     * @param text - text content.
+     */
+    abstract sendText(text: string): void;
+    /**
+     * Resolves when the command is successfully sent, this doesn't mean that it
+     * was evaluated. Might reject if terminal wasn't properly started yet.
+     *
+     * Note that this method will try to escape your arguments as if it was
+     * someone inputting everything in a shell.
+     *
+     * Supported shells: `bash`, `cmd.exe`, `wsl.exe`, `pwsh/powershell.exe`
+     */
+    abstract executeCommand(commandOptions: CommandLineOptions): Promise<void>;
+    /** Event that fires when the terminal is connected or reconnected */
+    abstract onDidOpen: Event<void>;
+    /** Event that fires when the terminal fails to connect or reconnect */
+    abstract onDidOpenFailure: Event<void>;
+    /** Event that fires when the terminal size changed */
+    abstract onSizeChanged: Event<{
+        cols: number;
+        rows: number;
+    }>;
+    /** Event that fires when the terminal receives a key event. */
+    abstract onKey: Event<{
+        key: string;
+        domEvent: KeyboardEvent;
+    }>;
+    /** Event that fires when the terminal input data */
+    abstract onData: Event<string>;
+    abstract scrollLineUp(): void;
+    abstract scrollLineDown(): void;
+    abstract scrollToTop(): void;
+    abstract scrollToBottom(): void;
+    abstract scrollPageUp(): void;
+    abstract scrollPageDown(): void;
+    abstract resetTerminal(): void;
+    /**
+     * Event which fires when terminal did closed. Event value contains closed terminal widget definition.
+     */
+    abstract onTerminalDidClose: Event<TerminalWidget>;
+    /**
+     * Cleat terminal output.
+     */
+    abstract clearOutput(): void;
+    /**
+     * Select entire content in the terminal.
+     */
+    abstract selectAll(): void;
+    abstract writeLine(line: string): void;
+    abstract write(data: string): void;
+    abstract resize(cols: number, rows: number): void;
+    /**
+     * Return Terminal search box widget.
+     */
+    abstract getSearchBox(): TerminalSearchWidget;
+    /**
+     * Whether the terminal process has child processes.
+     */
+    abstract hasChildProcesses(): Promise<boolean>;
+    abstract setTitle(title: string): void;
+    abstract waitOnExit(waitOnExit?: boolean | string): void;
+}
+/**
+ * Terminal widget options.
+ */
+export declare const TerminalWidgetOptions: unique symbol;
+export interface TerminalWidgetOptions {
+    /**
+     * Human readable terminal representation on the UI.
+     */
+    readonly title?: string;
+    /**
+     * icon class
+     */
+    readonly iconClass?: string;
+    /**
+     * Path to the executable shell. For example: `/bin/bash`, `bash`, `sh`.
+     */
+    readonly shellPath?: string;
+    /**
+     * Args for the custom shell executable. A string can be used on Windows only which allows
+     * specifying shell args in [command-line format](https://msdn.microsoft.com/en-au/08dfcab2-eb6e-49a4-80eb-87d4076c98c6).
+     */
+    readonly shellArgs?: string[] | string;
+    /**
+     * Current working directory.
+     */
+    readonly cwd?: string | URI;
+    /**
+     * Environment variables for terminal.
+     */
+    readonly env?: {
+        [key: string]: string | null;
+    };
+    /**
+     * Whether the terminal process environment should be exactly as provided in `env`.
+     */
+    readonly strictEnv?: boolean;
+    /**
+     * In case `destroyTermOnClose` is true - terminal process will be destroyed on close terminal widget, otherwise will be kept
+     * alive.
+     */
+    readonly destroyTermOnClose?: boolean;
+    /**
+     * Terminal server side can send to the client `terminal title` to display this value on the UI. If
+     * useServerTitle = true then display this title, otherwise display title defined by 'title' argument.
+     */
+    readonly useServerTitle?: boolean;
+    /**
+     * Whether it is a pseudo terminal where an extension controls its input and output.
+     */
+    readonly isPseudoTerminal?: boolean;
+    /**
+     * Terminal id. Should be unique for all DOM.
+     */
+    readonly id?: string;
+    /**
+     * Terminal attributes. Can be useful to apply some implementation specific information.
+     */
+    readonly attributes?: {
+        [key: string]: string | null;
+    };
+    /**
+     * Terminal kind that indicates whether a terminal is created by a user or by some extension for a user
+     */
+    readonly kind?: 'user' | string;
+    /**
+     * When enabled the terminal will run the process as normal but not be surfaced to the user until `Terminal.show` is called.
+     */
+    readonly hideFromUser?: boolean;
+    readonly location?: TerminalLocationOptions;
+    /**
+     * When enabled, the terminal will not be persisted across window reloads.
+     */
+    readonly isTransient?: boolean;
+}
 //# sourceMappingURL=terminal-widget.d.ts.map

package/lib/browser/base/terminal-widget.js

@@ -1,35 +1,35 @@
-"use strict";
-// *****************************************************************************
-// Copyright (C) 2018 Red Hat, Inc. 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
-// *****************************************************************************
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TerminalWidgetOptions = exports.TerminalWidget = exports.TerminalLocation = void 0;
-const browser_1 = require("@theia/core/lib/browser");
-var TerminalLocation;
-(function (TerminalLocation) {
-    TerminalLocation[TerminalLocation["Panel"] = 1] = "Panel";
-    TerminalLocation[TerminalLocation["Editor"] = 2] = "Editor";
-})(TerminalLocation = exports.TerminalLocation || (exports.TerminalLocation = {}));
-/**
- * Terminal UI widget.
- */
-class TerminalWidget extends browser_1.BaseWidget {
-}
-exports.TerminalWidget = TerminalWidget;
-/**
- * Terminal widget options.
- */
-exports.TerminalWidgetOptions = Symbol('TerminalWidgetOptions');
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2018 Red Hat, Inc. 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
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TerminalWidgetOptions = exports.TerminalWidget = exports.TerminalLocation = void 0;
+const browser_1 = require("@theia/core/lib/browser");
+var TerminalLocation;
+(function (TerminalLocation) {
+    TerminalLocation[TerminalLocation["Panel"] = 1] = "Panel";
+    TerminalLocation[TerminalLocation["Editor"] = 2] = "Editor";
+})(TerminalLocation = exports.TerminalLocation || (exports.TerminalLocation = {}));
+/**
+ * Terminal UI widget.
+ */
+class TerminalWidget extends browser_1.BaseWidget {
+}
+exports.TerminalWidget = TerminalWidget;
+/**
+ * Terminal widget options.
+ */
+exports.TerminalWidgetOptions = Symbol('TerminalWidgetOptions');
 //# sourceMappingURL=terminal-widget.js.map

package/lib/browser/index.d.ts

@@ -1,2 +1,2 @@
-export * from './terminal-frontend-module';
+export * from './terminal-frontend-module';
 //# sourceMappingURL=index.d.ts.map