@theia/plugin-ext 1.18.0-next.d3501165 → 1.19.0

package/src/plugin/plugin-context.ts

@@ -17,17 +17,18 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /* tslint:disable:typedef */
 
-import * as theia from '@theia/plugin';
+import type * as theia from '@theia/plugin';
 import { CommandRegistryImpl } from './command-registry';
 import { Emitter } from '@theia/core/lib/common/event';
-import { CancellationTokenSource } from '@theia/core/lib/common/cancellation';
+import { CancellationError, CancellationToken, CancellationTokenSource } from '@theia/core/lib/common/cancellation';
 import { QuickOpenExtImpl } from './quick-open';
 import {
     MAIN_RPC_CONTEXT,
     Plugin as InternalPlugin,
     PluginManager,
     PluginAPIFactory,
-    MainMessageType
+    MainMessageType,
+    DebugConfigurationProviderTriggerKind
 } from '../common/plugin-api-rpc';
 import { RPCProtocol } from '../common/rpc-protocol';
 import { MessageRegistryExt } from './message-registry';
@@ -105,6 +106,8 @@ import {
     Task2,
     DebugAdapterExecutable,
     DebugAdapterServer,
+    DebugAdapterNamedPipeServer,
+    DebugAdapterInlineImplementation,
     Breakpoint,
     SourceBreakpoint,
     FunctionBreakpoint,
@@ -134,7 +137,8 @@ import {
     ColorThemeKind,
     SourceControlInputBoxValidationType,
     URI,
-    FileDecoration
+    FileDecoration,
+    ExtensionMode
 } from './types-impl';
 import { AuthenticationExtImpl } from './authentication-ext';
 import { SymbolKind } from '../common/plugin-api-rpc-model';
@@ -149,7 +153,6 @@ import { LanguagesExtImpl } from './languages';
 import { fromDocumentSelector, pluginToPluginInfo, fromGlobPattern } from './type-converters';
 import { DialogsExtImpl } from './dialogs';
 import { NotificationExtImpl } from './notification';
-import { CancellationToken } from '@theia/core/lib/common/cancellation';
 import { score } from '@theia/callhierarchy/lib/common/language-selector';
 import { MarkdownString } from './markdown-string';
 import { TreeViewsExtImpl } from './tree/tree-views';
@@ -157,9 +160,8 @@ import { ConnectionExtImpl } from './connection-ext';
 import { TasksExtImpl } from './tasks/tasks';
 import { DebugExtImpl } from './node/debug/debug';
 import { FileSystemExtImpl } from './file-system-ext-impl';
-import { QuickPick, QuickPickItem, ResourceLabelFormatter } from '@theia/plugin';
+import { QuickPick, QuickPickItem, ResourceLabelFormatter, LineChange } from '@theia/plugin';
 import { ScmExtImpl } from './scm';
-import { LineChange } from '@theia/plugin';
 import { DecorationsExtImpl } from './decorations';
 import { TextEditorExt } from './text-editor';
 import { ClipboardExt } from './clipboard-ext';
@@ -767,8 +769,12 @@ export function createAPIFactory(
             registerDebugAdapterDescriptorFactory(debugType: string, factory: theia.DebugAdapterDescriptorFactory): Disposable {
                 return debugExt.registerDebugAdapterDescriptorFactory(debugType, factory);
             },
-            registerDebugConfigurationProvider(debugType: string, provider: theia.DebugConfigurationProvider): Disposable {
-                return debugExt.registerDebugConfigurationProvider(debugType, provider);
+            registerDebugConfigurationProvider(
+                debugType: string,
+                provider: theia.DebugConfigurationProvider,
+                triggerKind?: theia.DebugConfigurationProviderTriggerKind
+            ): Disposable {
+                return debugExt.registerDebugConfigurationProvider(debugType, provider, triggerKind || DebugConfigurationProviderTriggerKind.Initial);
             },
             registerDebugAdapterTrackerFactory(debugType: string, factory: theia.DebugAdapterTrackerFactory): Disposable {
                 return debugExt.registerDebugAdapterTrackerFactory(debugType, factory);
@@ -924,6 +930,9 @@ export function createAPIFactory(
             Task2,
             DebugAdapterExecutable,
             DebugAdapterServer,
+            DebugAdapterNamedPipeServer,
+            DebugAdapterInlineImplementation,
+            DebugConfigurationProviderTriggerKind,
             Breakpoint,
             SourceBreakpoint,
             FunctionBreakpoint,
@@ -952,7 +961,9 @@ export function createAPIFactory(
             SemanticTokensEdit,
             ColorThemeKind,
             SourceControlInputBoxValidationType,
-            FileDecoration
+            FileDecoration,
+            CancellationError,
+            ExtensionMode
         };
     };
 }

package/src/plugin/plugin-manager.ts

@@ -33,7 +33,7 @@ import * as theia from '@theia/plugin';
 import { join } from './path';
 import { EnvExtImpl } from './env';
 import { PreferenceRegistryExtImpl } from './preference-registry';
-import { Memento, KeyValueStorageProxy } from './plugin-storage';
+import { Memento, KeyValueStorageProxy, GlobalState } from './plugin-storage';
 import { ExtPluginApi } from '../common/plugin-ext-api-contribution';
 import { RPCProtocol } from '../common/rpc-protocol';
 import { Emitter } from '@theia/core/lib/common/event';
@@ -79,7 +79,11 @@ export class PluginManagerExtImpl implements PluginManagerExt, PluginManager {
         '*',
         'onLanguage',
         'onCommand',
-        'onDebug', 'onDebugInitialConfigurations', 'onDebugResolve', 'onDebugAdapterProtocolTracker',
+        'onDebug',
+        'onDebugInitialConfigurations',
+        'onDebugResolve',
+        'onDebugAdapterProtocolTracker',
+        'onDebugDynamicConfigurations',
         'workspaceContains',
         'onView',
         'onUri',
@@ -321,6 +325,23 @@ export class PluginManagerExtImpl implements PluginManagerExt, PluginManager {
     }
 
     async $activateByEvent(activationEvent: string): Promise<void> {
+        if (activationEvent.endsWith(':*')) {
+            const baseEvent = activationEvent.substring(0, activationEvent.length - 2);
+            await this.activateByBaseEvent(baseEvent);
+        } else {
+            await this.activateBySingleEvent(activationEvent);
+        }
+    }
+
+    protected async activateByBaseEvent(baseEvent: string): Promise<void> {
+        await Promise.all(Array.from(this.activations.keys(), activation => {
+            if (activation.startsWith(baseEvent)) {
+                return this.activateBySingleEvent(activation);
+            }
+        }));
+    }
+
+    protected async activateBySingleEvent(activationEvent: string): Promise<void> {
         const activations = this.activations.get(activationEvent);
         if (!activations) {
             return;
@@ -351,7 +372,7 @@ export class PluginManagerExtImpl implements PluginManagerExt, PluginManager {
         const pluginContext: theia.PluginContext = {
             extensionPath: plugin.pluginFolder,
             extensionUri: Uri.file(plugin.pluginFolder),
-            globalState: new Memento(plugin.model.id, true, this.storageProxy),
+            globalState: new GlobalState(plugin.model.id, true, this.storageProxy),
             workspaceState: new Memento(plugin.model.id, false, this.storageProxy),
             subscriptions: subscriptions,
             asAbsolutePath: asAbsolutePath,
@@ -361,7 +382,8 @@ export class PluginManagerExtImpl implements PluginManagerExt, PluginManager {
             secrets,
             globalStoragePath: globalStoragePath,
             globalStorageUri: Uri.file(globalStoragePath),
-            environmentVariableCollection: this.terminalService.getEnvironmentVariableCollection(plugin.model.id)
+            environmentVariableCollection: this.terminalService.getEnvironmentVariableCollection(plugin.model.id),
+            extensionMode: 1 // @todo: implement proper `extensionMode`.
         };
         this.pluginContextsMap.set(plugin.model.id, pluginContext);
 

package/src/plugin/plugin-storage.ts

@@ -16,10 +16,9 @@
 
 import * as theia from '@theia/plugin';
 import { Event, Emitter } from '@theia/core/lib/common/event';
-import { StorageMain, StorageExt } from '../common/plugin-api-rpc';
+import { PLUGIN_RPC_CONTEXT, StorageMain, StorageExt } from '../common/plugin-api-rpc';
 import { KeysToAnyValues, KeysToKeysToAnyValue } from '../common/types';
 import { RPCProtocol } from '../common/rpc-protocol';
-import { PLUGIN_RPC_CONTEXT } from '../common/plugin-api-rpc';
 
 export class Memento implements theia.Memento {
 
@@ -60,6 +59,12 @@ export class Memento implements theia.Memento {
     }
 }
 
+export class GlobalState extends Memento {
+
+    /** @todo: API is not yet implemented. */
+    setKeysForSync(keys: readonly string[]): void { }
+}
+
 /**
  * Singleton.
  * Is used to proxy storage requests to main side.

package/src/plugin/preference-registry.spec.ts

@@ -17,8 +17,7 @@
 import { PreferenceRegistryExtImpl } from './preference-registry';
 import * as chai from 'chai';
 import { WorkspaceExtImpl } from '../plugin/workspace';
-import { RPCProtocol } from '../common/rpc-protocol';
-import { ProxyIdentifier } from '../common/rpc-protocol';
+import { ProxyIdentifier, RPCProtocol } from '../common/rpc-protocol';
 
 const expect = chai.expect;
 

package/src/plugin/quick-open.ts

@@ -16,7 +16,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import {
     QuickOpenExt, PLUGIN_RPC_CONTEXT as Ext, QuickOpenMain, TransferInputBox, Plugin,
-    Item, TransferQuickInputButton, TransferQuickPickItems, TransferQuickInput, TransferQuickPick
+    Item, TransferQuickInputButton, TransferQuickPickItems, TransferQuickInput
 } from '../common/plugin-api-rpc';
 import * as theia from '@theia/plugin';
 import { QuickPickItem, InputBoxOptions, InputBox, QuickPick, QuickInput } from '@theia/plugin';
@@ -178,10 +178,6 @@ export class QuickOpenExtImpl implements QuickOpenExt {
         return session;
     }
 
-    showCustomQuickPick<T extends QuickPickItem>(options: TransferQuickPick<T>): void {
-        this.proxy.$showCustomQuickPick(options);
-    }
-
     hide(): void {
         this.proxy.$hide();
     }
@@ -263,7 +259,7 @@ export class QuickInputExt implements QuickInput {
     private onDidHideEmitter: Emitter<void>;
     private onDidTriggerButtonEmitter: Emitter<theia.QuickInputButton>;
     private _updateTimeout: any;
-    private _pendingUpdate: TransferQuickInput<any> = { id: this._id };
+    private _pendingUpdate: TransferQuickInput = { id: this._id };
 
     constructor(readonly quickOpen: QuickOpenExtImpl, readonly quickOpenMain: QuickOpenMain, readonly plugin: Plugin, private _onDidDispose: () => void) {
         this.title = undefined;
@@ -389,6 +385,7 @@ export class QuickInputExt implements QuickInput {
         this._fireHide();
         this.disposableCollection.dispose();
         this._onDidDispose();
+        this.quickOpenMain.$dispose(this._id);
     }
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -617,7 +614,15 @@ export class QuickPickExt<T extends theia.QuickPickItem> extends QuickInputExt i
             this._itemsToHandles.set(item, i);
         });
         this.update({
-            items
+            items: items.map((item, i) => ({
+                type: item.type,
+                label: item.label,
+                description: item.description,
+                handle: i,
+                detail: item.detail,
+                picked: item.picked,
+                alwaysShow: item.alwaysShow
+            }))
         });
     }
 
@@ -690,26 +695,4 @@ export class QuickPickExt<T extends theia.QuickPickItem> extends QuickInputExt i
         this._selectedItems = items;
         this._onDidChangeSelectionEmitter.fire(items);
     }
-
-    show(): void {
-        super.show();
-        this.quickOpen.showCustomQuickPick({
-            id: this._id,
-            title: this.title,
-            step: this.step,
-            totalSteps: this.totalSteps,
-            enabled: this.enabled,
-            busy: this.busy,
-            ignoreFocusOut: this.ignoreFocusOut,
-            value: this.value,
-            placeholder: this.placeholder,
-            buttons: this.buttons,
-            items: convertToTransferQuickPickItems(this.items),
-            canSelectMany: this.canSelectMany,
-            matchOnDescription: this.matchOnDescription,
-            matchOnDetail: this.matchOnDetail,
-            activeItems: this.activeItems,
-            selectedItems: this.selectedItems
-        });
-    }
 }

package/src/plugin/tasks/tasks.ts

@@ -29,6 +29,7 @@ import { TaskProviderAdapter } from './task-provider';
 import { Emitter, Event } from '@theia/core/lib/common/event';
 import { TerminalServiceExtImpl } from '../terminal-ext';
 import { UUID } from '@theia/core/shared/@phosphor/coreutils';
+import { CancellationToken } from '@theia/core/lib/common/cancellation';
 
 type ExecutionCallback = (resolvedDefinition: theia.TaskDefinition) => Thenable<theia.Pseudoterminal>;
 export class TasksExtImpl implements TasksExt {
@@ -164,10 +165,10 @@ export class TasksExtImpl implements TasksExt {
         throw new Error('Task was not successfully transformed into a task config');
     }
 
-    $provideTasks(handle: number, token: theia.CancellationToken): Promise<TaskDto[] | undefined> {
+    $provideTasks(handle: number): Promise<TaskDto[] | undefined> {
         const adapter = this.adaptersMap.get(handle);
         if (adapter) {
-            return adapter.provideTasks(token).then(tasks => {
+            return adapter.provideTasks(CancellationToken.None).then(tasks => {
                 if (tasks) {
                     for (const task of tasks) {
                         if (task.taskType === 'customExecution') {

package/src/plugin/timeline.ts

@@ -13,10 +13,9 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Plugin, TimelineCommandArg, TimelineExt, TimelineMain } from '../common';
+import { Plugin, PLUGIN_RPC_CONTEXT, TimelineCommandArg, TimelineExt, TimelineMain } from '../common';
 import { RPCProtocol } from '../common/rpc-protocol';
 import { Disposable, URI } from './types-impl';
-import { PLUGIN_RPC_CONTEXT } from '../common';
 import { DisposableCollection } from '@theia/core/lib/common/disposable';
 import { CommandRegistryImpl } from './command-registry';
 import type {

package/src/plugin/type-converters.ts

@@ -26,7 +26,7 @@ import { LanguageFilter, LanguageSelector, RelativePattern } from '@theia/callhi
 import { isMarkdownString, MarkdownString } from './markdown-string';
 import * as types from './types-impl';
 import { UriComponents } from '../common/uri-components';
-import { TaskGroup } from './types-impl';
+import { isReadonlyArray } from '../common/arrays';
 
 const SIDE_GROUP = -2;
 const ACTIVE_GROUP = -1;
@@ -168,10 +168,7 @@ export function fromRangeOrRangeWithMessage(ranges: theia.Range[] | theia.Decora
             };
         });
     } else {
-        return ranges.map((r): DecorationOptions =>
-            ({
-                range: fromRange(r)!
-            }));
+        return ranges.map(r => ({ range: fromRange(r) }));
     }
 }
 
@@ -213,7 +210,7 @@ export function toMarkdown(value: model.MarkdownString): MarkdownString {
 export function fromDocumentSelector(selector: theia.DocumentSelector | undefined): LanguageSelector | undefined {
     if (!selector) {
         return undefined;
-    } else if (Array.isArray(selector)) {
+    } else if (isReadonlyArray(selector)) {
         return <LanguageSelector>selector.map(fromDocumentSelector);
     } else if (typeof selector === 'string') {
         return selector;
@@ -271,6 +268,8 @@ export function fromCompletionItemKind(kind?: types.CompletionItemKind): model.C
         case types.CompletionItemKind.Event: return model.CompletionItemKind.Event;
         case types.CompletionItemKind.Operator: return model.CompletionItemKind.Operator;
         case types.CompletionItemKind.TypeParameter: return model.CompletionItemKind.TypeParameter;
+        case types.CompletionItemKind.User: return model.CompletionItemKind.User;
+        case types.CompletionItemKind.Issue: return model.CompletionItemKind.Issue;
     }
     return model.CompletionItemKind.Property;
 }
@@ -302,6 +301,8 @@ export function toCompletionItemKind(kind?: model.CompletionItemKind): types.Com
         case model.CompletionItemKind.Event: return types.CompletionItemKind.Event;
         case model.CompletionItemKind.Operator: return types.CompletionItemKind.Operator;
         case model.CompletionItemKind.TypeParameter: return types.CompletionItemKind.TypeParameter;
+        case model.CompletionItemKind.User: return types.CompletionItemKind.User;
+        case model.CompletionItemKind.Issue: return types.CompletionItemKind.Issue;
     }
     return types.CompletionItemKind.Property;
 }
@@ -681,18 +682,24 @@ export function fromCallHierarchyItem(item: theia.CallHierarchyItem): model.Call
         detail: item.detail,
         uri: item.uri,
         range: fromRange(item.range),
-        selectionRange: fromRange(item.selectionRange)
+        selectionRange: fromRange(item.selectionRange),
+        tags: item.tags,
+        data: item.data,
     };
 }
 
 export function toCallHierarchyItem(value: model.CallHierarchyItem): types.CallHierarchyItem {
-    return new types.CallHierarchyItem(
+    const item = new types.CallHierarchyItem(
         SymbolKind.toSymbolKind(value.kind),
         value.name,
         value.detail ? value.detail : '',
         URI.revive(value.uri),
         toRange(value.range),
-        toRange(value.selectionRange));
+        toRange(value.selectionRange),
+    );
+    item.tags = value.tags;
+    item.data = value.data;
+    return item;
 }
 
 export function toCallHierarchyIncomingCall(value: model.CallHierarchyIncomingCall): types.CallHierarchyIncomingCall {
@@ -741,9 +748,9 @@ export function fromTask(task: theia.Task): TaskDto | undefined {
     }
 
     const group = task.group;
-    if (group === TaskGroup.Build) {
+    if (group === types.TaskGroup.Build) {
         taskDto.group = BUILD_GROUP;
-    } else if (group === TaskGroup.Test) {
+    } else if (group === types.TaskGroup.Test) {
         taskDto.group = TEST_GROUP;
     }
 
@@ -830,9 +837,9 @@ export function toTask(taskDto: TaskDto): theia.Task {
 
     if (group) {
         if (group === BUILD_GROUP) {
-            result.group = TaskGroup.Build;
+            result.group = types.TaskGroup.Build;
         } else if (group === TEST_GROUP) {
-            result.group = TaskGroup.Test;
+            result.group = types.TaskGroup.Test;
         }
     }
 

package/src/plugin/types-impl.ts

@@ -189,6 +189,26 @@ export enum ColorThemeKind {
     HighContrast = 3
 }
 
+export enum ExtensionMode {
+    /**
+     * The extension is installed normally (for example, from the marketplace
+     * or VSIX) in the editor.
+     */
+    Production = 1,
+
+    /**
+     * The extension is running from an `--extensionDevelopmentPath` provided
+     * when launching the editor.
+     */
+    Development = 2,
+
+    /**
+     * The extension is running from an `--extensionTestsPath` and
+     * the extension host is running unit tests.
+     */
+    Test = 3,
+}
+
 /**
  * Represents the validation type of the Source Control input.
  */
@@ -892,7 +912,9 @@ export enum CompletionItemKind {
     Struct = 21,
     Event = 22,
     Operator = 23,
-    TypeParameter = 24
+    TypeParameter = 24,
+    User = 25,
+    Issue = 26
 }
 
 @es5ClassCompat
@@ -2098,6 +2120,12 @@ export class DebugAdapterExecutable {
     }
 }
 
+export namespace DebugAdapterExecutable {
+    export function is(adapter: theia.DebugAdapterDescriptor | undefined): adapter is theia.DebugAdapterExecutable {
+        return !!adapter && 'command' in adapter;
+    }
+}
+
 /**
  * Represents a debug adapter running as a socket based server.
  */
@@ -2123,6 +2151,52 @@ export class DebugAdapterServer {
     }
 }
 
+export namespace DebugAdapterServer {
+    export function is(adapter: theia.DebugAdapterDescriptor | undefined): adapter is DebugAdapterServer {
+        return !!adapter && 'port' in adapter;
+    }
+}
+
+/**
+ * Represents a debug adapter running as a Named Pipe (on Windows)/UNIX Domain Socket (on non-Windows) based server.
+ */
+@es5ClassCompat
+export class DebugAdapterNamedPipeServer {
+    /**
+     * Create a description for a debug adapter running as a Named Pipe (on Windows)/UNIX Domain Socket (on non-Windows) based server.
+     */
+    constructor(readonly path: string) { }
+}
+
+export namespace DebugAdapterNamedPipeServer {
+    export function is(adapter: theia.DebugAdapterDescriptor | undefined): adapter is DebugAdapterNamedPipeServer {
+        return !!adapter && 'path' in adapter;
+    }
+}
+
+/**
+ * A debug adapter descriptor for an inline implementation.
+ */
+@es5ClassCompat
+export class DebugAdapterInlineImplementation {
+    implementation: theia.DebugAdapter;
+
+    /**
+     * Create a descriptor for an inline implementation of a debug adapter.
+     */
+    constructor(impl: theia.DebugAdapter) {
+        this.implementation = impl;
+    }
+}
+
+export namespace DebugAdapterInlineImplementation {
+    export function is(adapter: theia.DebugAdapterDescriptor | undefined): adapter is DebugAdapterInlineImplementation {
+        return !!adapter && 'implementation' in adapter;
+    }
+}
+
+export type DebugAdapterDescriptor = DebugAdapterExecutable | DebugAdapterServer | DebugAdapterNamedPipeServer | DebugAdapterInlineImplementation;
+
 export enum LogLevel {
     Trace = 1,
     Debug = 2,
@@ -2344,6 +2418,8 @@ export class CallHierarchyItem {
     uri: URI;
     range: Range;
     selectionRange: Range;
+    tags?: readonly SymbolTag[];
+    data?: unknown;
 
     constructor(kind: SymbolKind, name: string, detail: string, uri: URI, range: Range, selectionRange: Range) {
         this.kind = kind;

package/src/plugin/webviews.ts

@@ -15,10 +15,9 @@
  ********************************************************************************/
 
 import { v4 } from 'uuid';
-import { WebviewsExt, WebviewPanelViewState, WebviewsMain, PLUGIN_RPC_CONTEXT, WebviewInitData, /* WebviewsMain, PLUGIN_RPC_CONTEXT  */ } from '../common/plugin-api-rpc';
+import { Plugin, WebviewsExt, WebviewPanelViewState, WebviewsMain, PLUGIN_RPC_CONTEXT, WebviewInitData, /* WebviewsMain, PLUGIN_RPC_CONTEXT  */ } from '../common/plugin-api-rpc';
 import * as theia from '@theia/plugin';
 import { RPCProtocol } from '../common/rpc-protocol';
-import { Plugin } from '../common/plugin-api-rpc';
 import { Emitter, Event } from '@theia/core/lib/common/event';
 import { fromViewColumn, toViewColumn, toWebviewPanelShowOptions } from './type-converters';
 import { Disposable, WebviewPanelTargetArea, URI } from './types-impl';