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

package/src/common/preferences/preference-scope.spec.ts

@@ -1,48 +1,48 @@
-// *****************************************************************************
-// Copyright (C) 2022 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 { expect } from 'chai';
-import { PreferenceScope } from './preference-scope';
-
-describe('PreferenceScope', () => {
-
-    it('getScopes() should return numbers from broadest to narrowest', () => {
-        expect(PreferenceScope.getScopes()).deep.equal([0, 1, 2, 3]);
-    });
-
-    it('getReversedScopes() should return numbers from narrowest to broadest', () => {
-        expect(PreferenceScope.getReversedScopes()).deep.equal([3, 2, 1, 0]);
-    });
-
-    it('getScopeNames() should return the names of scopes broader than the current one', () => {
-        expect(PreferenceScope.getScopeNames(PreferenceScope.Workspace)).deep.equal(['Default', 'User', 'Workspace']);
-    });
-
-    it('is() returns whether a value is a preference scope', () => {
-        expect(PreferenceScope.is(PreferenceScope.Default)).to.be.true;
-        expect(PreferenceScope.is(PreferenceScope.User)).to.be.true;
-        expect(PreferenceScope.is(PreferenceScope.Workspace)).to.be.true;
-        expect(PreferenceScope.is(PreferenceScope.Folder)).to.be.true;
-        expect(PreferenceScope.is(0)).to.be.true;
-        expect(PreferenceScope.is(1)).to.be.true;
-        expect(PreferenceScope.is(2)).to.be.true;
-        expect(PreferenceScope.is(3)).to.be.true;
-        expect(PreferenceScope.is(4)).to.be.false;
-        expect(PreferenceScope.is(-1)).to.be.false;
-        expect(PreferenceScope.is({})).to.be.false;
-        expect(PreferenceScope.is('Default')).to.be.false;
-    });
-});
+// *****************************************************************************
+// Copyright (C) 2022 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 { expect } from 'chai';
+import { PreferenceScope } from './preference-scope';
+
+describe('PreferenceScope', () => {
+
+    it('getScopes() should return numbers from broadest to narrowest', () => {
+        expect(PreferenceScope.getScopes()).deep.equal([0, 1, 2, 3]);
+    });
+
+    it('getReversedScopes() should return numbers from narrowest to broadest', () => {
+        expect(PreferenceScope.getReversedScopes()).deep.equal([3, 2, 1, 0]);
+    });
+
+    it('getScopeNames() should return the names of scopes broader than the current one', () => {
+        expect(PreferenceScope.getScopeNames(PreferenceScope.Workspace)).deep.equal(['Default', 'User', 'Workspace']);
+    });
+
+    it('is() returns whether a value is a preference scope', () => {
+        expect(PreferenceScope.is(PreferenceScope.Default)).to.be.true;
+        expect(PreferenceScope.is(PreferenceScope.User)).to.be.true;
+        expect(PreferenceScope.is(PreferenceScope.Workspace)).to.be.true;
+        expect(PreferenceScope.is(PreferenceScope.Folder)).to.be.true;
+        expect(PreferenceScope.is(0)).to.be.true;
+        expect(PreferenceScope.is(1)).to.be.true;
+        expect(PreferenceScope.is(2)).to.be.true;
+        expect(PreferenceScope.is(3)).to.be.true;
+        expect(PreferenceScope.is(4)).to.be.false;
+        expect(PreferenceScope.is(-1)).to.be.false;
+        expect(PreferenceScope.is({})).to.be.false;
+        expect(PreferenceScope.is('Default')).to.be.false;
+    });
+});

package/src/common/preferences/preference-scope.ts

