@theia/workspace 1.34.1 → 1.34.3

package/lib/browser/workspace-duplicate-handler.js

@@ -1,87 +1,87 @@
-"use strict";
-// *****************************************************************************
-// Copyright (C) 2018 Ericsson 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
-// *****************************************************************************
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkspaceDuplicateHandler = void 0;
-const inversify_1 = require("@theia/core/shared/inversify");
-const workspace_utils_1 = require("./workspace-utils");
-const workspace_service_1 = require("./workspace-service");
-const filesystem_utils_1 = require("@theia/filesystem/lib/common/filesystem-utils");
-const file_service_1 = require("@theia/filesystem/lib/browser/file-service");
-let WorkspaceDuplicateHandler = class WorkspaceDuplicateHandler {
-    /**
-     * Determine if the command is visible.
-     *
-     * @param uris URIs of selected resources.
-     * @returns `true` if the command is visible.
-     */
-    isVisible(uris) {
-        return !!uris.length && !this.workspaceUtils.containsRootDirectory(uris);
-    }
-    /**
-     * Determine if the command is enabled.
-     *
-     * @param uris URIs of selected resources.
-     * @returns `true` if the command is enabled.
-     */
-    isEnabled(uris) {
-        return !!uris.length && !this.workspaceUtils.containsRootDirectory(uris);
-    }
-    /**
-     * Execute the command.
-     *
-     * @param uris URIs of selected resources.
-     */
-    async execute(uris) {
-        await Promise.all(uris.map(async (uri) => {
-            try {
-                const parent = await this.fileService.resolve(uri.parent);
-                const targetFileStat = await this.fileService.resolve(uri);
-                const target = filesystem_utils_1.FileSystemUtils.generateUniqueResourceURI(parent, uri, targetFileStat.isDirectory, 'copy');
-                await this.fileService.copy(uri, target);
-            }
-            catch (e) {
-                console.error(e);
-            }
-        }));
-    }
-};
-__decorate([
-    (0, inversify_1.inject)(file_service_1.FileService),
-    __metadata("design:type", file_service_1.FileService)
-], WorkspaceDuplicateHandler.prototype, "fileService", void 0);
-__decorate([
-    (0, inversify_1.inject)(workspace_utils_1.WorkspaceUtils),
-    __metadata("design:type", workspace_utils_1.WorkspaceUtils)
-], WorkspaceDuplicateHandler.prototype, "workspaceUtils", void 0);
-__decorate([
-    (0, inversify_1.inject)(workspace_service_1.WorkspaceService),
-    __metadata("design:type", workspace_service_1.WorkspaceService)
-], WorkspaceDuplicateHandler.prototype, "workspaceService", void 0);
-WorkspaceDuplicateHandler = __decorate([
-    (0, inversify_1.injectable)()
-], WorkspaceDuplicateHandler);
-exports.WorkspaceDuplicateHandler = WorkspaceDuplicateHandler;
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2018 Ericsson 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
+// *****************************************************************************
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkspaceDuplicateHandler = void 0;
+const inversify_1 = require("@theia/core/shared/inversify");
+const workspace_utils_1 = require("./workspace-utils");
+const workspace_service_1 = require("./workspace-service");
+const filesystem_utils_1 = require("@theia/filesystem/lib/common/filesystem-utils");
+const file_service_1 = require("@theia/filesystem/lib/browser/file-service");
+let WorkspaceDuplicateHandler = class WorkspaceDuplicateHandler {
+    /**
+     * Determine if the command is visible.
+     *
+     * @param uris URIs of selected resources.
+     * @returns `true` if the command is visible.
+     */
+    isVisible(uris) {
+        return !!uris.length && !this.workspaceUtils.containsRootDirectory(uris);
+    }
+    /**
+     * Determine if the command is enabled.
+     *
+     * @param uris URIs of selected resources.
+     * @returns `true` if the command is enabled.
+     */
+    isEnabled(uris) {
+        return !!uris.length && !this.workspaceUtils.containsRootDirectory(uris);
+    }
+    /**
+     * Execute the command.
+     *
+     * @param uris URIs of selected resources.
+     */
+    async execute(uris) {
+        await Promise.all(uris.map(async (uri) => {
+            try {
+                const parent = await this.fileService.resolve(uri.parent);
+                const targetFileStat = await this.fileService.resolve(uri);
+                const target = filesystem_utils_1.FileSystemUtils.generateUniqueResourceURI(parent, uri, targetFileStat.isDirectory, 'copy');
+                await this.fileService.copy(uri, target);
+            }
+            catch (e) {
+                console.error(e);
+            }
+        }));
+    }
+};
+__decorate([
+    (0, inversify_1.inject)(file_service_1.FileService),
+    __metadata("design:type", file_service_1.FileService)
+], WorkspaceDuplicateHandler.prototype, "fileService", void 0);
+__decorate([
+    (0, inversify_1.inject)(workspace_utils_1.WorkspaceUtils),
+    __metadata("design:type", workspace_utils_1.WorkspaceUtils)
+], WorkspaceDuplicateHandler.prototype, "workspaceUtils", void 0);
+__decorate([
+    (0, inversify_1.inject)(workspace_service_1.WorkspaceService),
+    __metadata("design:type", workspace_service_1.WorkspaceService)
+], WorkspaceDuplicateHandler.prototype, "workspaceService", void 0);
+WorkspaceDuplicateHandler = __decorate([
+    (0, inversify_1.injectable)()
+], WorkspaceDuplicateHandler);
+exports.WorkspaceDuplicateHandler = WorkspaceDuplicateHandler;
 //# sourceMappingURL=workspace-duplicate-handler.js.map

