@theia/plugin 1.27.0-next.5 → 1.27.0-next.53

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.27.0-next.5+5f0fd29e8e7",
+  "version": "1.27.0-next.53+0e05d0ad8b9",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -32,5 +32,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "5f0fd29e8e75eea565741a06550db79f03188c98"
+  "gitHead": "0e05d0ad8b91e3abd1d4d153f6c5215f181afbf9"
 }

package/src/theia-proposed.d.ts

@@ -321,41 +321,6 @@ export module '@theia/plugin' {
 
     // #endregion
 
-    // #region Tree View
-    // copied from https://github.com/microsoft/vscode/blob/3ea5c9ddbebd8ec68e3b821f9c39c3ec785fde97/src/vs/vscode.proposed.d.ts#L1447-L1476
-    /**
-     * Label describing the [Tree item](#TreeItem)
-     */
-    export interface TreeItemLabel {
-
-        /**
-         * A human-readable string describing the [Tree item](#TreeItem).
-         */
-        label: string;
-
-        /**
-         * Ranges in the label to highlight. A range is defined as a tuple of two number where the
-         * first is the inclusive start index and the second the exclusive end index
-         */
-        // TODO highlights?: [number, number][];
-
-    }
-
-    export class TreeItem2 extends TreeItem {
-        /**
-         * Label describing this item. When `falsy`, it is derived from [resourceUri](#TreeItem.resourceUri).
-         */
-        label?: string | TreeItemLabel | /* for compilation */ any;
-
-        /**
-         * @param label Label describing this item
-         * @param collapsibleState [TreeItemCollapsibleState](#TreeItemCollapsibleState) of the tree item.
-         * Default is [TreeItemCollapsibleState.None](#TreeItemCollapsibleState.None)
-         */
-        constructor(label: TreeItemLabel, collapsibleState?: TreeItemCollapsibleState);
-    }
-    // #endregion
-
     // #region search in workspace
     /**
      * The parameters of a query for text search.

package/src/theia.d.ts

@@ -1215,6 +1215,22 @@ export module '@theia/plugin' {
          * @param revealType The scrolling strategy for revealing `range`.
          */
         revealRange(range: Range, revealType?: TextEditorRevealType): void;
+
+        /**
+         * Shows this text editor. A [column](#ViewColumn) can be provided to control where the editor is being shown. Might change the [active editor](#window.activeTextEditor).
+         *
+         * @deprecated use [window.showTextDocument](#Window.showTextDocument) instead.
+         *
+         * @param column A [view column](#ViewColumn) in which this editor should be shown.
+         */
+        show(column?: ViewColumn): void;
+
+        /**
+         * Hides this text editor.
+         *
+         * @deprecated use 'workbench.action.closeActiveEditor' command instead.
+         */
+        hide(): void;
     }
 
     /**
@@ -2652,7 +2668,22 @@ export module '@theia/plugin' {
          */
         static readonly Folder: ThemeIcon;
 
-        private constructor(public id: string);
+        /**
+         * The id of the icon. The available icons are listed in https://code.visualstudio.com/api/references/icons-in-labels#icon-listing.
+         */
+        readonly id: string;
+
+        /**
+         * The optional ThemeColor of the icon. The color is currently only used in {@link TreeItem}.
+         */
+        readonly color?: ThemeColor | undefined;
+
+        /**
+         * Creates a reference to a theme icon.
+         * @param id id of the icon. The available icons are listed in https://code.visualstudio.com/api/references/icons-in-labels#icon-listing.
+         * @param color optional `ThemeColor` for the icon. The color is currently only used in {@link TreeItem}.
+         */
+        private constructor(public id: string, public color?: ThemeColor);
     }
 
     /**
@@ -4268,6 +4299,44 @@ export module '@theia/plugin' {
         resolveWebviewView(webviewView: WebviewView, context: WebviewViewResolveContext, token: CancellationToken): Thenable<void> | void;
     }
 
+    /**
+     * Additional information the webview view being resolved.
+     *
+     * @param T Type of the webview's state.
+     */
+    interface WebviewViewResolveContext<T = unknown> {
+        /**
+         * Persisted state from the webview content.
+         *
+         * To save resources, VS Code normally deallocates webview documents (the iframe content) that are not visible.
+         * For example, when the user collapse a view or switches to another top level activity in the sidebar, the
+         * `WebviewView` itself is kept alive but the webview's underlying document is deallocated. It is recreated when
+         * the view becomes visible again.
+         *
+         * You can prevent this behavior by setting `retainContextWhenHidden` in the `WebviewOptions`. However this
+         * increases resource usage and should be avoided wherever possible. Instead, you can use persisted state to
+         * save off a webview's state so that it can be quickly recreated as needed.
+         *
+         * To save off a persisted state, inside the webview call `acquireVsCodeApi().setState()` with
+         * any json serializable object. To restore the state again, call `getState()`. For example:
+         *
+         * ```js
+         * // Within the webview
+         * const vscode = acquireVsCodeApi();
+         *
+         * // Get existing state
+         * const oldState = vscode.getState() || { value: 0 };
+         *
+         * // Update state
+         * setState({ value: oldState.value + 1 })
+         * ```
+         *
+         * VS Code ensures that the persisted state is saved correctly when a webview is hidden and across
+         * editor restarts.
+         */
+        readonly state: T | undefined;
+    }
+
     /**
      * Common namespace for dealing with window and editor, showing messages and user input.
      */
