@theia/plugin 1.30.0-next.2 → 1.30.0-next.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.30.0-next.2+af83aaa66b5",
+  "version": "1.30.0-next.20+a982f0894",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -32,5 +32,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "af83aaa66b51e9da92f43d828837e020216bf085"
+  "gitHead": "a982f08942c0beb85209fa9463ee41e2b80216e3"
 }

package/src/theia.d.ts

@@ -315,7 +315,7 @@ export module '@theia/plugin' {
          * @return A position that reflects the given delta. Will return `this` position if the change
          * is not changing anything.
          */
-        translate(change: { lineDelta?: number; characterDelta?: number; }): Position;
+        translate(change: { lineDelta?: number; characterDelta?: number }): Position;
 
         /**
          * Create a new position derived from this position.
@@ -333,7 +333,7 @@ export module '@theia/plugin' {
          * @return A position that reflects the given change. Will return `this` position if the change
          * is not changing anything.
          */
-        with(change: { line?: number; character?: number; }): Position;
+        with(change: { line?: number; character?: number }): Position;
     }
 
     /**
@@ -2074,7 +2074,7 @@ export module '@theia/plugin' {
          * Fire the event and pass data object
          * @param data
          */
-        fire(data?: T): void;
+        fire(data: T): void;
 
         /**
          * Dispose this object
@@ -2782,6 +2782,16 @@ export module '@theia/plugin' {
          */
         clear(): void;
 
+        /**
+         * Reveal this channel in the UI.
+         *
+         * @deprecated Use the overload with just one parameter (`show(preserveFocus?: boolean): void`).
+         *
+         * @param column This argument is **deprecated** and will be ignored.
+         * @param preserveFocus When `true` the channel will not take focus.
+         */
+        show(column?: ViewColumn, preserveFocus?: boolean): void;
+
         /**
          * Reveal this channel in the UI.
          *
@@ -2928,6 +2938,12 @@ export module '@theia/plugin' {
          */
         readonly exitStatus: TerminalExitStatus | undefined;
 
+        /**
+         * The object used to initialize the terminal, this is useful for example to detecting the shell type of when the terminal was not launched by this extension or for
+         * detecting what folder the shell was launched in.
+         */
+        readonly creationOptions: Readonly<TerminalOptions | ExtensionTerminalOptions>
+
         /**
          * Send text to the terminal.
          * @param text - text content.
@@ -2981,6 +2997,15 @@ export module '@theia/plugin' {
          */
         env?: { [key: string]: string | null };
 
+        /**
+         * Whether the terminal process environment should be exactly as provided in
+         * `TerminalOptions.env`. When this is false (default), the environment will be based on the
+         * window's environment and also apply configured platform settings like
+         * `terminal.integrated.windows.env` on top. When this is true, the complete environment
+         * must be provided as nothing will be inherited from the process or any configuration.
+         */
+        strictEnv?: boolean;
+
         /**
          * A message to write to the terminal on first launch. Note that this is not sent to the
          * process, but rather written directly to the terminal. This supports escape sequences such
@@ -3075,6 +3100,26 @@ export module '@theia/plugin' {
          */
         onDidClose?: Event<void | number>;
 
+        /**
+         * An event that when fired allows changing the name of the terminal.
+         *
+         * Events fired before {@link Pseudoterminal.open} is called will be be ignored.
+         *
+         * **Example:** Change the terminal name to "My new terminal".
+         * ```typescript
+         * const writeEmitter = new vscode.EventEmitter<string>();
+         * const changeNameEmitter = new vscode.EventEmitter<string>();
+         * const pty: vscode.Pseudoterminal = {
+         *   onDidWrite: writeEmitter.event,
+         *   onDidChangeName: changeNameEmitter.event,
+         *   open: () => changeNameEmitter.fire('My new terminal'),
+         *   close: () => {}
+         * };
+         * vscode.window.createTerminal({ name: 'My terminal', pty });
+         * ```
+         */
+        onDidChangeName?: Event<string>;
+
         /**
          * Implement to handle when the pty is opened.
          *
@@ -5463,7 +5508,7 @@ export module '@theia/plugin' {
         /**
          * The tooltip text when you hover over this item.
          */
-        tooltip?: string | undefined;
+        tooltip?: string | MarkdownString | undefined;
 
         /**
          * The {@link Command command} which should be run when the tree item is selected.
@@ -8932,7 +8977,7 @@ export module '@theia/plugin' {
          * @param tokenType The token type.
          * @param tokenModifiers The token modifiers.
          */
-        push(range: Range, tokenType: string, tokenModifiers?: string[]): void;
+        push(range: Range, tokenType: string, tokenModifiers?: readonly string[]): void;
 
         /**
          * Finish and create a `SemanticTokens` instance.