@theia/plugin-ext 1.18.0-next.73c11a11 → 1.18.0-next.77

package/src/plugin/node/debug/debug.ts

@@ -19,7 +19,7 @@ import { CommunicationProvider } from '@theia/debug/lib/common/debug-model';
 import * as theia from '@theia/plugin';
 import { URI } from '@theia/core/shared/vscode-uri';
 import { Breakpoint } from '../../../common/plugin-api-rpc-model';
-import { DebugExt, DebugMain, PLUGIN_RPC_CONTEXT as Ext, TerminalOptionsExt } from '../../../common/plugin-api-rpc';
+import { DebugConfigurationProviderTriggerKind, DebugExt, DebugMain, PLUGIN_RPC_CONTEXT as Ext, TerminalOptionsExt } from '../../../common/plugin-api-rpc';
 import { PluginPackageDebuggersContribution } from '../../../common/plugin-protocol';
 import { RPCProtocol } from '../../../common/rpc-protocol';
 import { PluginWebSocketChannel } from '../../../common/connection';
@@ -43,8 +43,11 @@ export class DebugExtImpl implements DebugExt {
     // debug sessions by sessionId
     private sessions = new Map<string, PluginDebugAdapterSession>();
 
-    // providers by type
+    // providers by type (initial)
     private configurationProviders = new Map<string, Set<theia.DebugConfigurationProvider>>();
+    // providers by type (dynamic)
+    private dynamicConfigurationProviders = new Map<string, Set<theia.DebugConfigurationProvider>>();
+
     /**
      * Only use internally, don't send it to the frontend. It's expensive!
      * It's already there as a part of the plugin metadata.
@@ -182,19 +185,22 @@ export class DebugExtImpl implements DebugExt {
         });
     }
 
-    registerDebugConfigurationProvider(debugType: string, provider: theia.DebugConfigurationProvider): Disposable {
-        console.log(`Debug configuration provider has been registered: ${debugType}`);
-        const providers = this.configurationProviders.get(debugType) || new Set<theia.DebugConfigurationProvider>();
-        this.configurationProviders.set(debugType, providers);
+    registerDebugConfigurationProvider(debugType: string, provider: theia.DebugConfigurationProvider, trigger: theia.DebugConfigurationProviderTriggerKind): Disposable {
+        console.log(`Debug configuration provider has been registered: ${debugType}, trigger: ${trigger}`);
+        const providersByTriggerKind = trigger === DebugConfigurationProviderTriggerKind.Initial ? this.configurationProviders : this.dynamicConfigurationProviders;
+        let providers = providersByTriggerKind.get(debugType);
+        if (!providers) {
+            providersByTriggerKind.set(debugType, providers = new Set());
+        }
         providers.add(provider);
 
         return Disposable.create(() => {
             // eslint-disable-next-line @typescript-eslint/no-shadow
-            const providers = this.configurationProviders.get(debugType);
+            const providers = providersByTriggerKind.get(debugType);
             if (providers) {
                 providers.delete(provider);
                 if (providers.size === 0) {
-                    this.configurationProviders.delete(debugType);
+                    providersByTriggerKind.delete(debugType);
                 }
             }
         });
@@ -319,10 +325,10 @@ export class DebugExtImpl implements DebugExt {
         return undefined;
     }
 
-    async $provideDebugConfigurations(debugType: string, workspaceFolderUri: string | undefined): Promise<theia.DebugConfiguration[]> {
+    async $provideDebugConfigurations(debugType: string, workspaceFolderUri: string | undefined, dynamic: boolean = false): Promise<theia.DebugConfiguration[]> {
         let result: theia.DebugConfiguration[] = [];
 
-        const providers = this.configurationProviders.get(debugType);
+        const providers = dynamic ? this.dynamicConfigurationProviders.get(debugType) : this.configurationProviders.get(debugType);
         if (providers) {
             for (const provider of providers) {
                 if (provider.provideDebugConfigurations) {
@@ -337,7 +343,11 @@ export class DebugExtImpl implements DebugExt {
     async $resolveDebugConfigurations(debugConfiguration: theia.DebugConfiguration, workspaceFolderUri: string | undefined): Promise<theia.DebugConfiguration | undefined> {
         let current = debugConfiguration;
 
-        for (const providers of [this.configurationProviders.get(debugConfiguration.type), this.configurationProviders.get('*')]) {
+        for (const providers of [
+            this.configurationProviders.get(debugConfiguration.type),
+            this.dynamicConfigurationProviders.get(debugConfiguration.type),
+            this.configurationProviders.get('*')
+        ]) {
             if (providers) {
                 for (const provider of providers) {
                     if (provider.resolveDebugConfiguration) {
@@ -363,7 +373,11 @@ export class DebugExtImpl implements DebugExt {
         Promise<theia.DebugConfiguration | undefined> {
         let current = debugConfiguration;
 
-        for (const providers of [this.configurationProviders.get(debugConfiguration.type), this.configurationProviders.get('*')]) {
+        for (const providers of [
+            this.configurationProviders.get(debugConfiguration.type),
+            this.dynamicConfigurationProviders.get(debugConfiguration.type),
+            this.configurationProviders.get('*')
+        ]) {
             if (providers) {
                 for (const provider of providers) {
                     if (provider.resolveDebugConfigurationWithSubstitutedVariables) {

package/src/plugin/plugin-context.ts

@@ -17,7 +17,7 @@
 /* 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';
@@ -27,7 +27,8 @@ import {
     Plugin as InternalPlugin,
     PluginManager,
     PluginAPIFactory,
-    MainMessageType
+    MainMessageType,
+    DebugConfigurationProviderTriggerKind
 } from '../common/plugin-api-rpc';
 import { RPCProtocol } from '../common/rpc-protocol';
 import { MessageRegistryExt } from './message-registry';
@@ -134,7 +135,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 +151,7 @@ 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 { CancellationToken, CancellationError } 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';
@@ -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,7 @@ export function createAPIFactory(
             Task2,
             DebugAdapterExecutable,
             DebugAdapterServer,
+            DebugConfigurationProviderTriggerKind,
             Breakpoint,
             SourceBreakpoint,
             FunctionBreakpoint,
@@ -952,7 +959,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

@@ -60,6 +60,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/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';
@@ -41,7 +41,7 @@ export function isPromiseCanceledError(error: any): boolean {
 }
 
 export function getIconUris(iconPath: theia.QuickInputButton['iconPath']): { dark: URI, light: URI } | { id: string } {
-    if (iconPath instanceof ThemeIcon) {
+    if (ThemeIcon.is(iconPath)) {
         return { id: iconPath.id };
     }
     const dark = getDarkIconUri(iconPath as URI | { light: URI; dark: URI; });
@@ -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();
     }
@@ -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
@@ -439,7 +436,7 @@ export class QuickInputExt implements QuickInput {
             const relativePath = path.relative(packagePath, normalizedPath);
             return PluginPackage.toPluginUrl(this.plugin.rawModel, relativePath);
         };
-        if ('id' in iconPath || iconPath instanceof ThemeIcon) {
+        if (ThemeIcon.is(iconPath)) {
             return iconPath;
         } else if (typeof iconPath === 'string' || iconPath instanceof monaco.Uri) {
             return URI.parse(toUrl(iconPath));
@@ -616,6 +613,7 @@ export class QuickPickExt<T extends theia.QuickPickItem> extends QuickInputExt i
             this._handlesToItems.set(i, item);
             this._itemsToHandles.set(item, i);
         });
+        items.forEach((item, i) => Object.assign(item, { handle: i }));
         this.update({
             items
         });
@@ -690,26 +688,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/tree/tree-views.ts

@@ -100,6 +100,12 @@ export class TreeViewsExtImpl implements TreeViewsExt {
             set title(title: string) {
                 treeView.title = title;
             },
+            get description(): string {
+                return treeView.description;
+            },
+            set description(description: string) {
+                treeView.description = description;
+            },
             reveal: (element: T, revealOptions?: Partial<TreeViewRevealOptions>): Thenable<void> =>
                 treeView.reveal(element, revealOptions),
 
@@ -227,6 +233,16 @@ class TreeViewExtImpl<T> implements Disposable {
         this.proxy.$setTitle(this.treeViewId, title);
     }
 
+    private _description: string = '';
+    get description(): string {
+        return this._description;
+    }
+
+    set description(description: string) {
+        this._description = description;
+        this.proxy.$setDescription(this.treeViewId, this._description);
+    }
+
     getTreeItem(treeItemId: string): T | undefined {
         const element = this.nodes.get(treeItemId);
         return element && element.value;
@@ -353,7 +369,7 @@ class TreeViewExtImpl<T> implements Disposable {
                 const { iconPath } = treeItem;
                 if (typeof iconPath === 'string' && iconPath.indexOf('fa-') !== -1) {
                     icon = iconPath;
-                } else if (iconPath instanceof ThemeIcon) {
+                } else if (ThemeIcon.is(iconPath)) {
                     themeIconId = iconPath.id;
                 } else {
                     iconUrl = PluginIconPath.toUrl(<PluginIconPath | undefined>iconPath, this.plugin);

package/src/plugin/type-converters.ts

@@ -27,6 +27,7 @@ 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 +169,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 +211,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 +269,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 +302,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,7 +683,8 @@ 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
     };
 }
 

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.
  */
@@ -702,6 +722,12 @@ export class ThemeIcon {
 
 }
 
+export namespace ThemeIcon {
+    export function is(item: unknown): item is ThemeIcon {
+        return typeof item === 'object' && !!item && 'id' in item;
+    }
+}
+
 export enum TextEditorRevealType {
     Default = 0,
     InCenter = 1,
@@ -886,7 +912,9 @@ export enum CompletionItemKind {
     Struct = 21,
     Event = 22,
     Operator = 23,
-    TypeParameter = 24
+    TypeParameter = 24,
+    User = 25,
+    Issue = 26
 }
 
 @es5ClassCompat
@@ -2338,6 +2366,7 @@ export class CallHierarchyItem {
     uri: URI;
     range: Range;
     selectionRange: Range;
+    tags?: readonly SymbolTag[];
 
     constructor(kind: SymbolKind, name: string, detail: string, uri: URI, range: Range, selectionRange: Range) {
         this.kind = kind;