@theia/plugin-ext 1.37.0-next.8 → 1.37.0

package/src/plugin/output-channel-registry.ts

@@ -13,11 +13,12 @@
 //
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 // *****************************************************************************
-import {
-    PLUGIN_RPC_CONTEXT as Ext, OutputChannelRegistryMain, PluginInfo, OutputChannelRegistryExt
-} from '../common/plugin-api-rpc';
-import { RPCProtocol } from '../common/rpc-protocol';
+
 import * as theia from '@theia/plugin';
+import { PLUGIN_RPC_CONTEXT as Ext, OutputChannelRegistryExt, OutputChannelRegistryMain, PluginInfo } from '../common/plugin-api-rpc';
+import { RPCProtocol } from '../common/rpc-protocol';
+import { isObject } from '../common/types';
+import { LogOutputChannelImpl } from './output-channel/log-output-channel';
 import { OutputChannelImpl } from './output-channel/output-channel-item';
 
 export class OutputChannelRegistryExtImpl implements OutputChannelRegistryExt {
@@ -28,12 +29,24 @@ export class OutputChannelRegistryExtImpl implements OutputChannelRegistryExt {
         this.proxy = rpc.getProxy(Ext.OUTPUT_CHANNEL_REGISTRY_MAIN);
     }
 
-    createOutputChannel(name: string, pluginInfo: PluginInfo): theia.OutputChannel {
+    createOutputChannel(name: string, pluginInfo: PluginInfo): theia.OutputChannel;
+    createOutputChannel(name: string, pluginInfo: PluginInfo, options: { log: true; }): theia.LogOutputChannel;
+    createOutputChannel(name: string, pluginInfo: PluginInfo, options?: { log: true; }): theia.OutputChannel | theia.LogOutputChannel {
         name = name.trim();
         if (!name) {
             throw new Error('illegal argument \'name\'. must not be falsy');
-        } else {
-            return new OutputChannelImpl(name, this.proxy, pluginInfo);
         }
+        const isLogOutput = options && isObject(options);
+        return isLogOutput
+            ? this.doCreateLogOutputChannel(name, pluginInfo)
+            : this.doCreateOutputChannel(name, pluginInfo);
+    }
+
+    private doCreateOutputChannel(name: string, pluginInfo: PluginInfo): OutputChannelImpl {
+        return new OutputChannelImpl(name, this.proxy, pluginInfo);
+    }
+
+    private doCreateLogOutputChannel(name: string, pluginInfo: PluginInfo): LogOutputChannelImpl {
+        return new LogOutputChannelImpl(name, this.proxy, pluginInfo);
     }
 }

package/src/plugin/plugin-context.ts

@@ -131,6 +131,7 @@ import {
     WebviewPanelTargetArea,
     UIKind,
     FileSystemError,
+    CommentThreadState,
     CommentThreadCollapsibleState,
     QuickInputButtons,
     QuickPickItemKind,
@@ -234,6 +235,7 @@ import { PluginPackage } from '../common';
 import { Endpoint } from '@theia/core/lib/browser/endpoint';
 import { FilePermission } from '@theia/filesystem/lib/common/files';
 import { TabsExtImpl } from './tabs';
+import { LocalizationExtImpl } from './localization-ext';
 
 export function createAPIFactory(
     rpc: RPCProtocol,
@@ -245,7 +247,8 @@ export function createAPIFactory(
     workspaceExt: WorkspaceExtImpl,
     messageRegistryExt: MessageRegistryExt,
     clipboard: ClipboardExt,
-    webviewExt: WebviewsExtImpl
+    webviewExt: WebviewsExtImpl,
+    localizationExt: LocalizationExtImpl
 ): PluginAPIFactory {
 
     const authenticationExt = rpc.set(MAIN_RPC_CONTEXT.AUTHENTICATION_EXT, new AuthenticationExtImpl(rpc));
@@ -481,8 +484,10 @@ export function createAPIFactory(
 
                 return statusBarMessageRegistryExt.createStatusBarItem(alignment, priority, id);
             },
-            createOutputChannel(name: string): theia.OutputChannel {
-                return outputChannelRegistryExt.createOutputChannel(name, pluginToPluginInfo(plugin));
+            createOutputChannel(name: string, options?: { log: true }): any {
+                return !options
+                    ? outputChannelRegistryExt.createOutputChannel(name, pluginToPluginInfo(plugin))
+                    : outputChannelRegistryExt.createOutputChannel(name, pluginToPluginInfo(plugin), options);
             },
             createWebviewPanel(viewType: string,
                 title: string,
@@ -1073,6 +1078,27 @@ export function createAPIFactory(
             }
         };
 
+        const l10n: typeof theia.l10n = {
+            // eslint-disable-next-line max-len
+            t(...params: [message: string, ...args: Array<string | number | boolean>] | [message: string, args: Record<string, any>] | [{ message: string; args?: Array<string | number | boolean> | Record<string, any>; comment: string | string[] }]): string {
+                if (typeof params[0] === 'string') {
+                    const key = params.shift() as string;
+
+                    // We have either rest args which are Array<string | number | boolean> or an array with a single Record<string, any>.
+                    // This ensures we get a Record<string | number, any> which will be formatted correctly.
+                    const argsFormatted = !params || typeof params[0] !== 'object' ? params : params[0];
+                    return localizationExt.translateMessage(plugin.model.id, { message: key, args: argsFormatted as Record<string | number, any> | undefined });
+                }
+                return localizationExt.translateMessage(plugin.model.id, params[0]);
+            },
+            get bundle() {
+                return localizationExt.getBundle(plugin.model.id);
+            },
+            get uri() {
+                return localizationExt.getBundleUri(plugin.model.id);
+            }
+        };
+
         // notebooks API (@stubbed)
         // The following implementation is temporarily `@stubbed` and marked as such under `theia.d.ts`
         const notebooks: typeof theia.notebooks = {
@@ -1148,6 +1174,7 @@ export function createAPIFactory(
             tasks,
             scm,
             notebooks,
+            l10n,
             tests,
             // Types
             StatusBarAlignment: StatusBarAlignment,
@@ -1252,6 +1279,7 @@ export function createAPIFactory(
             WebviewPanelTargetArea,
             UIKind,
             FileSystemError,
+            CommentThreadState,
             CommentThreadCollapsibleState,
             QuickInputButtons,
             CommentMode,

package/src/plugin/plugin-manager.ts

@@ -26,7 +26,8 @@ import {
     ConfigStorage,
     PluginManagerInitializeParams,
     PluginManagerStartParams,
-    TerminalServiceExt
+    TerminalServiceExt,
+    LocalizationExt
 } from '../common/plugin-api-rpc';
 import { PluginMetadata, PluginJsonValidationContribution } from '../common/plugin-protocol';
 import * as theia from '@theia/plugin';
@@ -86,6 +87,7 @@ export class PluginManagerExtImpl implements PluginManagerExt, PluginManager {
         'onDebugResolve',
         'onDebugAdapterProtocolTracker',
         'onDebugDynamicConfigurations',
+        'onTaskType',
         'workspaceContains',
         'onView',
         'onUri',
@@ -122,6 +124,7 @@ export class PluginManagerExtImpl implements PluginManagerExt, PluginManager {
         private readonly secrets: SecretsExtImpl,
         private readonly preferencesManager: PreferenceRegistryExtImpl,
         private readonly webview: WebviewsExtImpl,
+        private readonly localization: LocalizationExt,
         private readonly rpc: RPCProtocol
     ) {
         this.messageRegistryProxy = this.rpc.getProxy(PLUGIN_RPC_CONTEXT.MESSAGE_REGISTRY_MAIN);
@@ -398,6 +401,7 @@ export class PluginManagerExtImpl implements PluginManagerExt, PluginManager {
         }
         const id = plugin.model.displayName || plugin.model.id;
         if (typeof pluginMain[plugin.lifecycle.startMethod] === 'function') {
+            await this.localization.initializeLocalizedMessages(plugin, this.envExt.language);
             const pluginExport = await pluginMain[plugin.lifecycle.startMethod].apply(getGlobal(), [pluginContext]);
             this.activatedPlugins.set(plugin.model.id, new ActivatedPlugin(pluginContext, pluginExport, stopFn));
         } else {

package/src/plugin/preference-registry.ts

@@ -264,7 +264,7 @@ export class PreferenceRegistryExtImpl implements PreferenceRegistryExt {
     }
 
     /**
-     * Creates a new object and assigns those keys of raw to it that are not likely to cause prototype polution.
+     * Creates a new object and assigns those keys of raw to it that are not likely to cause prototype pollution.
      * Also preprocesses override identifiers so that they take the form [identifier]: {...contents}.
      */
     private sanitize<T = unknown>(raw: T): T {

package/src/plugin/stubs/tests-api.ts

@@ -27,12 +27,14 @@ export const createRunProfile = (
         token: CancellationToken
     ) => Thenable<void> | void,
     isDefault?: boolean,
-    tag?: theia.TestTag
+    tag?: theia.TestTag,
+    supportsContinuousRun?: boolean
 ) => ({
     label,
     kind,
     isDefault: isDefault ?? false,
     tag,
+    supportsContinuousRun: supportsContinuousRun ?? false,
     runHandler,
     configureHandler: undefined,
     dispose: () => undefined,

package/src/plugin/tree/tree-views.ts

@@ -58,6 +58,10 @@ export class TreeViewsExtImpl implements TreeViewsExt {
         return this.getTreeView(treeViewId).onDragStarted(treeItemIds, token);
     }
 
+    $dragEnd(treeViewId: string): Promise<void> {
+        return this.getTreeView(treeViewId).dragEnd();
+    }
+
     $drop(treeViewId: string, treeItemId: string | undefined, dataTransferItems: [string, string | DataTransferFileDTO][], token: CancellationToken): Promise<void> {
         return this.getTreeView(treeViewId).handleDrop!(treeItemId, dataTransferItems, token);
     }
@@ -389,7 +393,7 @@ class TreeViewExtImpl<T> implements Disposable {
     }
 
     async getChildren(parentId: string): Promise<TreeViewItem[] | undefined> {
-        const parentNode = this.nodes.get(parentId);
+        let parentNode = this.nodes.get(parentId);
         const parent = parentNode?.value;
         if (parentId && !parent) {
             console.error(`No tree item with id '${parentId}' found.`);
@@ -398,9 +402,10 @@ class TreeViewExtImpl<T> implements Disposable {
         this.clearChildren(parentNode);
 
         // place root in the cache
-        if (parentId === '') {
+        if (parentId === '' && !parentNode) {
             const rootNodeDisposables = new DisposableCollection();
-            this.nodes.set(parentId, { id: '', disposables: rootNodeDisposables, dispose: () => { rootNodeDisposables.dispose(); } });
+            parentNode = { id: '', disposables: rootNodeDisposables, dispose: () => { rootNodeDisposables.dispose(); } };
+            this.nodes.set(parentId, parentNode);
         }
         // ask data provider for children for cached element
         const result = await this.options.treeDataProvider.getChildren(parent);
@@ -605,6 +610,10 @@ class TreeViewExtImpl<T> implements Disposable {
         return undefined;
     }
 
+    async dragEnd(): Promise<void> {
+        this.localDataTransfer.clear();
+    }
+
     async handleDrop(treeItemId: string | undefined, dataTransferItems: [string, string | DataTransferFileDTO][], token: CancellationToken): Promise<void> {
         const treeItem = treeItemId ? this.getElement(treeItemId) : undefined;
         const dropTransfer = new DataTransfer();

package/src/plugin/type-converters.ts

@@ -835,10 +835,12 @@ export function fromTask(task: theia.Task): TaskDto | undefined {
     if ('detail' in task) {
         taskDto.detail = task.detail;
     }
-    if (typeof task.scope === 'object') {
-        taskDto.scope = task.scope.uri.toString();
-    } else if (typeof task.scope === 'number') {
+    if (typeof task.scope === 'number') {
         taskDto.scope = task.scope;
+    } else if (task.scope !== undefined) {
+        taskDto.scope = task.scope.uri.toString();
+    } else {
+        taskDto.scope = types.TaskScope.Workspace;
     }
 
     if (task.presentationOptions) {

package/src/plugin/types-impl.ts

@@ -1995,6 +1995,11 @@ export class DocumentSymbol {
     }
 }
 
+export enum CommentThreadState {
+    Unresolved = 0,
+    Resolved = 1
+}
+
 export enum CommentThreadCollapsibleState {
     Collapsed = 0,
     Expanded = 1
@@ -2734,13 +2739,12 @@ export namespace DebugAdapterInlineImplementation {
 export type DebugAdapterDescriptor = DebugAdapterExecutable | DebugAdapterServer | DebugAdapterNamedPipeServer | DebugAdapterInlineImplementation;
 
 export enum LogLevel {
+    Off = 0,
     Trace = 1,
     Debug = 2,
     Info = 3,
     Warning = 4,
-    Error = 5,
-    Critical = 6,
-    Off = 7
+    Error = 5
 }
 
 /**
@@ -3111,6 +3115,7 @@ export class TestRunRequest implements theia.TestRunRequest {
         public readonly include: theia.TestItem[] | undefined = undefined,
         public readonly exclude: theia.TestItem[] | undefined = undefined,
         public readonly profile: theia.TestRunProfile | undefined = undefined,
+        public readonly continuous: boolean | undefined = undefined,
     ) { }
 }