@theia/plugin-ext-vscode 1.53.0-next.55 → 1.53.0-next.64

package/src/node/scanner-vscode.ts

@@ -1,113 +1,113 @@
-// *****************************************************************************
-// Copyright (C) 2015-2021 Red Hat, Inc.
-//
-// 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 * as path from 'path';
-import { injectable } from '@theia/core/shared/inversify';
-import { PluginScanner, PluginEngine, PluginPackage, PluginModel, PluginLifecycle, PluginEntryPoint, buildFrontendModuleName, UIKind, PluginIdentifiers } from '@theia/plugin-ext';
-import { TheiaPluginScanner } from '@theia/plugin-ext/lib/hosted/node/scanners/scanner-theia';
-import { environment } from '@theia/core/shared/@theia/application-package/lib/environment';
-import { VSCodeExtensionUri } from '../common/plugin-vscode-uri';
-
-const uiKind = environment.electron.is() ? UIKind.Desktop : UIKind.Web;
-
-@injectable()
-export class VsCodePluginScanner extends TheiaPluginScanner implements PluginScanner {
-
-    private readonly VSCODE_TYPE: PluginEngine = 'vscode';
-
-    override get apiType(): PluginEngine {
-        return this.VSCODE_TYPE;
-    }
-
-    override getModel(plugin: PluginPackage): PluginModel {
-        // publisher can be empty on vscode extension development
-        const publisher = plugin.publisher ?? PluginIdentifiers.UNPUBLISHED;
-
-        // Only one entrypoint is valid in vscode extensions
-        // Mimic choosing frontend (web extension) and backend (local/remote extension) as described here:
-        // https://code.visualstudio.com/api/advanced-topics/extension-host#preferred-extension-location
-        const entryPoint: PluginEntryPoint = {};
-
-        // Act like codespaces when run in the browser (UIKind === 'web' and extensionKind is ['ui'])
-        const preferFrontend = uiKind === UIKind.Web && (plugin.extensionKind?.length === 1 && plugin.extensionKind[0] === 'ui');
-
-        if (plugin.browser && (!plugin.main || preferFrontend)) {
-            // Use frontend if available and there is no backend or frontend is preferred
-            entryPoint.frontend = plugin.browser;
-        } else {
-            // Default to using backend
-            entryPoint.backend = plugin.main;
-        }
-        if (plugin.theiaPlugin?.headless) {
-            // Support the Theia-specific extension for headless plugins
-            entryPoint.headless = plugin.theiaPlugin?.headless;
-        }
-
-        const result: PluginModel = {
-            packagePath: plugin.packagePath,
-            packageUri: this.pluginUriFactory.createUri(plugin).toString(),
-            // see id definition: https://github.com/microsoft/vscode/blob/15916055fe0cb9411a5f36119b3b012458fe0a1d/src/vs/platform/extensions/common/extensions.ts#L167-L169
-            id: `${publisher.toLowerCase()}.${plugin.name.toLowerCase()}`,
-            name: plugin.name,
-            publisher: publisher,
-            version: plugin.version,
-            displayName: plugin.displayName,
-            description: plugin.description,
-            engine: {
-                type: this.VSCODE_TYPE,
-                version: plugin.engines[this.VSCODE_TYPE]
-            },
-            entryPoint,
-            iconUrl: plugin.icon && PluginPackage.toPluginUrl(plugin, plugin.icon),
-            l10n: plugin.l10n,
-            readmeUrl: PluginPackage.toPluginUrl(plugin, './README.md'),
-            licenseUrl: PluginPackage.toPluginUrl(plugin, './LICENSE')
-        };
-        return result;
-    }
-
-    /**
-     * Maps extension dependencies to deployable extension dependencies.
-     */
-    override getDependencies(plugin: PluginPackage): Map<string, string> | undefined {
-        // Store the list of dependencies.
-        const dependencies = new Map<string, string>();
-        // Iterate through the list of dependencies from `extensionDependencies` and `extensionPack`.
-        for (const dependency of [plugin.extensionDependencies, plugin.extensionPack]) {
-            if (dependency !== undefined) {
-                // Iterate over the list of dependencies present, and add them to the collection.
-                dependency.forEach((dep: string) => {
-                    const dependencyId = dep.toLowerCase();
-                    dependencies.set(dependencyId, VSCodeExtensionUri.fromId(dependencyId).toString());
-                });
-            }
-        }
-        // Return the map of dependencies if present, else `undefined`.
-        return dependencies.size > 0 ? dependencies : undefined;
-    }
-
-    override getLifecycle(plugin: PluginPackage): PluginLifecycle {
-        return {
-            startMethod: 'activate',
-            stopMethod: 'deactivate',
-            frontendModuleName: buildFrontendModuleName(plugin),
-
-            frontendInitPath: 'plugin-vscode-init-fe.js',
-            backendInitPath: path.join(__dirname, 'plugin-vscode-init'),
-        };
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2015-2021 Red Hat, Inc.
+//
+// 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 * as path from 'path';
+import { injectable } from '@theia/core/shared/inversify';
+import { PluginScanner, PluginEngine, PluginPackage, PluginModel, PluginLifecycle, PluginEntryPoint, buildFrontendModuleName, UIKind, PluginIdentifiers } from '@theia/plugin-ext';
+import { TheiaPluginScanner } from '@theia/plugin-ext/lib/hosted/node/scanners/scanner-theia';
+import { environment } from '@theia/core/shared/@theia/application-package/lib/environment';
+import { VSCodeExtensionUri } from '../common/plugin-vscode-uri';
+
+const uiKind = environment.electron.is() ? UIKind.Desktop : UIKind.Web;
+
+@injectable()
+export class VsCodePluginScanner extends TheiaPluginScanner implements PluginScanner {
+
+    private readonly VSCODE_TYPE: PluginEngine = 'vscode';
+
+    override get apiType(): PluginEngine {
+        return this.VSCODE_TYPE;
+    }
+
+    override getModel(plugin: PluginPackage): PluginModel {
+        // publisher can be empty on vscode extension development
+        const publisher = plugin.publisher ?? PluginIdentifiers.UNPUBLISHED;
+
+        // Only one entrypoint is valid in vscode extensions
+        // Mimic choosing frontend (web extension) and backend (local/remote extension) as described here:
+        // https://code.visualstudio.com/api/advanced-topics/extension-host#preferred-extension-location
+        const entryPoint: PluginEntryPoint = {};
+
+        // Act like codespaces when run in the browser (UIKind === 'web' and extensionKind is ['ui'])
+        const preferFrontend = uiKind === UIKind.Web && (plugin.extensionKind?.length === 1 && plugin.extensionKind[0] === 'ui');
+
+        if (plugin.browser && (!plugin.main || preferFrontend)) {
+            // Use frontend if available and there is no backend or frontend is preferred
+            entryPoint.frontend = plugin.browser;
+        } else {
+            // Default to using backend
+            entryPoint.backend = plugin.main;
+        }
+        if (plugin.theiaPlugin?.headless) {
+            // Support the Theia-specific extension for headless plugins
+            entryPoint.headless = plugin.theiaPlugin?.headless;
+        }
+
+        const result: PluginModel = {
+            packagePath: plugin.packagePath,
+            packageUri: this.pluginUriFactory.createUri(plugin).toString(),
+            // see id definition: https://github.com/microsoft/vscode/blob/15916055fe0cb9411a5f36119b3b012458fe0a1d/src/vs/platform/extensions/common/extensions.ts#L167-L169
+            id: `${publisher.toLowerCase()}.${plugin.name.toLowerCase()}`,
+            name: plugin.name,
+            publisher: publisher,
+            version: plugin.version,
+            displayName: plugin.displayName,
+            description: plugin.description,
+            engine: {
+                type: this.VSCODE_TYPE,
+                version: plugin.engines[this.VSCODE_TYPE]
+            },
+            entryPoint,
+            iconUrl: plugin.icon && PluginPackage.toPluginUrl(plugin, plugin.icon),
+            l10n: plugin.l10n,
+            readmeUrl: PluginPackage.toPluginUrl(plugin, './README.md'),
+            licenseUrl: PluginPackage.toPluginUrl(plugin, './LICENSE')
+        };
+        return result;
+    }
+
+    /**
+     * Maps extension dependencies to deployable extension dependencies.
+     */
+    override getDependencies(plugin: PluginPackage): Map<string, string> | undefined {
+        // Store the list of dependencies.
+        const dependencies = new Map<string, string>();
+        // Iterate through the list of dependencies from `extensionDependencies` and `extensionPack`.
+        for (const dependency of [plugin.extensionDependencies, plugin.extensionPack]) {
+            if (dependency !== undefined) {
+                // Iterate over the list of dependencies present, and add them to the collection.
+                dependency.forEach((dep: string) => {
+                    const dependencyId = dep.toLowerCase();
+                    dependencies.set(dependencyId, VSCodeExtensionUri.fromId(dependencyId).toString());
+                });
+            }
+        }
+        // Return the map of dependencies if present, else `undefined`.
+        return dependencies.size > 0 ? dependencies : undefined;
+    }
+
+    override getLifecycle(plugin: PluginPackage): PluginLifecycle {
+        return {
+            startMethod: 'activate',
+            stopMethod: 'deactivate',
+            frontendModuleName: buildFrontendModuleName(plugin),
+
+            frontendInitPath: 'plugin-vscode-init-fe.js',
+            backendInitPath: path.join(__dirname, 'plugin-vscode-init'),
+        };
+    }
+
+}