@theia/plugin-ext 1.43.0 → 1.44.0

package/src/main/browser/webview/pre/main.js

@@ -144,40 +144,65 @@
      * @param {*} [state]
      * @return {string}
      */
-    function getVsCodeApiScript(state) {
+    function getDefaultScript(state) {
         return `
-        const acquireVsCodeApi = (function() {
-            const originalPostMessage = window.parent.postMessage.bind(window.parent);
-            const targetOrigin = '*';
-            let acquired = false;
+const acquireVsCodeApi = (function() {
+    const originalPostMessage = window.parent.postMessage.bind(window.parent);
+    const originalConsole = {...console};
+    const targetOrigin = '*';
+    let acquired = false;
+
+    let state = ${state ? `JSON.parse(${JSON.stringify(state)})` : undefined};
+
+    const forwardConsoleLog = (level, msg, args) => {
+        let message, optionalParams;
+        try {
+            if (msg) {
+                message = JSON.stringify(msg) ?? null;
+            }
+            if (args) {
+                optionalParams = JSON.stringify(args) ?? null;
+            }
+        } catch (e) {
+            // Log non serializable objects inside of view
+            originalConsole[level](msg, args);
+            return;
+        }
+        originalPostMessage({ command: 'onconsole', data: { level, message, optionalParams } }, targetOrigin);
+    };
 
-            let state = ${state ? `JSON.parse(${JSON.stringify(state)})` : undefined};
+    console.log = (message, args) => forwardConsoleLog('log', message, args);
+    console.info = (message, args) => forwardConsoleLog('info', message, args);
+    console.warn = (message, args) => forwardConsoleLog('warn', message, args);
+    console.error = (message, args) => forwardConsoleLog('error', message, args);
+    console.debug = (message, args) => forwardConsoleLog('debug', message, args);
+    console.trace = (message, args) => forwardConsoleLog('trace', message, args);
 
-            return () => {
-                if (acquired) {
-                    throw new Error('An instance of the VS Code API has already been acquired');
-                }
-                acquired = true;
-                return Object.freeze({
-                    postMessage: function(msg) {
-                        return originalPostMessage({ command: 'onmessage', data: msg }, targetOrigin);
-                    },
-                    setState: function(newState) {
-                        state = newState;
-                        originalPostMessage({ command: 'do-update-state', data: JSON.stringify(newState) }, targetOrigin);
-                        return newState;
-                    },
-                    getState: function() {
-                        return state;
-                    }
-                });
-            };
-        })();
-        const acquireTheiaApi = acquireVsCodeApi;
-        delete window.parent;
-        delete window.top;
-        delete window.frameElement;
-        `;
+    return () => {
+        if (acquired) {
+            throw new Error('An instance of the VS Code API has already been acquired');
+        }
+        acquired = true;
+        return Object.freeze({
+            postMessage: function (msg) {
+                return originalPostMessage({ command: 'onmessage', data: msg }, targetOrigin);
+            },
+            setState: function (newState) {
+                state = newState;
+                originalPostMessage({ command: 'do-update-state', data: JSON.stringify(newState) }, targetOrigin);
+                return newState;
+            },
+            getState: function () {
+                return state;
+            }
+        });
+    };
+})();
+const acquireTheiaApi = acquireVsCodeApi;
+delete window.parent;
+delete window.top;
+delete window.frameElement;        
+`;
     }
 
     /**
@@ -369,7 +394,7 @@
             // apply default script
             if (options.allowScripts) {
                 const defaultScript = newDocument.createElement('script');
-                defaultScript.textContent = getVsCodeApiScript(data.state);
+                defaultScript.textContent = getDefaultScript(data.state);
                 newDocument.head.prepend(defaultScript);
             }
 

package/src/main/browser/webview/webview.ts

@@ -69,7 +69,8 @@ export const enum WebviewMessageChannels {
     webviewReady = 'webview-ready',
     didKeydown = 'did-keydown',
     didMouseDown = 'did-mousedown',
-    didMouseUp = 'did-mouseup'
+    didMouseUp = 'did-mouseup',
+    onconsole = 'onconsole'
 }
 
 export interface WebviewContentOptions {
@@ -80,6 +81,12 @@ export interface WebviewContentOptions {
     readonly enableCommandUris?: boolean | readonly string[];
 }
 
+export interface WebviewConsoleLog {
+    level: Extract<keyof typeof console, 'log' | 'info' | 'warn' | 'error' | 'trace' | 'debug'>;
+    message?: string;
+    optionalParams?: string;
+}
+
 @injectable()
 export class WebviewWidgetIdentifier {
     id: string;
@@ -318,6 +325,7 @@ export class WebviewWidget extends BaseWidget implements StatefulWidget, Extract
         this.toHide.push(subscription);
 
         this.toHide.push(this.on(WebviewMessageChannels.onmessage, (data: any) => this.onMessageEmitter.fire(data)));
+        this.toHide.push(this.on(WebviewMessageChannels.onconsole, (data: WebviewConsoleLog) => this.forwardConsoleLog(data)));
         this.toHide.push(this.on(WebviewMessageChannels.didClickLink, (uri: string) => this.openLink(new URI(uri))));
         this.toHide.push(this.on(WebviewMessageChannels.doUpdateState, (state: any) => {
             this._state = state;
@@ -462,6 +470,15 @@ export class WebviewWidget extends BaseWidget implements StatefulWidget, Extract
         this.doUpdateContent();
     }
 
+    protected forwardConsoleLog(log: WebviewConsoleLog): void {
+        const message = `[webview: ${this.identifier.id}] ${log.message ? JSON.parse(log.message) : undefined}`;
+        if (log.optionalParams !== undefined) {
+            console[log.level](message, JSON.parse(log.optionalParams));
+        } else {
+            console[log.level](message);
+        }
+    }
+
     protected style(): void {
         const { styles, activeThemeType, activeThemeName } = this.themeDataProvider.getThemeData();
         this.doSend('styles', { styles, activeThemeType, activeThemeName });

package/src/main/node/plugin-deployer-contribution.ts

@@ -28,7 +28,7 @@ export class PluginDeployerContribution implements BackendApplicationContributio
     @inject(PluginDeployer)
     protected pluginDeployer: PluginDeployer;
 
-    initialize(): void {
-        this.pluginDeployer.start();
+    initialize(): Promise<void> {
+        return this.pluginDeployer.start();
     }
 }

package/src/main/node/plugin-deployer-impl.ts

@@ -75,9 +75,9 @@ export class PluginDeployerImpl implements PluginDeployer {
     @inject(ContributionProvider) @named(PluginDeployerParticipant)
     protected readonly participants: ContributionProvider<PluginDeployerParticipant>;
 
-    public start(): void {
+    public start(): Promise<void> {
         this.logger.debug('Starting the deployer with the list of resolvers', this.pluginResolvers);
-        this.doStart();
+        return this.doStart();
     }
 
     public async initResolvers(): Promise<Array<void>> {

package/src/main/node/plugin-ext-backend-module.ts

@@ -41,6 +41,7 @@ import { WebviewBackendSecurityWarnings } from './webview-backend-security-warni
 import { PluginUninstallationManager } from './plugin-uninstallation-manager';
 import { LocalizationServerImpl } from '@theia/core/lib/node/i18n/localization-server';
 import { PluginLocalizationServer } from './plugin-localization-server';
+import { PluginMgmtCliContribution } from './plugin-mgmt-cli-contribution';
 
 export function bindMainBackend(bind: interfaces.Bind, unbind: interfaces.Unbind, isBound: interfaces.IsBound, rebind: interfaces.Rebind): void {
     bind(PluginApiContribution).toSelf().inSingletonScope();
@@ -85,6 +86,9 @@ export function bindMainBackend(bind: interfaces.Bind, unbind: interfaces.Unbind
     bind(PluginCliContribution).toSelf().inSingletonScope();
     bind(CliContribution).toService(PluginCliContribution);
 
+    bind(PluginMgmtCliContribution).toSelf().inSingletonScope();
+    bind(CliContribution).toService(PluginMgmtCliContribution);
+
     bind(WebviewBackendSecurityWarnings).toSelf().inSingletonScope();
     bind(BackendApplicationContribution).toService(WebviewBackendSecurityWarnings);
 

package/src/main/node/plugin-mgmt-cli-contribution.ts

@@ -0,0 +1,64 @@
+// *****************************************************************************
+// Copyright (C) 2023 STMicroelectronics and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { inject, injectable } from '@theia/core/shared/inversify';
+import { Argv, Arguments } from '@theia/core/shared/yargs';
+import { CliContribution } from '@theia/core/lib/node/cli';
+import { HostedPluginDeployerHandler } from '../../hosted/node/hosted-plugin-deployer-handler';
+import { PluginType } from '../../common';
+
+@injectable()
+export class PluginMgmtCliContribution implements CliContribution {
+
+    static LIST_PLUGINS = 'list-plugins';
+    static SHOW_VERSIONS = '--show-versions';
+    static SHOW_BUILTINS = '--show-builtins';
+
+    @inject(HostedPluginDeployerHandler)
+    protected deployerHandler: HostedPluginDeployerHandler;
+
+    configure(conf: Argv): void {
+        conf.command([PluginMgmtCliContribution.LIST_PLUGINS, 'list-extensions'],
+            'List the installed plugins',
+            yargs => yargs.option(PluginMgmtCliContribution.SHOW_VERSIONS, {
+                description: 'List the versions of the installed plugins',
+                type: 'boolean',
+                default: false,
+            }).option(PluginMgmtCliContribution.SHOW_BUILTINS, {
+                description: 'List the built-in plugins',
+                type: 'boolean',
+                default: false,
+            }),
+
+            async yargs => {
+                const showVersions = yargs[PluginMgmtCliContribution.SHOW_VERSIONS];
+                const deployedIds = await this.deployerHandler.getDeployedBackendPlugins();
+                const pluginType = yargs[PluginMgmtCliContribution.SHOW_BUILTINS] ? PluginType.System : PluginType.User;
+                process.stdout.write('installed plugins:\n');
+                deployedIds.filter(plugin => plugin.type === pluginType).forEach(plugin => {
+                    if (showVersions) {
+                        process.stdout.write(`${plugin.metadata.model.id}@${plugin.metadata.model.version}\n`);
+                    } else {
+                        process.stdout.write(`${plugin.metadata.model.id}\n`);
+                    }
+                });
+            }
+        );
+    }
+
+    setArguments(args: Arguments): void {
+    }
+}

package/src/plugin/env.ts

@@ -25,7 +25,6 @@ export abstract class EnvExtImpl {
     private queryParameters: QueryParameters;
     private lang: string;
     private applicationName: string;
-    private defaultShell: string;
     private ui: theia.UIKind;
     private envMachineId: string;
     private envSessionId: string;
@@ -68,10 +67,6 @@ export abstract class EnvExtImpl {
         this.lang = lang;
     }
 
-    setShell(shell: string): void {
-        this.defaultShell = shell;
-    }
-
     setUIKind(uiKind: theia.UIKind): void {
         this.ui = uiKind;
     }
@@ -112,9 +107,6 @@ export abstract class EnvExtImpl {
     get uriScheme(): string {
         return 'theia';
     }
-    get shell(): string {
-        return this.defaultShell;
-    }
     get uiKind(): theia.UIKind {
         return this.ui;
     }

package/src/plugin/languages-utils.ts

@@ -15,7 +15,8 @@
 // *****************************************************************************
 
 import * as theia from '@theia/plugin';
-import { SerializedIndentationRule, SerializedOnEnterRule, SerializedRegExp } from '../common';
+import { SerializedAutoClosingPair, SerializedIndentationRule, SerializedOnEnterRule, SerializedRegExp } from '../common';
+import { SyntaxTokenType } from './types-impl';
 
 export function serializeEnterRules(rules?: theia.OnEnterRule[]): SerializedOnEnterRule[] | undefined {
     if (typeof rules === 'undefined' || rules === null) {
@@ -54,3 +55,14 @@ export function serializeIndentation(indentationRules?: theia.IndentationRule):
         unIndentedLinePattern: serializeRegExp(indentationRules.unIndentedLinePattern)
     };
 }
+
+export function serializeAutoClosingPairs(pairs: theia.AutoClosingPair[] | undefined): SerializedAutoClosingPair[] | undefined {
+    if (!pairs) {
+        return undefined;
+    };
+    return pairs.map(pair => ({
+        open: pair.open,
+        close: pair.close,
+        notIn: pair.notIn ? pair.notIn.map(tokenType => SyntaxTokenType.toString(tokenType)) : undefined
+    }));
+}

package/src/plugin/languages.ts

@@ -108,7 +108,7 @@ import { isReadonlyArray } from '../common/arrays';
 import { DisposableCollection, disposableTimeout, Disposable as TheiaDisposable } from '@theia/core/lib/common/disposable';
 import { Severity } from '@theia/core/lib/common/severity';
 import { LinkedEditingRangeAdapter } from './languages/linked-editing-range';
-import { serializeEnterRules, serializeIndentation, serializeRegExp } from './languages-utils';
+import { serializeAutoClosingPairs, serializeEnterRules, serializeIndentation, serializeRegExp } from './languages-utils';
 import { InlayHintsAdapter } from './languages/inlay-hints';
 import { InlineCompletionAdapter, InlineCompletionAdapterBase } from './languages/inline-completion';
 import { DocumentDropEditAdapter } from './languages/document-drop-edit';
@@ -208,7 +208,8 @@ export class LanguagesExtImpl implements LanguagesExt {
             comments: configuration.comments,
             onEnterRules: serializeEnterRules(configuration.onEnterRules),
             wordPattern: serializeRegExp(configuration.wordPattern),
-            indentationRules: serializeIndentation(configuration.indentationRules)
+            indentationRules: serializeIndentation(configuration.indentationRules),
+            autoClosingPairs: serializeAutoClosingPairs(configuration.autoClosingPairs)
         };
 
         this.proxy.$setLanguageConfiguration(callId, language, config);

package/src/plugin/plugin-context.ts

@@ -57,6 +57,7 @@ import {
     StatusBarAlignment,
     RelativePattern,
     IndentAction,
+    SyntaxTokenType,
     CompletionItem,
     CompletionItemKind,
     CompletionList,
@@ -796,7 +797,10 @@ export function createAPIFactory(
             get machineId(): string { return envExt.machineId; },
             get sessionId(): string { return envExt.sessionId; },
             get uriScheme(): string { return envExt.uriScheme; },
-            get shell(): string { return envExt.shell; },
+            get shell(): string { return terminalExt.defaultShell; },
+            get onDidChangeShell(): theia.Event<string> {
+                return terminalExt.onDidChangeShell;
+            },
             get uiKind(): theia.UIKind { return envExt.uiKind; },
             clipboard,
             getEnvVariable(envVarName: string): PromiseLike<string | undefined> {
@@ -1225,6 +1229,7 @@ export function createAPIFactory(
             ConfigurationTarget,
             RelativePattern,
             IndentAction,
+            SyntaxTokenType,
             CompletionItem,
             CompletionItemKind,
             CompletionList,

package/src/plugin/plugin-manager.ts

@@ -206,7 +206,7 @@ export class PluginManagerExtImpl implements PluginManagerExt, PluginManager {
 
         this.envExt.setQueryParameters(params.env.queryParams);
         this.envExt.setLanguage(params.env.language);
-        this.envExt.setShell(params.env.shell);
+        this.terminalService.$setShell(params.env.shell);
         this.envExt.setUIKind(params.env.uiKind);
         this.envExt.setApplicationName(params.env.appName);
         this.envExt.setAppHost(params.env.appHost);

package/src/plugin/status-bar/status-bar-item.ts

@@ -40,7 +40,7 @@ export class StatusBarItemImpl implements theia.StatusBarItem {
     private _accessibilityInformation: theia.AccessibilityInformation;
 
     private _isVisible: boolean;
-    private _timeoutHandle: NodeJS.Timer | undefined;
+    private _timeoutHandle: NodeJS.Timeout | undefined;
 
     _proxy: StatusBarMessageRegistryMain;
 

package/src/plugin/terminal-ext.ts

@@ -71,6 +71,10 @@ export class TerminalServiceExtImpl implements TerminalServiceExt {
 
     protected environmentVariableCollections: MultiKeyMap<string, EnvironmentVariableCollectionImpl> = new MultiKeyMap(2);
 
+    private shell: string;
+    private readonly onDidChangeShellEmitter = new Emitter<string>();
+    readonly onDidChangeShell: theia.Event<string> = this.onDidChangeShellEmitter.event;
+
     constructor(rpc: RPCProtocol) {
         this.proxy = rpc.getProxy(PLUGIN_RPC_CONTEXT.TERMINAL_MAIN);
     }
@@ -79,6 +83,17 @@ export class TerminalServiceExtImpl implements TerminalServiceExt {
         return [...this._terminals.values()];
     }
 
+    get defaultShell(): string {
+        return this.shell || '';
+    }
+
+    async $setShell(shell: string): Promise<void> {
+        if (this.shell !== shell) {
+            this.shell = shell;
+            this.onDidChangeShellEmitter.fire(shell);
+        }
+    }
+
     createTerminal(
         nameOrOptions: TerminalOptions | PseudoTerminalOptions | ExtensionTerminalOptions | (string | undefined),
         shellPath?: string, shellArgs?: string[] | string

package/src/plugin/text-editor.ts

@@ -277,7 +277,8 @@ export class TextEditorExt implements theia.TextEditor {
 }
 
 export class TextEditorOptionsExt implements theia.TextEditorOptions {
-    private _tabSize?: number;
+    private _tabSize: number;
+    private _indentSize: number | 'tabSize';
     private _insertSpace: boolean;
     private _cursorStyle: TextEditorCursorStyle;
     private _lineNumbers: TextEditorLineNumbersStyle;
@@ -289,12 +290,13 @@ export class TextEditorOptionsExt implements theia.TextEditorOptions {
 
     accept(source: TextEditorConfiguration): void {
         this._tabSize = source.tabSize;
+        this._indentSize = source.indentSize;
         this._insertSpace = source.insertSpaces;
         this._cursorStyle = source.cursorStyle;
         this._lineNumbers = source.lineNumbers;
     }
 
-    get tabSize(): number | string | undefined {
+    get tabSize(): number {
         return this._tabSize;
     }
 
@@ -305,10 +307,10 @@ export class TextEditorOptionsExt implements theia.TextEditorOptions {
         }
 
         if (typeof tabSize === 'number') {
-            if (this.tabSize === tabSize) {
+            if (this._tabSize === tabSize) {
                 return;
             }
-            this.tabSize = tabSize;
+            this._tabSize = tabSize;
         }
         warnOnError(this.proxy.$trySetOptions(this.id, {
             tabSize
@@ -334,6 +336,51 @@ export class TextEditorOptionsExt implements theia.TextEditorOptions {
         return undefined;
     }
 
+    get indentSize(): number {
+        if (this._indentSize === 'tabSize') {
+            return this.tabSize;
+        }
+        return this._indentSize;
+    }
+
+    set indentSize(val: number | string | undefined) {
+        const indentSize = this.validateIndentSize(val);
+        if (!indentSize) {
+            return; // ignore invalid values
+        }
+
+        if (typeof indentSize === 'number') {
+            if (this._indentSize === indentSize) {
+                return;
+            }
+            this._indentSize = indentSize;
+        } else if (val === 'tabSize') {
+            this._indentSize = val;
+        }
+        warnOnError(this.proxy.$trySetOptions(this.id, {
+            indentSize
+        }));
+    }
+
+    private validateIndentSize(val: number | string | undefined): number | 'tabSize' | undefined {
+        if (val === 'tabSize') {
+            return 'tabSize';
+        }
+
+        if (typeof val === 'number') {
+            const r = Math.floor(val);
+            return r > 0 ? r : undefined;
+        }
+        if (typeof val === 'string') {
+            const r = parseInt(val, undefined);
+            if (isNaN(r)) {
+                return undefined;
+            }
+            return r > 0 ? r : undefined;
+        }
+        return undefined;
+    }
+
     get insertSpaces(): boolean | string {
         return this._insertSpace;
     }
@@ -395,6 +442,19 @@ export class TextEditorOptionsExt implements theia.TextEditorOptions {
             }
         }
 
+        if (typeof newOptions.indentSize !== 'undefined') {
+            const indentSize = this.validateIndentSize(newOptions.indentSize);
+            if (indentSize === 'tabSize') {
+                hasUpdate = true;
+                configurationUpdate.indentSize = indentSize;
+            } else if (typeof indentSize === 'number' && this._indentSize !== indentSize) {
+                // reflect the new indentSize value immediately
+                this._indentSize = indentSize;
+                hasUpdate = true;
+                configurationUpdate.indentSize = indentSize;
+            }
+        }
+
         if (typeof newOptions.insertSpaces !== 'undefined') {
             const insertSpaces = this.validateInsertSpaces(newOptions.insertSpaces);
             if (insertSpaces === 'auto') {

package/src/plugin/types-impl.ts

@@ -845,6 +845,37 @@ export enum IndentAction {
     Outdent = 3
 }
 
+export namespace SyntaxTokenType {
+    export function toString(v: SyntaxTokenType | unknown): 'other' | 'comment' | 'string' | 'regex' {
+        switch (v) {
+            case SyntaxTokenType.Other: return 'other';
+            case SyntaxTokenType.Comment: return 'comment';
+            case SyntaxTokenType.String: return 'string';
+            case SyntaxTokenType.RegEx: return 'regex';
+        }
+        return 'other';
+    }
+}
+
+export enum SyntaxTokenType {
+    /**
+     * Everything except tokens that are part of comments, string literals and regular expressions.
+     */
+    Other = 0,
+    /**
+     * A comment.
+     */
+    Comment = 1,
+    /**
+     * A string literal.
+     */
+    String = 2,
+    /**
+     * A regular expression.
+     */
+    RegEx = 3
+}
+
 @es5ClassCompat
 export class TextEdit {
 
@@ -1657,6 +1688,7 @@ export class CodeActionKind {
     public static readonly Source = CodeActionKind.Empty.append('source');
     public static readonly SourceOrganizeImports = CodeActionKind.Source.append('organizeImports');
     public static readonly SourceFixAll = CodeActionKind.Source.append('fixAll');
+    public static readonly Notebook = CodeActionKind.Empty.append('notebook');
 
     constructor(
         public readonly value: string