@theia/plugin-ext 1.27.0-next.9 → 1.27.0

package/src/plugin/node/debug/plugin-node-debug-adapter-creator.ts

@@ -0,0 +1,167 @@
+// *****************************************************************************
+// Copyright (C) 2022 Arm 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 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { PluginDebugAdapterCreator } from '../../debug/plugin-debug-adapter-creator';
+import * as path from 'path';
+import * as theia from '@theia/plugin';
+import { PlatformSpecificAdapterContribution, PluginPackageDebuggersContribution } from '../../../common';
+import { isWindows, isOSX } from '@theia/core/lib/common/os';
+import * as net from 'net';
+import { ChildProcess, spawn, fork, ForkOptions } from 'child_process';
+import { DebugAdapter } from '@theia/debug/lib/common/debug-model';
+import { DebugAdapterExecutable, DebugAdapterInlineImplementation, DebugAdapterNamedPipeServer, DebugAdapterServer } from '../../types-impl';
+import { ProcessDebugAdapter, SocketDebugAdapter } from '@theia/debug/lib/node/stream-debug-adapter';
+const isElectron = require('is-electron');
+
+export class NodeDebugAdapterCreator extends PluginDebugAdapterCreator {
+    public override async resolveDebugAdapterExecutable(
+        pluginPath: string,
+        debuggerContribution: PluginPackageDebuggersContribution
+    ): Promise<theia.DebugAdapterExecutable | undefined> {
+        const info = this.toPlatformInfo(debuggerContribution);
+        let program = (info && info.program || debuggerContribution.program);
+        if (!program) {
+            return undefined;
+        }
+        program = path.join(pluginPath, program);
+        const programArgs = info && info.args || debuggerContribution.args || [];
+        let runtime = info && info.runtime || debuggerContribution.runtime;
+        if (runtime && runtime.indexOf('./') === 0) {
+            runtime = path.join(pluginPath, runtime);
+        }
+        const runtimeArgs = info && info.runtimeArgs || debuggerContribution.runtimeArgs || [];
+        const command = runtime ? runtime : program;
+        const args = runtime ? [...runtimeArgs, program, ...programArgs] : programArgs;
+        return {
+            command,
+            args
+        };
+    }
+
+    public override async createDebugAdapter(
+        session: theia.DebugSession,
+        debugConfiguration: theia.DebugConfiguration,
+        executable: theia.DebugAdapterExecutable | undefined,
+        descriptorFactory: theia.DebugAdapterDescriptorFactory | undefined
+    ): Promise<DebugAdapter> {
+        if (descriptorFactory) {
+            // 'createDebugAdapterDescriptor' is called at the start of a debug session to provide details about the debug adapter to use.
+            // These details must be returned as objects of type [DebugAdapterDescriptor](#DebugAdapterDescriptor).
+            // Currently two types of debug adapters are supported:
+            // - a debug adapter executable is specified as a command path and arguments (see [DebugAdapterExecutable](#DebugAdapterExecutable)),
+            // - a debug adapter server reachable via a communication port (see [DebugAdapterServer](#DebugAdapterServer)).
+            // If the method is not implemented the default behavior is this:
+            //   createDebugAdapter(session: DebugSession, executable: DebugAdapterExecutable) {
+            //      if (typeof session.configuration.debugServer === 'number') {
+            //         return new DebugAdapterServer(session.configuration.debugServer);
+            //      }
+            //      return executable;
+            //   }
+            //  @param session The [debug session](#DebugSession) for which the debug adapter will be used.
+            //  @param executable The debug adapter's executable information as specified in the package.json (or undefined if no such information exists).
+            const descriptor = await descriptorFactory.createDebugAdapterDescriptor(session, executable);
+            if (descriptor) {
+                if (DebugAdapterServer.is(descriptor)) {
+                    return this.connectSocketDebugAdapter(descriptor);
+                } else if (DebugAdapterExecutable.is(descriptor)) {
+                    return this.startDebugAdapter(descriptor);
+                } else if (DebugAdapterNamedPipeServer.is(descriptor)) {
+                    return this.connectPipeDebugAdapter(descriptor);
+                } else if (DebugAdapterInlineImplementation.is(descriptor)) {
+                    return this.connectInlineDebugAdapter(descriptor);
+                }
+            }
+        }
+
+        if ('debugServer' in debugConfiguration) {
+            return this.connectSocketDebugAdapter({ port: debugConfiguration.debugServer });
+        } else {
+            if (!executable) {
+                throw new Error('It is not possible to provide debug adapter executable.');
+            }
+            return this.startDebugAdapter(executable);
+        }
+    }
+
+    protected toPlatformInfo(executable: PluginPackageDebuggersContribution): PlatformSpecificAdapterContribution | undefined {
+        if (isWindows && !process.env.hasOwnProperty('PROCESSOR_ARCHITEW6432')) {
+            return executable.winx86 || executable.win || executable.windows;
+        }
+        if (isWindows) {
+            return executable.win || executable.windows;
+        }
+        if (isOSX) {
+            return executable.osx;
+        }
+        return executable.linux;
+    }
+
+    public startDebugAdapter(executable: DebugAdapterExecutable): DebugAdapter {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const options: any = { stdio: ['pipe', 'pipe', 2] };
+
+        if (executable.options) {
+            options.cwd = executable.options.cwd;
+
+            // The additional environment of the executed program or shell. If omitted
+            // the parent process' environment is used. If provided it is merged with
+            // the parent process' environment.
+            options.env = Object.assign({}, process.env);
+            Object.assign(options.env, executable.options.env);
+        }
+
+        let childProcess: ChildProcess;
+        const { command, args } = executable;
+        if (command === 'node') {
+            if (Array.isArray(args) && args.length > 0) {
+                const forkOptions: ForkOptions = {
+                    env: options.env,
+                    // When running in Electron, fork will automatically add ELECTRON_RUN_AS_NODE=1 to the env,
+                    // but this will cause issues when debugging Electron apps, so we'll remove it.
+                    execArgv: isElectron()
+                        ? ['-e', 'delete process.env.ELECTRON_RUN_AS_NODE;require(process.argv[1])']
+                        : [],
+                    silent: true
+                };
+                if (options.cwd) {
+                    forkOptions.cwd = options.cwd;
+                }
+                options.stdio.push('ipc');
+                forkOptions.stdio = options.stdio;
+                childProcess = fork(args[0], args.slice(1), forkOptions);
+            } else {
+                throw new Error(`It is not possible to launch debug adapter with the command: ${JSON.stringify(executable)}`);
+            }
+        } else {
+            childProcess = spawn(command, args, options);
+        }
+
+        return new ProcessDebugAdapter(childProcess);
+    }
+
+    /**
+     * Connects to a remote debug server.
+     */
+    public connectSocketDebugAdapter(server: DebugAdapterServer): SocketDebugAdapter {
+        const socket = net.createConnection(server.port, server.host);
+        return new SocketDebugAdapter(socket);
+    }
+
+    public connectPipeDebugAdapter(adapter: DebugAdapterNamedPipeServer): SocketDebugAdapter {
+        const socket = net.createConnection(adapter.path);
+        return new SocketDebugAdapter(socket);
+    }
+}

