@theia/plugin 1.24.0-next.5 → 1.24.0-next.52

package/README.md

@@ -681,8 +681,9 @@ Example of code symbol provider registration:
 ```typescript
 const documentsSelector: theia.DocumentSelector = { scheme: 'file', language: 'typescript' };
 const provider = { provideDocumentSymbols: provideSymbols };
+const metadata = { label: 'providerLabel' }
 
-const disposable = theia.languages.registerDocumentSymbolProvider(documentsSelector, provider);
+const disposable = theia.languages.registerDocumentSymbolProvider(documentsSelector, provider, metadata);
 
 ...
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.24.0-next.5+e292e0efff2",
+  "version": "1.24.0-next.52+b1bd7bd528c",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -32,5 +32,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "e292e0efff25da6a81c86acc828b97d9d02bba8a"
+  "gitHead": "b1bd7bd528c257652f29451d168b750840c22e45"
 }

package/src/theia.d.ts

@@ -1296,6 +1296,15 @@ export module '@theia/plugin' {
          */
         static parse(value: string): Uri;
 
+        /**
+         * Create an URI from its component parts
+         *
+         * @see {@link Uri.toString}
+         * @param components The component parts of an Uri.
+         * @return A new Uri instance.
+         */
+        static from(components: { readonly scheme: string; readonly authority?: string; readonly path?: string; readonly query?: string; readonly fragment?: string }): Uri;
+
         /**
          * Use the `file` and `parse` factory functions to create new `Uri` objects.
          */
@@ -2069,8 +2078,8 @@ export module '@theia/plugin' {
     /**
      * Represents an item that can be selected from a list of items.
      */
-    export interface QuickPickItem {
-        type?: 'item' | 'separator';
+    export interface QuickPickItemValue {
+        type?: 'item';
         /**
          * The item label
          */
@@ -2097,6 +2106,13 @@ export module '@theia/plugin' {
         alwaysShow?: boolean;
     }
 
+    export interface QuickPickSeparator {
+        type: 'separator';
+        label?: string;
+    }
+
+    export type QuickPickItem = QuickPickSeparator | QuickPickItemValue;
+
     /**
      * A concrete [QuickInput](#QuickInput) to let the user pick an item from a
      * list of items of type T. The items can be filtered through a filter text field and
@@ -2533,6 +2549,13 @@ export module '@theia/plugin' {
          */
         appendLine(value: string): void;
 
+        /**
+         * Replaces all output from the channel with the given value.
+         *
+         * @param value A string, falsy values will not be printed.
+         */
+        replace(value: string): void;
+
         /**
          * Removes all output from the channel.
          */
@@ -6198,7 +6221,7 @@ export module '@theia/plugin' {
          * @return true if the operation was successfully started and false otherwise if arguments were used that would result
          * in invalid workspace folder state (e.g. 2 folders with the same URI).
          */
-        export function updateWorkspaceFolders(start: number, deleteCount: number | undefined | null, ...workspaceFoldersToAdd: { uri: Uri, name?: string }[]): boolean;
+        export function updateWorkspaceFolders(start: number, deleteCount: number | undefined | null, ...workspaceFoldersToAdd: { readonly uri: Uri, readonly name?: string }[]): boolean;
 
         /**
          * ~~Register a task provider.~~
@@ -6952,6 +6975,16 @@ export module '@theia/plugin' {
         provideDocumentSymbols(document: TextDocument, token: CancellationToken): ProviderResult<SymbolInformation[] | DocumentSymbol[]>;
     }
 
+    /**
+     * Metadata about a {@link DocumentSymbolProvider}.
+     */
+    export interface DocumentSymbolProviderMetadata {
+        /**
+         * A human-readable string that is shown when multiple outline trees show for one document.
+         */
+        label?: string;
+    }
+
     /**
      * Represents a color in RGBA space.
      */
@@ -8974,9 +9007,11 @@ export module '@theia/plugin' {
          *
          * @param selector A selector that defines the documents this provider is applicable to.
          * @param provider A document symbol provider.
-         * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
+         * @param metadata Optional metadata about the provider.
+         * @return A {@link Disposable disposable} that unregisters this provider when being disposed.
          */
-        export function registerDocumentSymbolProvider(selector: DocumentSelector, provider: DocumentSymbolProvider): Disposable;
+        export function registerDocumentSymbolProvider(selector: DocumentSelector, provider: DocumentSymbolProvider,
+            metadata?: DocumentSymbolProviderMetadata): Disposable;
 
         /**
          * Register a color provider.
@@ -10028,14 +10063,14 @@ export module '@theia/plugin' {
          * @param breakpoints The breakpoints to add.
          */
         // eslint-disable-next-line @typescript-eslint/no-shadow
-        export function addBreakpoints(breakpoints: Breakpoint[]): void;
+        export function addBreakpoints(breakpoints: readonly Breakpoint[]): void;
 
         /**
          * Remove breakpoints.
          * @param breakpoints The breakpoints to remove.
          */
         // eslint-disable-next-line @typescript-eslint/no-shadow
-        export function removeBreakpoints(breakpoints: Breakpoint[]): void;
+        export function removeBreakpoints(breakpoints: readonly Breakpoint[]): void;
     }
 
     /**
@@ -10432,6 +10467,13 @@ export module '@theia/plugin' {
          */
         source?: string;
 
+        /**
+         * A human-readable string which is rendered less prominently on a separate line in places
+         * where the task's name is displayed. Supports rendering of {@link ThemeIcon theme icons}
+         * via the `$(<name>)`-syntax.
+         */
+        detail?: string;
+
         /**
          * The task group this tasks belongs to. See TaskGroup
          * for a predefined set of available groups.
@@ -10450,9 +10492,10 @@ export module '@theia/plugin' {
         problemMatchers?: string[];
     }
 
-    export class Task2 extends Task {
-        detail?: string;
-    }
+    /**
+     * Task2 is kept for compatibility reasons.
+     */
+    export class Task2 extends Task { }
 
     export interface TaskProvider<T extends Task = Task> {
         /**
@@ -11376,7 +11419,7 @@ export module '@theia/plugin' {
          * @param options The [getSessionOptions](#GetSessionOptions) to use
          * @returns A thenable that resolves to an authentication session
          */
-        export function getSession(providerId: string, scopes: string[], options: AuthenticationGetSessionOptions & { createIfNone: true }): Thenable<AuthenticationSession>;
+        export function getSession(providerId: string, scopes: readonly string[], options: AuthenticationGetSessionOptions & { createIfNone: true }): Thenable<AuthenticationSession>;
 
         /**
          * Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not
@@ -11404,7 +11447,7 @@ export module '@theia/plugin' {
          * @param options The [getSessionOptions](#GetSessionOptions) to use
          * @returns A thenable that resolves to an authentication session if available, or undefined if there are no sessions
          */
-        export function getSession(providerId: string, scopes: string[], options?: AuthenticationGetSessionOptions): Thenable<AuthenticationSession | undefined>;
+        export function getSession(providerId: string, scopes: readonly string[], options?: AuthenticationGetSessionOptions): Thenable<AuthenticationSession | undefined>;
 
         /**
          * An [event](#Event) which fires when the authentication sessions of an authentication provider have