@theia/plugin 1.25.0-next.1 → 1.25.0-next.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.25.0-next.1+bd604c313d2",
+  "version": "1.25.0-next.4+1c7bdf70025",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -32,5 +32,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "bd604c313d2f2c15bb7f5cf1b21222fbe0a46f6d"
+  "gitHead": "1c7bdf70025c684e7ca22c482e206cceb405ddbd"
 }

package/src/theia.d.ts

@@ -496,6 +496,17 @@ export module '@theia/plugin' {
          */
         appendPlaceholder(value: string | ((snippet: SnippetString) => any), number?: number): SnippetString;
 
+        /**
+         * Builder-function that appends a choice (`${1|a,b,c|}`) to
+         * the {@linkcode SnippetString.value value} of this snippet string.
+         *
+         * @param values The values for choices - the array of strings
+         * @param number The number of this tabstop, defaults to an auto-increment
+         * value starting at 1.
+         * @return This snippet string.
+         */
+        appendChoice(values: string[], number?: number): SnippetString;
+
         /**
          * Builder-function that appends a variable (`${VAR}`) to
          * the [`value`](#SnippetString.value) of this snippet string.
@@ -4211,36 +4222,43 @@ export module '@theia/plugin' {
 
         /**
          * Shows a selection list.
-         * @param items
-         * @param options
-         * @param token
+         *
+         * @param items An array of strings, or a promise that resolves to an array of strings.
+         * @param options Configures the behavior of the selection list.
+         * @param token A token that can be used to signal cancellation.
+         * @return A promise that resolves to the selection or `undefined`.
          */
-        export function showQuickPick(items: string[] | PromiseLike<string[]>, options: QuickPickOptions, token?: CancellationToken): PromiseLike<string | undefined>;
+        export function showQuickPick(readonly items: string[] | PromiseLike<readonly string[]>, options: QuickPickOptions, token?: CancellationToken): PromiseLike<string | undefined>;
 
         /**
-         * Shows a selection list with multiple selection allowed.
+         * Shows a selection list allowing multiple selections.
+         *
+         * @param items An array of strings, or a promise that resolves to an array of strings.
+         * @param options Configures the behavior of the selection list.
+         * @param token A token that can be used to signal cancellation.
+         * @return A promise that resolves to the selected items or `undefined`.
          */
-        export function showQuickPick(
-            items: string[] | PromiseLike<string[]>,
-            options: QuickPickOptions & { canPickMany: true },
-            token?: CancellationToken
-        ): PromiseLike<string[] | undefined>;
+        export function showQuickPick(readonly items: string[] | PromiseLike<readonly string[]>, options: QuickPickOptions & { canPickMany: true }, token?: CancellationToken): PromiseLike<string[] | undefined>;
 
         /**
          * Shows a selection list.
-         * @param items
-         * @param options
-         * @param token
+         *
+         * @param items An array of items, or a promise that resolves to an array of items.
+         * @param options Configures the behavior of the selection list.
+         * @param token A token that can be used to signal cancellation.
+         * @return A promise that resolves to the selected item or `undefined`.
          */
-        export function showQuickPick<T extends QuickPickItem>(items: T[] | PromiseLike<T[]>, options: QuickPickOptions, token?: CancellationToken): PromiseLike<T | undefined>;
+        export function showQuickPick<T extends QuickPickItem>(items: readonly T[] | PromiseLike<readonly T[]>, options: QuickPickOptions, token?: CancellationToken): PromiseLike<T | undefined>;
 
         /**
-         * Shows a selection list with multiple selection allowed.
+         * Shows a selection list allowing multiple selections.
+         *
+         * @param items An array of items, or a promise that resolves to an array of items.
+         * @param options Configures the behavior of the selection list.
+         * @param token A token that can be used to signal cancellation.
+         * @return A promise that resolves to the selected items or `undefined`.
          */
-        export function showQuickPick<T extends QuickPickItem>(items: T[] | PromiseLike<T[]>,
-            options: QuickPickOptions & { canPickMany: true },
-            token?: CancellationToken
-        ): PromiseLike<T[] | undefined>;
+        export function showQuickPick<T extends QuickPickItem>(items: readonly T[] | PromiseLike<readonly T[]>, options: QuickPickOptions & { canPickMany: true }, token?: CancellationToken): PromiseLike<T[] | undefined>;
 
         /**
          * Creates a [QuickPick](#QuickPick) to let the user pick an item from a list
@@ -7902,7 +7920,7 @@ export module '@theia/plugin' {
      *
      * A code action can be any command that is [known](#commands.getCommands) to the system.
      */
-    export interface CodeActionProvider {
+    export interface CodeActionProvider<T extends CodeAction = CodeAction> {
         /**
          * Provide commands for the given document and range.
          *
@@ -7914,12 +7932,7 @@ export module '@theia/plugin' {
          * @return An array of commands, quick fixes, or refactorings or a thenable of such. The lack of a result can be
          * signaled by returning `undefined`, `null`, or an empty array.
          */
-        provideCodeActions(
-            document: TextDocument,
-            range: Range | Selection,
-            context: CodeActionContext,
-            token: CancellationToken | undefined
-        ): ProviderResult<(Command | CodeAction)[]>;
+        provideCodeActions(document: TextDocument, range: Range | Selection, context: CodeActionContext, token: CancellationToken | undefined): ProviderResult<(Command | T)[]>;
 
         /**
          * Given a code action fill in its `edit`-property. Changes to
@@ -7935,7 +7948,7 @@ export module '@theia/plugin' {
          * @return The resolved code action or a thenable that resolves to such. It is OK to return the given
          * `item`. When no result is returned, the given `item` will be used.
          */
-        resolveCodeAction?(codeAction: CodeAction, token: CancellationToken | undefined): ProviderResult<CodeAction>;
+        resolveCodeAction?(codeAction: T, token: CancellationToken | undefined): ProviderResult<T>;
     }
 
     /**