@theia/core 1.53.0-next.4 → 1.53.0-next.55

package/src/browser/navigatable-types.ts

@@ -1,81 +1,81 @@
-// *****************************************************************************
-// Copyright (C) 2021 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-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { URI, isObject, MaybeArray } from '../common';
-import { Widget, BaseWidget } from './widgets';
-
-/**
- * `Navigatable` provides an access to an URI of an underlying instance of `Resource`.
- */
-export interface Navigatable {
-    /**
-     * Return an underlying resource URI.
-     */
-    getResourceUri(): URI | undefined;
-    /**
-     * Creates a new URI to which this navigatable should moved based on the given target resource URI.
-     */
-    createMoveToUri(resourceUri: URI): URI | undefined;
-}
-
-export namespace Navigatable {
-    export function is(arg: unknown): arg is Navigatable {
-        return isObject(arg) && 'getResourceUri' in arg && 'createMoveToUri' in arg;
-    }
-}
-
-export type NavigatableWidget = BaseWidget & Navigatable;
-export namespace NavigatableWidget {
-    export function is(arg: unknown): arg is NavigatableWidget {
-        return arg instanceof BaseWidget && Navigatable.is(arg);
-    }
-    export function* getAffected<T extends Widget>(
-        widgets: Iterable<T>,
-        context: MaybeArray<URI>
-    ): IterableIterator<[URI, T & NavigatableWidget]> {
-        const uris = Array.isArray(context) ? context : [context];
-        return get(widgets, resourceUri => uris.some(uri => uri.isEqualOrParent(resourceUri)));
-    }
-    export function* get<T extends Widget>(
-        widgets: Iterable<T>,
-        filter: (resourceUri: URI) => boolean = () => true
-    ): IterableIterator<[URI, T & NavigatableWidget]> {
-        for (const widget of widgets) {
-            if (NavigatableWidget.is(widget)) {
-                const resourceUri = widget.getResourceUri();
-                if (resourceUri && filter(resourceUri)) {
-                    yield [resourceUri, widget];
-                }
-            }
-        }
-    }
-    export function getUri(widget?: Widget): URI | undefined {
-        if (is(widget)) {
-            return widget.getResourceUri();
-        }
-    }
-}
-
-export interface NavigatableWidgetOptions {
-    kind: 'navigatable';
-    uri: string;
-    counter?: number;
-}
-export namespace NavigatableWidgetOptions {
-    export function is(arg: unknown): arg is NavigatableWidgetOptions {
-        return isObject(arg) && arg.kind === 'navigatable';
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2021 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-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { URI, isObject, MaybeArray } from '../common';
+import { Widget, BaseWidget } from './widgets';
+
+/**
+ * `Navigatable` provides an access to an URI of an underlying instance of `Resource`.
+ */
+export interface Navigatable {
+    /**
+     * Return an underlying resource URI.
+     */
+    getResourceUri(): URI | undefined;
+    /**
+     * Creates a new URI to which this navigatable should moved based on the given target resource URI.
+     */
+    createMoveToUri(resourceUri: URI): URI | undefined;
+}
+
+export namespace Navigatable {
+    export function is(arg: unknown): arg is Navigatable {
+        return isObject(arg) && 'getResourceUri' in arg && 'createMoveToUri' in arg;
+    }
+}
+
+export type NavigatableWidget = BaseWidget & Navigatable;
+export namespace NavigatableWidget {
+    export function is(arg: unknown): arg is NavigatableWidget {
+        return arg instanceof BaseWidget && Navigatable.is(arg);
+    }
+    export function* getAffected<T extends Widget>(
+        widgets: Iterable<T>,
+        context: MaybeArray<URI>
+    ): IterableIterator<[URI, T & NavigatableWidget]> {
+        const uris = Array.isArray(context) ? context : [context];
+        return get(widgets, resourceUri => uris.some(uri => uri.isEqualOrParent(resourceUri)));
+    }
+    export function* get<T extends Widget>(
+        widgets: Iterable<T>,
+        filter: (resourceUri: URI) => boolean = () => true
+    ): IterableIterator<[URI, T & NavigatableWidget]> {
+        for (const widget of widgets) {
+            if (NavigatableWidget.is(widget)) {
+                const resourceUri = widget.getResourceUri();
+                if (resourceUri && filter(resourceUri)) {
+                    yield [resourceUri, widget];
+                }
+            }
+        }
+    }
+    export function getUri(widget?: Widget): URI | undefined {
+        if (is(widget)) {
+            return widget.getResourceUri();
+        }
+    }
+}
+
+export interface NavigatableWidgetOptions {
+    kind: 'navigatable';
+    uri: string;
+    counter?: number;
+}
+export namespace NavigatableWidgetOptions {
+    export function is(arg: unknown): arg is NavigatableWidgetOptions {
+        return isObject(arg) && arg.kind === 'navigatable';
+    }
+}

package/src/browser/navigatable.ts

@@ -1,39 +1,39 @@
-// *****************************************************************************
-// Copyright (C) 2018 Red Hat, Inc. 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 URI from '../common/uri';
-import { WidgetOpenHandler, WidgetOpenerOptions } from './widget-open-handler';
-import { NavigatableWidget, NavigatableWidgetOptions } from './navigatable-types';
-export * from './navigatable-types';
-
-export abstract class NavigatableWidgetOpenHandler<W extends NavigatableWidget> extends WidgetOpenHandler<W> {
-
-    protected createWidgetOptions(uri: URI, options?: WidgetOpenerOptions): NavigatableWidgetOptions {
-        return {
-            kind: 'navigatable',
-            uri: this.serializeUri(uri)
-        };
-    }
-
-    protected serializeUri(uri: URI): string {
-        if (uri.scheme === 'file') {
-            return uri.withoutFragment().normalizePath().toString();
-        } else {
-            return uri.withoutFragment().toString();
-        }
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2018 Red Hat, Inc. 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 URI from '../common/uri';
+import { WidgetOpenHandler, WidgetOpenerOptions } from './widget-open-handler';
+import { NavigatableWidget, NavigatableWidgetOptions } from './navigatable-types';
+export * from './navigatable-types';
+
+export abstract class NavigatableWidgetOpenHandler<W extends NavigatableWidget> extends WidgetOpenHandler<W> {
+
+    protected createWidgetOptions(uri: URI, options?: WidgetOpenerOptions): NavigatableWidgetOptions {
+        return {
+            kind: 'navigatable',
+            uri: this.serializeUri(uri)
+        };
+    }
+
+    protected serializeUri(uri: URI): string {
+        if (uri.scheme === 'file') {
+            return uri.withoutFragment().normalizePath().toString();
+        } else {
+            return uri.withoutFragment().toString();
+        }
+    }
+
+}

package/src/browser/open-with-service.ts

@@ -1,93 +1,140 @@
-// *****************************************************************************
-// Copyright (C) 2024 TypeFox 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 'inversify';
-import { Disposable } from '../common/disposable';
-import { nls } from '../common/nls';
-import { MaybePromise } from '../common/types';
-import { URI } from '../common/uri';
-import { QuickInputService } from './quick-input';
-
-export interface OpenWithHandler {
-    /**
-     * A unique id of this handler.
-     */
-    readonly id: string;
-    /**
-     * A human-readable name of this handler.
-     */
-    readonly label?: string;
-    /**
-     * A human-readable provider name of this handler.
-     */
-    readonly providerName?: string;
-    /**
-     * A css icon class of this handler.
-     */
-    readonly iconClass?: string;
-    /**
-     * Test whether this handler can open the given URI for given options.
-     * Return a nonzero number if this handler can open; otherwise it cannot.
-     * Never reject.
-     *
-     * A returned value indicating a priority of this handler.
-     */
-    canHandle(uri: URI): number;
-    /**
-     * Open a widget for the given URI and options.
-     * Resolve to an opened widget or undefined, e.g. if a page is opened.
-     * Never reject if `canHandle` return a positive number; otherwise should reject.
-     */
-    open(uri: URI): MaybePromise<object | undefined>;
-}
-
-@injectable()
-export class OpenWithService {
-
-    @inject(QuickInputService)
-    protected readonly quickInputService: QuickInputService;
-
-    protected readonly handlers: OpenWithHandler[] = [];
-
-    registerHandler(handler: OpenWithHandler): Disposable {
-        this.handlers.push(handler);
-        return Disposable.create(() => {
-            const index = this.handlers.indexOf(handler);
-            if (index !== -1) {
-                this.handlers.splice(index, 1);
-            }
-        });
-    }
-
-    async openWith(uri: URI): Promise<object | undefined> {
-        const handlers = this.getHandlers(uri);
-        const result = await this.quickInputService.pick(handlers.map(handler => ({
-            handler: handler,
-            label: handler.label ?? handler.id,
-            detail: handler.providerName
-        })), {
-            placeHolder: nls.localizeByDefault("Select editor for '{0}'", uri.path.base)
-        });
-        if (result) {
-            return result.handler.open(uri);
-        }
-    }
-
-    getHandlers(uri: URI): OpenWithHandler[] {
-        const map = new Map<OpenWithHandler, number>(this.handlers.map(handler => [handler, handler.canHandle(uri)]));
-        return this.handlers.filter(handler => map.get(handler)! > 0).sort((a, b) => map.get(b)! - map.get(a)!);
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2024 TypeFox 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 'inversify';
+import { Disposable } from '../common/disposable';
+import { nls } from '../common/nls';
+import { MaybePromise } from '../common/types';
+import { URI } from '../common/uri';
+import { QuickInputService, QuickPickItem, QuickPickItemOrSeparator } from './quick-input';
+import { PreferenceScope, PreferenceService } from './preferences';
+import { getDefaultHandler } from './opener-service';
+
+export interface OpenWithHandler {
+    /**
+     * A unique id of this handler.
+     */
+    readonly id: string;
+    /**
+     * A human-readable name of this handler.
+     */
+    readonly label?: string;
+    /**
+     * A human-readable provider name of this handler.
+     */
+    readonly providerName?: string;
+    /**
+     * A css icon class of this handler.
+     */
+    readonly iconClass?: string;
+    /**
+     * Test whether this handler can open the given URI for given options.
+     * Return a nonzero number if this handler can open; otherwise it cannot.
+     * Never reject.
+     *
+     * A returned value indicating a priority of this handler.
+     */
+    canHandle(uri: URI): number;
+    /**
+     * Test whether this handler and open the given URI
+     * and return the order of this handler in the list.
+     */
+    getOrder?(uri: URI): number;
+    /**
+     * Open a widget for the given URI and options.
+     * Resolve to an opened widget or undefined, e.g. if a page is opened.
+     * Never reject if `canHandle` return a positive number; otherwise should reject.
+     */
+    open(uri: URI): MaybePromise<object | undefined>;
+}
+
+export interface OpenWithQuickPickItem extends QuickPickItem {
+    handler: OpenWithHandler;
+}
+
+@injectable()
+export class OpenWithService {
+
+    @inject(QuickInputService)
+    protected readonly quickInputService: QuickInputService;
+
+    @inject(PreferenceService)
+    protected readonly preferenceService: PreferenceService;
+
+    protected readonly handlers: OpenWithHandler[] = [];
+
+    registerHandler(handler: OpenWithHandler): Disposable {
+        this.handlers.push(handler);
+        return Disposable.create(() => {
+            const index = this.handlers.indexOf(handler);
+            if (index !== -1) {
+                this.handlers.splice(index, 1);
+            }
+        });
+    }
+
+    async openWith(uri: URI): Promise<object | undefined> {
+        // Clone the object, because all objects returned by the preferences service are frozen.
+        const associations: Record<string, unknown> = { ...this.preferenceService.get('workbench.editorAssociations') };
+        const ext = `*${uri.path.ext}`;
+        const handlers = this.getHandlers(uri);
+        const ordered = handlers.slice().sort((a, b) => this.getOrder(b, uri) - this.getOrder(a, uri));
+        const defaultHandler = getDefaultHandler(uri, this.preferenceService) ?? handlers[0]?.id;
+        const items = this.getQuickPickItems(ordered, defaultHandler);
+        // Only offer to select a default editor when the file has a file extension
+        const extraItems: QuickPickItemOrSeparator[] = uri.path.ext ? [{
+            type: 'separator'
+        }, {
+            label: nls.localizeByDefault("Configure default editor for '{0}'...", ext)
+        }] : [];
+        const result = await this.quickInputService.pick<OpenWithQuickPickItem | { label: string }>([...items, ...extraItems], {
+            placeHolder: nls.localizeByDefault("Select editor for '{0}'", uri.path.base)
+        });
+        if (result) {
+            if ('handler' in result) {
+                return result.handler.open(uri);
+            } else if (result.label) {
+                const configureResult = await this.quickInputService.pick(items, {
+                    placeHolder: nls.localizeByDefault("Select new default editor for '{0}'", ext)
+                });
+                if (configureResult) {
+                    associations[ext] = configureResult.handler.id;
+                    this.preferenceService.set('workbench.editorAssociations', associations, PreferenceScope.User);
+                    return configureResult.handler.open(uri);
+                }
+            }
+        }
+        return undefined;
+    }
+
+    protected getQuickPickItems(handlers: OpenWithHandler[], defaultHandler?: string): OpenWithQuickPickItem[] {
+        return handlers.map(handler => ({
+            handler,
+            label: handler.label ?? handler.id,
+            detail: handler.providerName ?? '',
+            description: handler.id === defaultHandler ? nls.localizeByDefault('Default') : undefined
+        }));
+    }
+
+    protected getOrder(handler: OpenWithHandler, uri: URI): number {
+        return handler.getOrder ? handler.getOrder(uri) : handler.canHandle(uri);
+    }
+
+    getHandlers(uri: URI): OpenWithHandler[] {
+        const map = new Map<OpenWithHandler, number>(this.handlers.map(handler => [handler, handler.canHandle(uri)]));
+        return this.handlers.filter(handler => map.get(handler)! > 0).sort((a, b) => map.get(b)! - map.get(a)!);
+    }
+}

package/src/browser/opener-service.spec.ts

@@ -1,49 +1,49 @@
-// *****************************************************************************
-// Copyright (C) 2017 TypeFox 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 { DefaultOpenerService, OpenHandler } from './opener-service';
-import * as assert from 'assert';
-import { MaybePromise } from '../common/types';
-import * as chai from 'chai';
-const expect = chai.expect;
-
-const id = 'my-opener';
-const openHandler: OpenHandler = {
-    id,
-    label: 'My Opener',
-    canHandle(): MaybePromise<number> {
-        return Promise.resolve(1);
-    },
-    open(): MaybePromise<object | undefined> {
-        return Promise.resolve(undefined);
-    }
-};
-const openerService = new DefaultOpenerService({
-    getContributions: () => [openHandler]
-});
-
-describe('opener-service', () => {
-    it('getOpeners', () =>
-        openerService.getOpeners().then(openers => {
-            assert.deepStrictEqual([openHandler], openers);
-        }));
-    it('addHandler', () => {
-        openerService.addHandler(openHandler);
-        openerService.getOpeners().then(openers => {
-            expect(openers.length).is.equal(2);
-        });
-    });
-});
+// *****************************************************************************
+// Copyright (C) 2017 TypeFox 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 { DefaultOpenerService, OpenHandler } from './opener-service';
+import * as assert from 'assert';
+import { MaybePromise } from '../common/types';
+import * as chai from 'chai';
+const expect = chai.expect;
+
+const id = 'my-opener';
+const openHandler: OpenHandler = {
+    id,
+    label: 'My Opener',
+    canHandle(): MaybePromise<number> {
+        return Promise.resolve(1);
+    },
+    open(): MaybePromise<object | undefined> {
+        return Promise.resolve(undefined);
+    }
+};
+const openerService = new DefaultOpenerService({
+    getContributions: () => [openHandler]
+});
+
+describe('opener-service', () => {
+    it('getOpeners', () =>
+        openerService.getOpeners().then(openers => {
+            assert.deepStrictEqual([openHandler], openers);
+        }));
+    it('addHandler', () => {
+        openerService.addHandler(openHandler);
+        openerService.getOpeners().then(openers => {
+            expect(openers.length).is.equal(2);
+        });
+    });
+});