@@ -4609,44 +4678,6 @@ export module '@theia/plugin' {
          * @param serializer Webview serializer.
          */
 
-        /**
-         * Additional information the webview view being resolved.
-         *
-         * @param T Type of the webview's state.
-         */
-        interface WebviewViewResolveContext<T = unknown> {
-            /**
-             * Persisted state from the webview content.
-             *
-             * To save resources, VS Code normally deallocates webview documents (the iframe content) that are not visible.
-             * For example, when the user collapse a view or switches to another top level activity in the sidebar, the
-             * `WebviewView` itself is kept alive but the webview's underlying document is deallocated. It is recreated when
-             * the view becomes visible again.
-             *
-             * You can prevent this behavior by setting `retainContextWhenHidden` in the `WebviewOptions`. However this
-             * increases resource usage and should be avoided wherever possible. Instead, you can use persisted state to
-             * save off a webview's state so that it can be quickly recreated as needed.
-             *
-             * To save off a persisted state, inside the webview call `acquireVsCodeApi().setState()` with
-             * any json serializable object. To restore the state again, call `getState()`. For example:
-             *
-             * ```js
-             * // Within the webview
-             * const vscode = acquireVsCodeApi();
-             *
-             * // Get existing state
-             * const oldState = vscode.getState() || { value: 0 };
-             *
-             * // Update state
-             * setState({ value: oldState.value + 1 })
-             * ```
-             *
-             * VS Code ensures that the persisted state is saved correctly when a webview is hidden and across
-             * editor restarts.
-             */
-            readonly state: T | undefined;
-        }
-
         export function registerWebviewViewProvider(viewId: string, provider: WebviewViewProvider, options?: {
             /**
              * Content settings for the webview created for this view.
@@ -5334,7 +5365,7 @@ export module '@theia/plugin' {
         /**
          * A human-readable string describing this item. When `falsy`, it is derived from [resourceUri](#TreeItem.resourceUri).
          */
-        label?: string;
+        label?: string | TreeItemLabel;
 
         /**
          * Optional id for the tree item that has to be unique across tree. The id is used to preserve the selection and expansion state of the tree item.
@@ -5410,7 +5441,7 @@ export module '@theia/plugin' {
          * @param label A human-readable string describing this item
          * @param collapsibleState [TreeItemCollapsibleState](#TreeItemCollapsibleState) of the tree item. Default is [TreeItemCollapsibleState.None](#TreeItemCollapsibleState.None)
          */
-        constructor(label: string, collapsibleState?: TreeItemCollapsibleState);
+        constructor(label: string | TreeItemLabel, collapsibleState?: TreeItemCollapsibleState);
 
         /**
          * @param resourceUri The [uri](#Uri) of the resource representing this item.
@@ -5437,6 +5468,23 @@ export module '@theia/plugin' {
         Expanded = 2
     }
 
+    /**
+     * Label describing the {@link TreeItem Tree item}
+     */
+    export interface TreeItemLabel {
+
+        /**
+         * A human-readable string describing the {@link TreeItem Tree item}.
+         */
+        label: string;
+
+        /**
+         * Ranges in the label to highlight. A range is defined as a tuple of two numbers where the
+         * first is the inclusive start index and the second the exclusive end index
+         */
+        highlights?: [number, number][];
+    }
+
     /**
      * Represents the configuration. It is a merged view of
      *
@@ -6535,7 +6583,7 @@ export module '@theia/plugin' {
          * the port forwarding tunnel is managed by VS Code and the tunnel can be closed by the user.
          *
          * Extensions should not cache the result of `asExternalUri` as the resolved uri may become invalid due to
-         * a system or user action — for example, in remote cases, a user may close a port forwarding tunnel
+         * a system or user action — for example, in remote cases, a user may close a port forwarding tunnel
          * that was opened by `asExternalUri`.
          *
          * *Note* that uris passed through `openExternal` are automatically resolved and you should not call `asExternalUri`
@@ -6709,6 +6757,10 @@ export module '@theia/plugin' {
          * This rule will only execute if the text after the cursor matches this regular expression.
          */
         afterText?: RegExp;
+        /**
+         * This rule will only execute if the text above the current line matches this regular expression.
+         */
+        previousLineText?: RegExp;
         /**
          * The action to execute.
          */
@@ -10715,6 +10767,9 @@ export module '@theia/plugin' {
 
         /** Controls whether to show the "Terminal will be reused by tasks, press any key to close it" message. */
         showReuseMessage?: boolean;
+
+        /** Controls whether the terminal is cleared before executing the task. */
+        clear?: boolean;
     }
 
     export class Task {