package/lib/browser/workspace-frontend-contribution.d.ts

@@ -1,136 +1,136 @@
-import { CommandContribution, CommandRegistry, MenuContribution, MenuModelRegistry, MessageService, MaybeArray } from '@theia/core/lib/common';
-import { OS } from '@theia/core';
-import { OpenerService, KeybindingRegistry, KeybindingContribution, FrontendApplicationContribution, OnWillStopAction, Navigatable, SaveableSource, Widget } from '@theia/core/lib/browser';
-import { FileDialogService, OpenFileDialogProps, FileDialogTreeFilters } from '@theia/filesystem/lib/browser';
-import { ContextKeyService } from '@theia/core/lib/browser/context-key-service';
-import { WorkspaceService } from './workspace-service';
-import { QuickOpenWorkspace } from './quick-open-workspace';
-import { WorkspacePreferences } from './workspace-preferences';
-import URI from '@theia/core/lib/common/uri';
-import { FileService } from '@theia/filesystem/lib/browser/file-service';
-import { EncodingRegistry } from '@theia/core/lib/browser/encoding-registry';
-import { DisposableCollection } from '@theia/core/lib/common/disposable';
-import { PreferenceConfigurations } from '@theia/core/lib/browser/preferences/preference-configurations';
-import { FileStat } from '@theia/filesystem/lib/common/files';
-import { FilesystemSaveResourceService } from '@theia/filesystem/lib/browser/filesystem-save-resource-service';
-export declare enum WorkspaceStates {
-    /**
-     * The state is `empty` when no workspace is opened.
-     */
-    empty = "empty",
-    /**
-     * The state is `workspace` when a workspace is opened.
-     */
-    workspace = "workspace",
-    /**
-     * The state is `folder` when a folder is opened. (1 folder)
-     */
-    folder = "folder"
-}
-export declare type WorkspaceState = keyof typeof WorkspaceStates;
-export declare type WorkbenchState = keyof typeof WorkspaceStates;
-/** Create the workspace section after open {@link CommonMenus.FILE_OPEN}. */
-export declare const FILE_WORKSPACE: string[];
-export declare class WorkspaceFrontendContribution implements CommandContribution, KeybindingContribution, MenuContribution, FrontendApplicationContribution {
-    protected readonly messageService: MessageService;
-    protected readonly fileService: FileService;
-    protected readonly openerService: OpenerService;
-    protected readonly workspaceService: WorkspaceService;
-    protected readonly quickOpenWorkspace: QuickOpenWorkspace;
-    protected readonly fileDialogService: FileDialogService;
-    protected preferences: WorkspacePreferences;
-    protected readonly contextKeyService: ContextKeyService;
-    protected readonly encodingRegistry: EncodingRegistry;
-    protected readonly preferenceConfigurations: PreferenceConfigurations;
-    protected readonly saveService: FilesystemSaveResourceService;
-    configure(): void;
-    protected readonly toDisposeOnUpdateEncodingOverrides: DisposableCollection;
-    protected updateEncodingOverrides(): void;
-    protected updateStyles(): void;
-    registerCommands(commands: CommandRegistry): void;
-    registerMenus(menus: MenuModelRegistry): void;
-    registerKeybindings(keybindings: KeybindingRegistry): void;
-    /**
-     * This is the generic `Open` method. Opens files and directories too. Resolves to the opened URI.
-     * Except when you are on either Windows or Linux `AND` running in electron. If so, it opens a file.
-     */
-    protected doOpen(): Promise<URI | undefined>;
-    /**
-     * Opens a file after prompting the `Open File` dialog. Resolves to `undefined`, if
-     *  - the workspace root is not set,
-     *  - the file to open does not exist, or
-     *  - it was not a file, but a directory.
-     *
-     * Otherwise, resolves to the URI of the file.
-     */
-    protected doOpenFile(): Promise<URI | undefined>;
-    /**
-     * Opens one or more folders after prompting the `Open Folder` dialog. Resolves to `undefined`, if
-     *  - the user's selection is empty or contains only files.
-     *  - the new workspace is equal to the old workspace.
-     *
-     * Otherwise, resolves to the URI of the new workspace:
-     *  - a single folder if a single folder was selected.
-     *  - a new, untitled workspace file if multiple folders were selected.
-     */
-    protected doOpenFolder(): Promise<URI | undefined>;
-    protected getOpenableWorkspaceUri(uris: MaybeArray<URI>): Promise<URI | undefined>;
-    protected createMultiRootWorkspace(roots: FileStat[]): Promise<URI>;
-    /**
-     * Opens a workspace after raising the `Open Workspace` dialog. Resolves to the URI of the recently opened workspace,
-     * if it was successful. Otherwise, resolves to `undefined`.
-     *
-     * **Caveat**: this behaves differently on different platforms
-     * and `electron`/`browser` version has impact too. See [here](https://github.com/eclipse-theia/theia/pull/3202#issuecomment-430884195) for more details.
-     *
-     * Legend:
-     *  - Folders only: => `F`
-     *  - Workspace files only: => `W`
-     *  - Folders and workspace files: => `FW`
-     *
-     * -----
-     *
-     * |---------|-----------|-----------|------------|------------|
-     * |         | browser Y | browser N | electron Y | electron N |
-     * |---------|-----------|-----------|------------|------------|
-     * | Linux   |     FW    |     F     |     W      |     F      |
-     * | Windows |     FW    |     F     |     W      |     F      |
-     * | OS X    |     FW    |     F     |     FW     |     FW     |
-     * |---------|-----------|-----------|------------|------------|
-     *
-     */
-    protected doOpenWorkspace(): Promise<URI | undefined>;
-    protected openWorkspaceOpenFileDialogProps(): Promise<OpenFileDialogProps>;
-    protected closeWorkspace(): Promise<void>;
-    /**
-     * @returns whether the file was successfully saved.
-     */
-    protected saveWorkspaceAs(): Promise<boolean>;
-    canBeSavedAs(widget: Widget | undefined): widget is Widget & SaveableSource & Navigatable;
-    saveAs(widget: Widget & SaveableSource & Navigatable): Promise<void>;
-    protected updateWorkspaceStateKey(): WorkspaceState;
-    protected updateWorkbenchStateKey(): WorkbenchState;
-    protected doUpdateState(): WorkspaceState | WorkbenchState;
-    private isElectron;
-    /**
-     * Get the current workspace URI.
-     *
-     * @returns the current workspace URI.
-     */
-    private getCurrentWorkspaceUri;
-    onWillStop(): OnWillStopAction<boolean> | undefined;
-}
-export declare namespace WorkspaceFrontendContribution {
-    /**
-     * File filter for all Theia and VS Code workspace file types.
-     */
-    const DEFAULT_FILE_FILTER: FileDialogTreeFilters;
-    /**
-     * Returns with an `OpenFileDialogProps` for opening the `Open Workspace` dialog.
-     */
-    function createOpenWorkspaceOpenFileDialogProps(options: Readonly<{
-        type: OS.Type;
-        electron: boolean;
-    }>): OpenFileDialogProps;
-}
+import { CommandContribution, CommandRegistry, MenuContribution, MenuModelRegistry, MessageService, MaybeArray } from '@theia/core/lib/common';
+import { OS } from '@theia/core';
+import { OpenerService, KeybindingRegistry, KeybindingContribution, FrontendApplicationContribution, OnWillStopAction, Navigatable, SaveableSource, Widget } from '@theia/core/lib/browser';
+import { FileDialogService, OpenFileDialogProps, FileDialogTreeFilters } from '@theia/filesystem/lib/browser';
+import { ContextKeyService } from '@theia/core/lib/browser/context-key-service';
+import { WorkspaceService } from './workspace-service';
+import { QuickOpenWorkspace } from './quick-open-workspace';
+import { WorkspacePreferences } from './workspace-preferences';
+import URI from '@theia/core/lib/common/uri';
+import { FileService } from '@theia/filesystem/lib/browser/file-service';
+import { EncodingRegistry } from '@theia/core/lib/browser/encoding-registry';
+import { DisposableCollection } from '@theia/core/lib/common/disposable';
+import { PreferenceConfigurations } from '@theia/core/lib/browser/preferences/preference-configurations';
+import { FileStat } from '@theia/filesystem/lib/common/files';
+import { FilesystemSaveResourceService } from '@theia/filesystem/lib/browser/filesystem-save-resource-service';
+export declare enum WorkspaceStates {
+    /**
+     * The state is `empty` when no workspace is opened.
+     */
+    empty = "empty",
+    /**
+     * The state is `workspace` when a workspace is opened.
+     */
+    workspace = "workspace",
+    /**
+     * The state is `folder` when a folder is opened. (1 folder)
+     */
+    folder = "folder"
+}
+export declare type WorkspaceState = keyof typeof WorkspaceStates;
+export declare type WorkbenchState = keyof typeof WorkspaceStates;
+/** Create the workspace section after open {@link CommonMenus.FILE_OPEN}. */
+export declare const FILE_WORKSPACE: string[];
+export declare class WorkspaceFrontendContribution implements CommandContribution, KeybindingContribution, MenuContribution, FrontendApplicationContribution {
+    protected readonly messageService: MessageService;
+    protected readonly fileService: FileService;
+    protected readonly openerService: OpenerService;
+    protected readonly workspaceService: WorkspaceService;
+    protected readonly quickOpenWorkspace: QuickOpenWorkspace;
+    protected readonly fileDialogService: FileDialogService;
+    protected preferences: WorkspacePreferences;
+    protected readonly contextKeyService: ContextKeyService;
+    protected readonly encodingRegistry: EncodingRegistry;
+    protected readonly preferenceConfigurations: PreferenceConfigurations;
+    protected readonly saveService: FilesystemSaveResourceService;
+    configure(): void;
+    protected readonly toDisposeOnUpdateEncodingOverrides: DisposableCollection;
+    protected updateEncodingOverrides(): void;
+    protected updateStyles(): void;
+    registerCommands(commands: CommandRegistry): void;
+    registerMenus(menus: MenuModelRegistry): void;
+    registerKeybindings(keybindings: KeybindingRegistry): void;
+    /**
+     * This is the generic `Open` method. Opens files and directories too. Resolves to the opened URI.
+     * Except when you are on either Windows or Linux `AND` running in electron. If so, it opens a file.
+     */
+    protected doOpen(): Promise<URI | undefined>;
+    /**
+     * Opens a file after prompting the `Open File` dialog. Resolves to `undefined`, if
+     *  - the workspace root is not set,
+     *  - the file to open does not exist, or
+     *  - it was not a file, but a directory.
+     *
+     * Otherwise, resolves to the URI of the file.
+     */
+    protected doOpenFile(): Promise<URI | undefined>;
+    /**
+     * Opens one or more folders after prompting the `Open Folder` dialog. Resolves to `undefined`, if
+     *  - the user's selection is empty or contains only files.
+     *  - the new workspace is equal to the old workspace.
+     *
+     * Otherwise, resolves to the URI of the new workspace:
+     *  - a single folder if a single folder was selected.
+     *  - a new, untitled workspace file if multiple folders were selected.
+     */
+    protected doOpenFolder(): Promise<URI | undefined>;
+    protected getOpenableWorkspaceUri(uris: MaybeArray<URI>): Promise<URI | undefined>;
+    protected createMultiRootWorkspace(roots: FileStat[]): Promise<URI>;
+    /**
+     * Opens a workspace after raising the `Open Workspace` dialog. Resolves to the URI of the recently opened workspace,
+     * if it was successful. Otherwise, resolves to `undefined`.
+     *
+     * **Caveat**: this behaves differently on different platforms
+     * and `electron`/`browser` version has impact too. See [here](https://github.com/eclipse-theia/theia/pull/3202#issuecomment-430884195) for more details.
+     *
+     * Legend:
+     *  - Folders only: => `F`
+     *  - Workspace files only: => `W`
+     *  - Folders and workspace files: => `FW`
+     *
+     * -----
+     *
+     * |---------|-----------|-----------|------------|------------|
+     * |         | browser Y | browser N | electron Y | electron N |
+     * |---------|-----------|-----------|------------|------------|
+     * | Linux   |     FW    |     F     |     W      |     F      |
+     * | Windows |     FW    |     F     |     W      |     F      |
+     * | OS X    |     FW    |     F     |     FW     |     FW     |
+     * |---------|-----------|-----------|------------|------------|
+     *
+     */
+    protected doOpenWorkspace(): Promise<URI | undefined>;
+    protected openWorkspaceOpenFileDialogProps(): Promise<OpenFileDialogProps>;
+    protected closeWorkspace(): Promise<void>;
+    /**
+     * @returns whether the file was successfully saved.
+     */
+    protected saveWorkspaceAs(): Promise<boolean>;
+    canBeSavedAs(widget: Widget | undefined): widget is Widget & SaveableSource & Navigatable;
+    saveAs(widget: Widget & SaveableSource & Navigatable): Promise<void>;
+    protected updateWorkspaceStateKey(): WorkspaceState;
+    protected updateWorkbenchStateKey(): WorkbenchState;
+    protected doUpdateState(): WorkspaceState | WorkbenchState;
+    private isElectron;
+    /**
+     * Get the current workspace URI.
+     *
+     * @returns the current workspace URI.
+     */
+    private getCurrentWorkspaceUri;
+    onWillStop(): OnWillStopAction<boolean> | undefined;
+}
+export declare namespace WorkspaceFrontendContribution {
+    /**
+     * File filter for all Theia and VS Code workspace file types.
+     */
+    const DEFAULT_FILE_FILTER: FileDialogTreeFilters;
+    /**
+     * Returns with an `OpenFileDialogProps` for opening the `Open Workspace` dialog.
+     */
+    function createOpenWorkspaceOpenFileDialogProps(options: Readonly<{
+        type: OS.Type;
+        electron: boolean;
+    }>): OpenFileDialogProps;
+}
 //# sourceMappingURL=workspace-frontend-contribution.d.ts.map