@@ -1,68 +1,68 @@
-// *****************************************************************************
-// Copyright (C) 2019 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
-// *****************************************************************************
-
-export enum PreferenceScope {
-    Default,
-    User,
-    Workspace,
-    Folder
-}
-
-export namespace PreferenceScope {
-    export function is(scope: unknown): scope is PreferenceScope {
-        return typeof scope === 'number' && getScopes().includes(scope);
-    }
-
-    /**
-     * @returns preference scopes from broadest to narrowest: Default -> Folder.
-     */
-    export function getScopes(): PreferenceScope[] {
-        return Object.values(PreferenceScope).filter(nameOrIndex => !isNaN(Number(nameOrIndex))) as PreferenceScope[];
-    }
-
-    /**
-     * @returns preference scopes from narrowest to broadest. Folder -> Default.
-     */
-    export function getReversedScopes(): PreferenceScope[] {
-        return getScopes().reverse();
-    }
-
-    export function getScopeNames(scope?: PreferenceScope): string[] {
-        const names: string[] = [];
-        const scopes = getScopes();
-        if (scope) {
-            for (const scopeIndex of scopes) {
-                if (scopeIndex <= scope) {
-                    names.push(PreferenceScope[scopeIndex]);
-                }
-            }
-        }
-        return names;
-    }
-
-    export function fromString(strScope: string): PreferenceScope | undefined {
-        switch (strScope) {
-            case 'application':
-                return PreferenceScope.User;
-            case 'window':
-                return PreferenceScope.Folder;
-            case 'resource':
-                return PreferenceScope.Folder;
-            case 'language-overridable':
-                return PreferenceScope.Folder;
-        }
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2019 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
+// *****************************************************************************
+
+export enum PreferenceScope {
+    Default,
+    User,
+    Workspace,
+    Folder
+}
+
+export namespace PreferenceScope {
+    export function is(scope: unknown): scope is PreferenceScope {
+        return typeof scope === 'number' && getScopes().includes(scope);
+    }
+
+    /**
+     * @returns preference scopes from broadest to narrowest: Default -> Folder.
+     */
+    export function getScopes(): PreferenceScope[] {
+        return Object.values(PreferenceScope).filter(nameOrIndex => !isNaN(Number(nameOrIndex))) as PreferenceScope[];
+    }
+
+    /**
+     * @returns preference scopes from narrowest to broadest. Folder -> Default.
+     */
+    export function getReversedScopes(): PreferenceScope[] {
+        return getScopes().reverse();
+    }
+
+    export function getScopeNames(scope?: PreferenceScope): string[] {
+        const names: string[] = [];
+        const scopes = getScopes();
+        if (scope) {
+            for (const scopeIndex of scopes) {
+                if (scopeIndex <= scope) {
+                    names.push(PreferenceScope[scopeIndex]);
+                }
+            }
+        }
+        return names;
+    }
+
+    export function fromString(strScope: string): PreferenceScope | undefined {
+        switch (strScope) {
+            case 'application':
+                return PreferenceScope.User;
+            case 'window':
+                return PreferenceScope.Folder;
+            case 'resource':
+                return PreferenceScope.Folder;
+            case 'language-overridable':
+                return PreferenceScope.Folder;
+        }
+    }
+}

package/src/common/prioritizeable.ts

@@ -1,58 +1,58 @@
-// *****************************************************************************
-// Copyright (C) 2023 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 type { MaybeArray, MaybePromise } from './types';
-
-export interface Prioritizeable<T> {
-    readonly priority: number;
-    readonly value: T;
-}
-export namespace Prioritizeable {
-    export type GetPriority<T> = (value: T) => MaybePromise<number>;
-    export type GetPrioritySync<T> = (value: T) => number;
-    export async function toPrioritizeable<T>(rawValue: MaybePromise<T>, getPriority: GetPriority<T>): Promise<Prioritizeable<T>>;
-    export async function toPrioritizeable<T>(rawValue: MaybePromise<T>[], getPriority: GetPriority<T>): Promise<Prioritizeable<T>[]>;
-    export async function toPrioritizeable<T>(rawValue: MaybeArray<MaybePromise<T>>, getPriority: GetPriority<T>): Promise<MaybeArray<Prioritizeable<T>>> {
-        if (rawValue instanceof Array) {
-            return Promise.all(
-                rawValue.map(v => toPrioritizeable(v, getPriority))
-            );
-        }
-        const value = await rawValue;
-        const priority = await getPriority(value);
-        return { priority, value };
-    }
-    export function toPrioritizeableSync<T>(rawValue: T[], getPriority: GetPrioritySync<T>): Prioritizeable<T>[] {
-        return rawValue.map(v => ({
-            value: v,
-            priority: getPriority(v)
-        }));
-    }
-    export function prioritizeAllSync<T>(values: T[], getPriority: GetPrioritySync<T>): Prioritizeable<T>[] {
-        const prioritizeable = toPrioritizeableSync(values, getPriority);
-        return prioritizeable.filter(isValid).sort(compare);
-    }
-    export async function prioritizeAll<T>(values: MaybePromise<T>[], getPriority: GetPriority<T>): Promise<Prioritizeable<T>[]> {
-        const prioritizeable = await toPrioritizeable(values, getPriority);
-        return prioritizeable.filter(isValid).sort(compare);
-    }
-    export function isValid<T>(p: Prioritizeable<T>): boolean {
-        return p.priority > 0;
-    }
-    export function compare<T>(p: Prioritizeable<T>, p2: Prioritizeable<T>): number {
-        return p2.priority - p.priority;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2023 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 type { MaybeArray, MaybePromise } from './types';
+
+export interface Prioritizeable<T> {
+    readonly priority: number;
+    readonly value: T;
+}
+export namespace Prioritizeable {
+    export type GetPriority<T> = (value: T) => MaybePromise<number>;
+    export type GetPrioritySync<T> = (value: T) => number;
+    export async function toPrioritizeable<T>(rawValue: MaybePromise<T>, getPriority: GetPriority<T>): Promise<Prioritizeable<T>>;
+    export async function toPrioritizeable<T>(rawValue: MaybePromise<T>[], getPriority: GetPriority<T>): Promise<Prioritizeable<T>[]>;
+    export async function toPrioritizeable<T>(rawValue: MaybeArray<MaybePromise<T>>, getPriority: GetPriority<T>): Promise<MaybeArray<Prioritizeable<T>>> {
+        if (rawValue instanceof Array) {
+            return Promise.all(
+                rawValue.map(v => toPrioritizeable(v, getPriority))
+            );
+        }
+        const value = await rawValue;
+        const priority = await getPriority(value);
+        return { priority, value };
+    }
+    export function toPrioritizeableSync<T>(rawValue: T[], getPriority: GetPrioritySync<T>): Prioritizeable<T>[] {
+        return rawValue.map(v => ({
+            value: v,
+            priority: getPriority(v)
+        }));
+    }
+    export function prioritizeAllSync<T>(values: T[], getPriority: GetPrioritySync<T>): Prioritizeable<T>[] {
+        const prioritizeable = toPrioritizeableSync(values, getPriority);
+        return prioritizeable.filter(isValid).sort(compare);
+    }
+    export async function prioritizeAll<T>(values: MaybePromise<T>[], getPriority: GetPriority<T>): Promise<Prioritizeable<T>[]> {
+        const prioritizeable = await toPrioritizeable(values, getPriority);
+        return prioritizeable.filter(isValid).sort(compare);
+    }
+    export function isValid<T>(p: Prioritizeable<T>): boolean {
+        return p.priority > 0;
+    }
+    export function compare<T>(p: Prioritizeable<T>, p2: Prioritizeable<T>): number {
+        return p2.priority - p.priority;
+    }
+}

package/src/common/progress-service-protocol.ts

@@ -1,35 +1,35 @@
-// *****************************************************************************
-// Copyright (C) 2019 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 {
-    ProgressUpdate,
-    ProgressMessage
-} from './message-service-protocol';
-import { CancellationToken } from './cancellation';
-
-export const ProgressClient = Symbol('ProgressClient');
-export interface ProgressClient {
-
-    /**
-     * Show a progress message with possible actions to user.
-     */
-    showProgress(progressId: string, message: ProgressMessage, cancellationToken: CancellationToken): Promise<string | undefined>;
-
-    /**
-     * Update a previously created progress message.
-     */
-    reportProgress(progressId: string, update: ProgressUpdate, message: ProgressMessage, cancellationToken: CancellationToken): Promise<void>;
-}
+// *****************************************************************************
+// Copyright (C) 2019 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 {
+    ProgressUpdate,
+    ProgressMessage
+} from './message-service-protocol';
+import { CancellationToken } from './cancellation';
+
+export const ProgressClient = Symbol('ProgressClient');
+export interface ProgressClient {
+
+    /**
+     * Show a progress message with possible actions to user.
+     */
+    showProgress(progressId: string, message: ProgressMessage, cancellationToken: CancellationToken): Promise<string | undefined>;
+
+    /**
+     * Update a previously created progress message.
+     */
+    reportProgress(progressId: string, update: ProgressUpdate, message: ProgressMessage, cancellationToken: CancellationToken): Promise<void>;
+}

package/src/common/progress-service.ts

@@ -1,82 +1,82 @@
-// *****************************************************************************
-// Copyright (C) 2019 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 { injectable, inject } from 'inversify';
-import {
-    Progress,
-    ProgressUpdate,
-    ProgressMessage
-} from './message-service-protocol';
-import { CancellationTokenSource } from './cancellation';
-import { ProgressClient } from './progress-service-protocol';
-import { MessageService } from './message-service';
-
-@injectable()
-export class ProgressService {
-
-    @inject(ProgressClient) protected readonly client: ProgressClient;
-    @inject(MessageService) protected readonly messageService: MessageService;
-
-    async showProgress(message: ProgressMessage, onDidCancel?: () => void): Promise<Progress> {
-        if (this.shouldDelegate(message)) {
-            return this.messageService.showProgress(message, onDidCancel);
-        }
-        const id = this.newProgressId();
-        const cancellationSource = new CancellationTokenSource();
-        const report = (update: ProgressUpdate) => {
-            this.client.reportProgress(id, update, message, cancellationSource.token);
-        };
-        const actions = new Set<string>(message.actions);
-        if (ProgressMessage.isCancelable(message)) {
-            actions.delete(ProgressMessage.Cancel);
-            actions.add(ProgressMessage.Cancel);
-        }
-        const clientMessage = { ...message, actions: Array.from(actions) };
-        const result = this.client.showProgress(id, clientMessage, cancellationSource.token);
-        if (ProgressMessage.isCancelable(message) && typeof onDidCancel === 'function') {
-            result.then(value => {
-                if (value === ProgressMessage.Cancel) {
-                    onDidCancel();
-                }
-            });
-        }
-        return {
-            id,
-            cancel: () => cancellationSource.cancel(),
-            result,
-            report
-        };
-    }
-    protected shouldDelegate(message: ProgressMessage): boolean {
-        const location = message.options && message.options.location;
-        return location === 'notification';
-    }
-
-    private progressIdPrefix = Math.random().toString(36).substring(5);
-    private counter = 0;
-    protected newProgressId(): string {
-        return `${this.progressIdPrefix}-${++this.counter}`;
-    }
-
-    async withProgress<T>(text: string, locationId: string, task: () => Promise<T>, onDidCancel?: () => void): Promise<T> {
-        const progress = await this.showProgress({ text, options: { cancelable: true, location: locationId } }, onDidCancel);
-        try {
-            return await task();
-        } finally {
-            progress.cancel();
-        }
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2019 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 { injectable, inject } from 'inversify';
+import {
+    Progress,
+    ProgressUpdate,
+    ProgressMessage
+} from './message-service-protocol';
+import { CancellationTokenSource } from './cancellation';
+import { ProgressClient } from './progress-service-protocol';
+import { MessageService } from './message-service';
+
+@injectable()
+export class ProgressService {
+
+    @inject(ProgressClient) protected readonly client: ProgressClient;
+    @inject(MessageService) protected readonly messageService: MessageService;
+
+    async showProgress(message: ProgressMessage, onDidCancel?: () => void): Promise<Progress> {
+        if (this.shouldDelegate(message)) {
+            return this.messageService.showProgress(message, onDidCancel);
+        }
+        const id = this.newProgressId();
+        const cancellationSource = new CancellationTokenSource();
+        const report = (update: ProgressUpdate) => {
+            this.client.reportProgress(id, update, message, cancellationSource.token);
+        };
+        const actions = new Set<string>(message.actions);
+        if (ProgressMessage.isCancelable(message)) {
+            actions.delete(ProgressMessage.Cancel);
+            actions.add(ProgressMessage.Cancel);
+        }
+        const clientMessage = { ...message, actions: Array.from(actions) };
+        const result = this.client.showProgress(id, clientMessage, cancellationSource.token);
+        if (ProgressMessage.isCancelable(message) && typeof onDidCancel === 'function') {
+            result.then(value => {
+                if (value === ProgressMessage.Cancel) {
+                    onDidCancel();
+                }
+            });
+        }
+        return {
+            id,
+            cancel: () => cancellationSource.cancel(),
+            result,
+            report
+        };
+    }
+    protected shouldDelegate(message: ProgressMessage): boolean {
+        const location = message.options && message.options.location;
+        return location === 'notification';
+    }
+
+    private progressIdPrefix = Math.random().toString(36).substring(5);
+    private counter = 0;
+    protected newProgressId(): string {
+        return `${this.progressIdPrefix}-${++this.counter}`;
+    }
+
+    async withProgress<T>(text: string, locationId: string, task: () => Promise<T>, onDidCancel?: () => void): Promise<T> {
+        const progress = await this.showProgress({ text, options: { cancelable: true, location: locationId } }, onDidCancel);
+        try {
+            return await task();
+        } finally {
+            progress.cancel();
+        }
+    }
+}