@theia/plugin 1.26.0-next.4 → 1.26.0-next.41

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.26.0-next.4+eb0930a267c",
+  "version": "1.26.0-next.41+f94732ef523",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -32,5 +32,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "eb0930a267cda577b31532474a404e45b5ae350b"
+  "gitHead": "f94732ef5237233e30d3f07ce47c698ca59449f9"
 }

package/src/theia.d.ts

@@ -530,6 +530,14 @@ export module '@theia/plugin' {
         Command = 3
     }
 
+    export enum TextDocumentChangeReason {
+        /** The text change is caused by an undo operation. */
+        Undo = 1,
+
+        /** The text change is caused by a redo operation. */
+        Redo = 2,
+    }
+
     /**
      * Represents an event describing the change in text editor selections.
      */
@@ -734,12 +742,51 @@ export module '@theia/plugin' {
          */
         isTrusted?: boolean;
 
+        /**
+         * Indicates that this markdown string can contain {@link ThemeIcon ThemeIcons}, e.g. `$(zap)`.
+         */
+        supportThemeIcons?: boolean;
+
+        /**
+         * Indicates that this markdown string can contain raw html tags. Defaults to `false`.
+         *
+         * When `supportHtml` is false, the markdown renderer will strip out any raw html tags
+         * that appear in the markdown text. This means you can only use markdown syntax for rendering.
+         *
+         * When `supportHtml` is true, the markdown render will also allow a safe subset of html tags
+         * and attributes to be rendered. See https://github.com/microsoft/vscode/blob/6d2920473c6f13759c978dd89104c4270a83422d/src/vs/base/browser/markdownRenderer.ts#L296
+         * for a list of all supported tags and attributes.
+         */
+        supportHtml?: boolean;
+
+        /**
+         * Uri that relative paths are resolved relative to.
+         *
+         * If the `baseUri` ends with `/`, it is considered a directory and relative paths in the markdown are resolved relative to that directory:
+         *
+         * ```ts
+         * const md = new vscode.MarkdownString(`[link](./file.js)`);
+         * md.baseUri = vscode.Uri.file('/path/to/dir/');
+         * // Here 'link' in the rendered markdown resolves to '/path/to/dir/file.js'
+         * ```
+         *
+         * If the `baseUri` is a file, relative paths in the markdown are resolved relative to the parent dir of that file:
+         *
+         * ```ts
+         * const md = new vscode.MarkdownString(`[link](./file.js)`);
+         * md.baseUri = vscode.Uri.file('/path/to/otherFile.js');
+         * // Here 'link' in the rendered markdown resolves to '/path/to/file.js'
+         * ```
+         */
+        baseUri?: Uri;
+
         /**
          * Creates a new markdown string with the given value.
          *
          * @param value Optional, initial value.
+         * @param supportThemeIcons Optional, Specifies whether {@link ThemeIcon ThemeIcons} are supported within the {@linkcode MarkdownString}.
          */
-        constructor(value?: string);
+        constructor(value?: string, supportThemeIcons?: boolean);
 
         /**
          * Appends and escapes the given string to this markdown string.
@@ -1788,10 +1835,26 @@ export module '@theia/plugin' {
         readonly files: ReadonlyArray<{ oldUri: Uri, newUri: Uri }>;
     }
 
+    /**
+     * An event describing a transactional {@link TextDocument document} change.
+     */
     export interface TextDocumentChangeEvent {
-        document: TextDocument;
 
-        contentChanges: TextDocumentContentChangeEvent[];
+        /**
+         * The affected document.
+         */
+        readonly document: TextDocument;
+
+        /**
+         * An array of content changes.
+         */
+        readonly contentChanges: readonly TextDocumentContentChangeEvent[];
+
+        /**
+         * The reason why the document was changed.
+         * Is `undefined` if the reason is not known.
+         */
+        readonly reason: TextDocumentChangeReason | undefined;
     }
 
     export interface TextDocumentContentChangeEvent {
@@ -2122,7 +2185,7 @@ export module '@theia/plugin' {
     }
 
     /**
-     * The type of a {@link QuickPickItem quitk pick item}. If `Separator` is set, all fields other than {@link QuickPickItem.label label} will be ignored.
+     * The type of a {@link QuickPickItem quick pick item}. If `Separator` is set, all fields other than {@link QuickPickItem.label label} will be ignored.
      */
     export enum QuickPickItemKind {
         Separator = -1,
@@ -2516,7 +2579,7 @@ export module '@theia/plugin' {
         /**
          * The tooltip text when you hover over this entry.
          */
-        tooltip: string | undefined;
+        tooltip: string | MarkdownString | undefined;
 
         /**
          * The foreground color for this entry.
@@ -2770,6 +2833,21 @@ export module '@theia/plugin' {
          */
         readonly processId: PromiseLike<number>;
 
+        /**
+         * The exit status of the terminal, this will be undefined while the terminal is active.
+         *
+         * **Example:** Show a notification with the exit code when the terminal exits with a
+         * non-zero exit code.
+         * ```typescript
+         * window.onDidCloseTerminal(t => {
+         *   if (t.exitStatus && t.exitStatus.code) {
+         *     vscode.window.showInformationMessage(`Exit code: ${t.exitStatus.code}`);
+         *   }
+         * });
+         * ```
+         */
+        readonly exitStatus: TerminalExitStatus | undefined;
+
         /**
          * Send text to the terminal.
          * @param text - text content.
@@ -2844,6 +2922,20 @@ export module '@theia/plugin' {
         readonly rows: number;
     }
 
+    /**
+     * Represents how a terminal exited.
+     */
+    export interface TerminalExitStatus {
+        /**
+         * The exit code that a terminal exited with, it can have the following values:
+         * - Zero: the terminal process or custom execution succeeded.
+         * - Non-zero: the terminal process or custom execution failed.
+         * - `undefined`: the user forcibly closed the terminal or a custom execution exited
+         *   without providing an exit code.
+         */
+        readonly code: number | undefined;
+    }
+
     /**
      * Options a virtual process terminal.
      * @deprecated since 1.23.0 - Use [ExtensionTerminalOptions](#ExtensionTerminalOptions) instead.
@@ -7919,6 +8011,82 @@ export module '@theia/plugin' {
         dispose(): void;
     }
 
+    /**
+     * Represents the severity of a language status item.
+     */
+    export enum LanguageStatusSeverity {
+        Information = 0,
+        Warning = 1,
+        Error = 2
+    }
+
+    /**
+     * A language status item is the preferred way to present language status reports for the active text editors,
+     * such as selected linter or notifying about a configuration problem.
+     */
+    export interface LanguageStatusItem {
+
+        /**
+         * The identifier of this item.
+         */
+        readonly id: string;
+
+        /**
+         * The short name of this item, like 'Java Language Status', etc.
+         */
+        name: string | undefined;
+
+        /**
+         * A {@link DocumentSelector selector} that defines for what editors
+         * this item shows.
+         */
+        selector: DocumentSelector;
+
+        /**
+         * The severity of this item.
+         *
+         * Defaults to {@link LanguageStatusSeverity.Information information}. You can use this property to
+         * signal to users that there is a problem that needs attention, like a missing executable or an
+         * invalid configuration.
+         */
+        severity: LanguageStatusSeverity;
+
+        /**
+         * The text to show for the entry. You can embed icons in the text by leveraging the syntax:
+         *
+         * `My text $(icon-name) contains icons like $(icon-name) this one.`
+         *
+         * Where the icon-name is taken from the ThemeIcon [icon set](https://code.visualstudio.com/api/references/icons-in-labels#icon-listing), e.g.
+         * `light-bulb`, `thumbsup`, `zap` etc.
+         */
+        text: string;
+
+        /**
+         * Optional, human-readable details for this item.
+         */
+        detail?: string;
+
+        /**
+         * Controls whether the item is shown as "busy". Defaults to `false`.
+         */
+        busy: boolean;
+
+        /**
+         * A {@linkcode Command command} for this item.
+         */
+        command: Command | undefined;
+
+        /**
+         * Accessibility information used when a screen reader interacts with this item
+         */
+        accessibilityInformation?: AccessibilityInformation;
+
+        /**
+         * Dispose and free associated resources.
+         */
+        dispose(): void;
+    }
+
     /**
      * A code action represents a change that can be performed in code, e.g. to fix a problem or
      * to refactor code.
@@ -9232,6 +9400,27 @@ export module '@theia/plugin' {
          * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
          */
         export function registerCallHierarchyProvider(selector: DocumentSelector, provider: CallHierarchyProvider): Disposable;
+
+        /**
+         * Register a linked editing range provider.
+         *
+         * Multiple providers can be registered for a language. In that case providers are sorted
+         * by their {@link languages.match score} and the best-matching provider that has a result is used. Failure
+         * of the selected provider will cause a failure of the whole operation.
+         *
+         * @param selector A selector that defines the documents this provider is applicable to.
+         * @param provider A linked editing range provider.
+         * @return A {@link Disposable} that unregisters this provider when being disposed.
+         */
+        export function registerLinkedEditingRangeProvider(selector: DocumentSelector, provider: LinkedEditingRangeProvider): Disposable;
+
+        /**
+         * Creates a new {@link LanguageStatusItem language status item}.
+         *
+         * @param id The identifier of the item.
+         * @param selector The document selector that defines for what editors the item shows.
+         */
+        export function createLanguageStatusItem(id: string, selector: DocumentSelector): LanguageStatusItem;
     }
 
     /**
@@ -9648,6 +9837,11 @@ export module '@theia/plugin' {
          */
         readonly name: string;
 
+        /**
+         * The workspace folder of this session or `undefined` for a folderless setup.
+         */
+        readonly workspaceFolder: WorkspaceFolder | undefined;
+
         /**
          * The "resolved" [debug configuration](#DebugConfiguration) of this session.
          */
@@ -11334,6 +11528,50 @@ export module '@theia/plugin' {
         provideCallHierarchyOutgoingCalls(item: CallHierarchyItem, token: CancellationToken): ProviderResult<CallHierarchyOutgoingCall[]>;
     }
 
+    /**
+     * Represents a list of ranges that can be edited together along with a word pattern to describe valid range contents.
+     */
+    export class LinkedEditingRanges {
+        /**
+         * Create a new linked editing ranges object.
+         *
+         * @param ranges A list of ranges that can be edited together
+         * @param wordPattern An optional word pattern that describes valid contents for the given ranges
+         */
+        constructor(ranges: Range[], wordPattern?: RegExp);
+
+        /**
+         * A list of ranges that can be edited together. The ranges must have
+         * identical length and text content. The ranges cannot overlap.
+         */
+        readonly ranges: Range[];
+
+        /**
+         * An optional word pattern that describes valid contents for the given ranges.
+         * If no pattern is provided, the language configuration's word pattern will be used.
+         */
+        readonly wordPattern?: RegExp;
+    }
+
+    /**
+     * The linked editing range provider interface defines the contract between extensions and
+     * the linked editing feature.
+     */
+    export interface LinkedEditingRangeProvider {
+        /**
+         * For a given position in a document, returns the range of the symbol at the position and all ranges
+         * that have the same content. A change to one of the ranges can be applied to all other ranges if the new content
+         * is valid. An optional word pattern can be returned with the result to describe valid contents.
+         * If no result-specific word pattern is provided, the word pattern from the language configuration is used.
+         *
+         * @param document The document in which the provider was invoked.
+         * @param position The position at which the provider was invoked.
+         * @param token A cancellation token.
+         * @return A list of ranges that can be edited together
+         */
+        provideLinkedEditingRanges(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<LinkedEditingRanges>;
+    }
+
     /**
      * Represents a session of a currently logged in user.
      */