package/src/plugin/plugin-context.ts

@@ -163,7 +163,7 @@ import { MarkdownString } from './markdown-string';
 import { TreeViewsExtImpl } from './tree/tree-views';
 import { ConnectionImpl } from '../common/connection';
 import { TasksExtImpl } from './tasks/tasks';
-import { DebugExtImpl } from './node/debug/debug';
+import { DebugExtImpl } from './debug/debug-ext';
 import { FileSystemExtImpl } from './file-system-ext-impl';
 import { QuickPick, QuickPickItem, ResourceLabelFormatter, LineChange } from '@theia/plugin';
 import { ScmExtImpl } from './scm';
@@ -811,7 +811,7 @@ export function createAPIFactory(
 
         const debuggersContributions = plugin.rawModel.contributes && plugin.rawModel.contributes.debuggers || [];
         debugExt.assistedInject(connectionExt, commandRegistry);
-        debugExt.registerDebuggersContributions(plugin.pluginFolder, debuggersContributions);
+        debugExt.registerDebuggersContributions(plugin.pluginFolder, plugin.model.entryPoint.frontend ? 'frontend' : 'backend', debuggersContributions);
         const debug: typeof theia.debug = {
             get activeDebugSession(): theia.DebugSession | undefined {
                 return debugExt.activeDebugSession;
@@ -991,7 +991,6 @@ export function createAPIFactory(
             TextDocumentSaveReason,
             CodeAction,
             TreeItem,
-            TreeItem2: TreeItem,
             TreeItemCollapsibleState,
             SymbolKind,
             SymbolTag,

package/src/plugin/plugin-manager.ts

@@ -240,10 +240,10 @@ export class PluginManagerExtImpl implements PluginManagerExt, PluginManager {
 
     protected registerPlugin(plugin: Plugin): void {
         if (plugin.model.id === 'vscode.json-language-features' && this.jsonValidation.length) {
-            // VS Code contribute all built-in validations via vscode.json-language-features
-            // we enrich them with Theia validations registered on the startup
-            // dynamic validations can be provided only via VS Code extensions
-            // content is fetched by the extension later via vscode.workspace.openTextDocument
+            // VS Code contributes all built-in validations via vscode.json-language-features;
+            // we enrich them with Theia validations registered on startup.
+            // Dynamic validations can be provided only via VS Code extensions.
+            // Content is fetched by the extension later via vscode.workspace.openTextDocument.
             const contributes = plugin.rawModel.contributes = (plugin.rawModel.contributes || {});
             contributes.jsonValidation = (contributes.jsonValidation || []).concat(this.jsonValidation);
         }
@@ -337,11 +337,7 @@ export class PluginManagerExtImpl implements PluginManagerExt, PluginManager {
     }
 
     protected async activateByBaseEvent(baseEvent: string): Promise<void> {
-        await Promise.all(Array.from(this.activations.keys(), activation => {
-            if (activation.startsWith(baseEvent)) {
-                return this.activateBySingleEvent(activation);
-            }
-        }));
+        await Promise.all(Array.from(this.activations.keys(), activation => activation.startsWith(baseEvent) && this.activateBySingleEvent(activation)));
     }
 
     protected async activateBySingleEvent(activationEvent: string): Promise<void> {

package/src/plugin/text-editor.ts

@@ -236,11 +236,11 @@ export class TextEditorExt implements theia.TextEditor {
 
         // prepare data for serialization
         const edits: SingleEditOperation[] = editData.edits.map(e =>
-            ({
-                range: Converter.fromRange(e.range)!,
-                text: e.text,
-                forceMoveMarkers: e.forceMoveMarkers
-            }));
+        ({
+            range: Converter.fromRange(e.range)!,
+            text: e.text,
+            forceMoveMarkers: e.forceMoveMarkers
+        }));
 
         return this.proxy.$tryApplyEdits(this.id, editData.documentVersionId, edits, {
             setEndOfLine: editData.setEndOfLine,
@@ -263,6 +263,17 @@ export class TextEditorExt implements theia.TextEditor {
             return undefined;
         });
     }
+
+    show(column?: theia.ViewColumn): void {
+        this.proxy.$tryShowTextDocument(this.document.uri, {
+            viewColumn: column,
+            preview: true,
+        });
+    }
+
+    hide(): void {
+        this.proxy.$tryHideEditor(this.id);
+    }
 }
 
 export class TextEditorOptionsExt implements theia.TextEditorOptions {

package/src/plugin/theming.ts

@@ -18,7 +18,7 @@ import { ColorTheme, ColorThemeKind } from './types-impl';
 import { Emitter, Event } from '@theia/core/lib/common/event';
 import { ThemingExt } from '../common';
 import { RPCProtocol } from '../common/rpc-protocol';
-import { ThemeType } from '@theia/core/lib/browser/theming';
+import { ThemeType } from '@theia/core/lib/common/theme';
 
 /*---------------------------------------------------------------------------------------------
  *  Copyright (c) Microsoft Corporation. All rights reserved.

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

@@ -17,7 +17,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
 import {
-    TreeDataProvider, TreeView, TreeViewExpansionEvent, TreeItem2, TreeItemLabel,
+    TreeDataProvider, TreeView, TreeViewExpansionEvent, TreeItem, TreeItemLabel,
     TreeViewSelectionChangeEvent, TreeViewVisibilityChangeEvent
 } from '@theia/plugin';
 // TODO: extract `@theia/util` for event, disposable, cancellation and common types
@@ -295,16 +295,17 @@ class TreeViewExtImpl<T> implements Disposable {
         return undefined;
     }
 
-    private getTreeItemLabel(treeItem: TreeItem2): string | undefined {
+    private getTreeItemLabel(treeItem: TreeItem): string | undefined {
         const treeItemLabel: string | TreeItemLabel | undefined = treeItem.label;
-        if (typeof treeItemLabel === 'object' && typeof treeItemLabel.label === 'string') {
-            return treeItemLabel.label;
-        } else {
-            return treeItem.label;
-        }
+        return typeof treeItemLabel === 'object' ? treeItemLabel.label : treeItemLabel;
+    }
+
+    private getTreeItemLabelHighlights(treeItem: TreeItem): [number, number][] | undefined {
+        const treeItemLabel: string | TreeItemLabel | undefined = treeItem.label;
+        return typeof treeItemLabel === 'object' ? treeItemLabel.highlights : undefined;
     }
 
-    private getTreeItemIdLabel(treeItem: TreeItem2): string | undefined {
+    private getTreeItemIdLabel(treeItem: TreeItem): string | undefined {
         let idLabel = this.getTreeItemLabel(treeItem);
         // Use resource URI if label is not set
         if (idLabel === undefined && treeItem.resourceUri) {
@@ -341,10 +342,11 @@ class TreeViewExtImpl<T> implements Disposable {
 
                 // Ask data provider for a tree item for the value
                 // Data provider must return theia.TreeItem
-                const treeItem: TreeItem2 = await this.treeDataProvider.getTreeItem(value);
+                const treeItem = await this.treeDataProvider.getTreeItem(value);
                 // Convert theia.TreeItem to the TreeViewItem
 
                 const label = this.getTreeItemLabel(treeItem);
+                const highlights = this.getTreeItemLabelHighlights(treeItem);
                 const idLabel = this.getTreeItemIdLabel(treeItem);
 
                 // Generate the ID
@@ -366,12 +368,12 @@ class TreeViewExtImpl<T> implements Disposable {
 
                 let icon;
                 let iconUrl;
-                let themeIconId;
+                let themeIcon;
                 const { iconPath } = treeItem;
                 if (typeof iconPath === 'string' && iconPath.indexOf('fa-') !== -1) {
                     icon = iconPath;
                 } else if (ThemeIcon.is(iconPath)) {
-                    themeIconId = iconPath.id;
+                    themeIcon = iconPath;
                 } else {
                     iconUrl = PluginIconPath.toUrl(<PluginIconPath | undefined>iconPath, this.plugin);
                 }
@@ -379,9 +381,10 @@ class TreeViewExtImpl<T> implements Disposable {
                 const treeViewItem = {
                     id,
                     label,
+                    highlights,
                     icon,
                     iconUrl,
-                    themeIconId,
+                    themeIcon,
                     description: treeItem.description,
                     resourceUri: treeItem.resourceUri,
                     tooltip: treeItem.tooltip,

package/src/plugin/types-impl.ts

@@ -732,7 +732,7 @@ export class ThemeIcon {
 
     static readonly Folder: ThemeIcon = new ThemeIcon('folder');
 
-    private constructor(public id: string) {
+    private constructor(public id: string, public color?: ThemeColor) {
     }
 
 }

package/lib/main/browser/custom-editors/glob.d.ts

@@ -1,51 +0,0 @@
-export interface IExpression {
-    [pattern: string]: boolean | SiblingClause | any;
-}
-export interface IRelativePattern {
-    base: string;
-    pattern: string;
-    pathToRelative(from: string, to: string): string;
-}
-export declare function getEmptyExpression(): IExpression;
-export interface SiblingClause {
-    when: string;
-}
-export declare function splitGlobAware(pattern: string, splitChar: string): string[];
-export declare type ParsedPattern = (path: string, basename?: string) => boolean;
-export declare type ParsedExpression = (path: string, basename?: string, hasSibling?: (name: string) => boolean | Promise<boolean>) => string | Promise<string>;
-export interface IGlobOptions {
-    /**
-     * Simplify patterns for use as exclusion filters during tree traversal to skip entire subtrees. Cannot be used outside of a tree traversal.
-     */
-    trimForExclusions?: boolean;
-}
-/**
- * Simplified glob matching. Supports a subset of glob patterns:
- * - * matches anything inside a path segment
- * - ? matches 1 character inside a path segment
- * - ** matches anything including an empty path segment
- * - simple brace expansion ({js,ts} => js or ts)
- * - character ranges (using [...])
- */
-export declare function match(pattern: string | IRelativePattern, path: string): boolean;
-export declare function match(expression: IExpression, path: string, hasSibling?: (name: string) => boolean): string;
-/**
- * Simplified glob matching. Supports a subset of glob patterns:
- * - * matches anything inside a path segment
- * - ? matches 1 character inside a path segment
- * - ** matches anything including an empty path segment
- * - simple brace expansion ({js,ts} => js or ts)
- * - character ranges (using [...])
- */
-export declare function parse(pattern: string | IRelativePattern, options?: IGlobOptions): ParsedPattern;
-export declare function parse(expression: IExpression, options?: IGlobOptions): ParsedExpression;
-export declare function hasSiblingPromiseFn(siblingsFn?: () => Promise<string[]>): ((name: string) => Promise<boolean>) | undefined;
-export declare function hasSiblingFn(siblingsFn?: () => string[]): ((name: string) => boolean) | undefined;
-export declare function isRelativePattern(obj: any): obj is IRelativePattern;
-/**
- * Same as `parse`, but the ParsedExpression is guaranteed to return a Promise
- */
-export declare function parseToAsync(expression: IExpression, options?: IGlobOptions): ParsedExpression;
-export declare function getBasenameTerms(patternOrExpression: ParsedPattern | ParsedExpression): string[];
-export declare function getPathTerms(patternOrExpression: ParsedPattern | ParsedExpression): string[];
-//# sourceMappingURL=glob.d.ts.map

package/lib/main/browser/custom-editors/glob.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"glob.d.ts","sourceRoot":"","sources":["../../../../src/main/browser/custom-editors/glob.ts"],"names":[],"mappings":"AA4BA,MAAM,WAAW,WAAW;IAExB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,GAAG,aAAa,GAAG,GAAG,CAAC;CACpD;AAED,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC;CACpD;AAED,wBAAgB,kBAAkB,IAAI,WAAW,CAEhD;AAED,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,MAAM,CAAC;CAChB;AAsBD,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,CA+C3E;AA2JD,oBAAY,aAAa,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC;AAIzE,oBAAY,gBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAA4B;AAEnL,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B;AA+KD;;;;;;;GAOG;AACH,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;AACjF,wBAAgB,KAAK,CAAC,UAAU,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,GAAG,MAAM,CAA4B;AAUxI;;;;;;;GAOG;AACH,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,gBAAgB,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC;AACjG,wBAAgB,KAAK,CAAC,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,gBAAgB,CAAC;AA+BzF,wBAAgB,mBAAmB,CAAC,UAAU,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,SAAS,CAa1H;AAED,wBAAgB,YAAY,CAAC,UAAU,CAAC,EAAE,MAAM,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,SAAS,CAajG;AAWD,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,gBAAgB,CAInE;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,gBAAgB,CAO9F;AAED,wBAAgB,gBAAgB,CAAC,mBAAmB,EAAE,aAAa,GAAG,gBAAgB,GAAG,MAAM,EAAE,CAEhG;AAED,wBAAgB,YAAY,CAAC,mBAAmB,EAAE,aAAa,GAAG,gBAAgB,GAAG,MAAM,EAAE,CAE5F"}