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

package/src/common/contribution-filter/contribution-filter-registry.ts

@@ -1,79 +1,79 @@
-// *****************************************************************************
-// Copyright (C) 2021 STMicroelectronics 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, multiInject, optional } from 'inversify';
-import { ContributionFilterRegistry, ContributionType, FilterContribution } from './contribution-filter';
-import { Filter } from './filter';
-
-/**
- * Registry of contribution filters.
- *
- * Implement/bind to the `FilterContribution` interface/symbol to register your contribution filters.
- */
-@injectable()
-export class ContributionFilterRegistryImpl implements ContributionFilterRegistry {
-
-    protected initialized = false;
-    protected genericFilters: Filter<Object>[] = [];
-    protected typeToFilters = new Map<ContributionType, Filter<Object>[]>();
-
-    constructor(
-        @multiInject(FilterContribution) @optional() contributions: FilterContribution[] = []
-    ) {
-        for (const contribution of contributions) {
-            contribution.registerContributionFilters(this);
-        }
-        this.initialized = true;
-    }
-
-    addFilters(types: '*' | ContributionType[], filters: Filter<Object>[]): void {
-        if (this.initialized) {
-            throw new Error('cannot add filters after initialization is done.');
-        } else if (types === '*') {
-            this.genericFilters.push(...filters);
-        } else {
-            for (const type of types) {
-                this.getOrCreate(type).push(...filters);
-            }
-        }
-    }
-
-    applyFilters<T extends Object>(toFilter: T[], type: ContributionType): T[] {
-        const filters = this.getFilters(type);
-        if (filters.length === 0) {
-            return toFilter;
-        }
-        return toFilter.filter(
-            object => filters.every(filter => filter(object))
-        );
-    }
-
-    protected getOrCreate(type: ContributionType): Filter<Object>[] {
-        let value = this.typeToFilters.get(type);
-        if (value === undefined) {
-            this.typeToFilters.set(type, value = []);
-        }
-        return value;
-    }
-
-    protected getFilters(type: ContributionType): Filter<Object>[] {
-        return [
-            ...this.typeToFilters.get(type) || [],
-            ...this.genericFilters
-        ];
-    }
-}
-
+// *****************************************************************************
+// Copyright (C) 2021 STMicroelectronics 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, multiInject, optional } from 'inversify';
+import { ContributionFilterRegistry, ContributionType, FilterContribution } from './contribution-filter';
+import { Filter } from './filter';
+
+/**
+ * Registry of contribution filters.
+ *
+ * Implement/bind to the `FilterContribution` interface/symbol to register your contribution filters.
+ */
+@injectable()
+export class ContributionFilterRegistryImpl implements ContributionFilterRegistry {
+
+    protected initialized = false;
+    protected genericFilters: Filter<Object>[] = [];
+    protected typeToFilters = new Map<ContributionType, Filter<Object>[]>();
+
+    constructor(
+        @multiInject(FilterContribution) @optional() contributions: FilterContribution[] = []
+    ) {
+        for (const contribution of contributions) {
+            contribution.registerContributionFilters(this);
+        }
+        this.initialized = true;
+    }
+
+    addFilters(types: '*' | ContributionType[], filters: Filter<Object>[]): void {
+        if (this.initialized) {
+            throw new Error('cannot add filters after initialization is done.');
+        } else if (types === '*') {
+            this.genericFilters.push(...filters);
+        } else {
+            for (const type of types) {
+                this.getOrCreate(type).push(...filters);
+            }
+        }
+    }
+
+    applyFilters<T extends Object>(toFilter: T[], type: ContributionType): T[] {
+        const filters = this.getFilters(type);
+        if (filters.length === 0) {
+            return toFilter;
+        }
+        return toFilter.filter(
+            object => filters.every(filter => filter(object))
+        );
+    }
+
+    protected getOrCreate(type: ContributionType): Filter<Object>[] {
+        let value = this.typeToFilters.get(type);
+        if (value === undefined) {
+            this.typeToFilters.set(type, value = []);
+        }
+        return value;
+    }
+
+    protected getFilters(type: ContributionType): Filter<Object>[] {
+        return [
+            ...this.typeToFilters.get(type) || [],
+            ...this.genericFilters
+        ];
+    }
+}
+

package/src/common/contribution-filter/contribution-filter.ts

@@ -1,64 +1,64 @@
-// *****************************************************************************
-// Copyright (C) 2021 STMicroelectronics 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 { interfaces } from 'inversify';
-import { Filter } from './filter';
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type ContributionType = interfaces.ServiceIdentifier<any>;
-
-export const ContributionFilterRegistry = Symbol('ContributionFilterRegistry');
-export interface ContributionFilterRegistry {
-
-    /**
-     * Add filters to be applied for every type of contribution.
-     */
-    addFilters(types: '*', filters: Filter<Object>[]): void;
-
-    /**
-     * Given a list of contribution types, register filters to apply.
-     * @param types types for which to register the filters.
-     */
-    addFilters(types: ContributionType[], filters: Filter<Object>[]): void;
-
-    /**
-     * Applies the filters for the given contribution type. Generic filters will be applied on any given type.
-     * @param toFilter the elements to filter
-     * @param type the contribution type for which potentially filters were registered
-     * @returns the filtered elements
-     */
-    applyFilters<T extends Object>(toFilter: T[], type: ContributionType): T[]
-}
-
-export const FilterContribution = Symbol('FilterContribution');
-/**
- * Register filters to remove contributions.
- */
-export interface FilterContribution {
-    /**
-     * Use the registry to register your contribution filters.
-     * * Note that filtering contributions based on their class (constructor) name is discouraged.
-     * Class names are minified in production builds and therefore not reliable.
-     * Use instance of checks or direct constructor comparison instead:
-     *
-     * ```ts
-     * registry.addFilters('*', [
-     *     contrib => !(contrib instanceof SampleFilteredCommandContribution)
-     * ]);
-     * ```
-     */
-    registerContributionFilters(registry: ContributionFilterRegistry): void;
-}
+// *****************************************************************************
+// Copyright (C) 2021 STMicroelectronics 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 { interfaces } from 'inversify';
+import { Filter } from './filter';
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type ContributionType = interfaces.ServiceIdentifier<any>;
+
+export const ContributionFilterRegistry = Symbol('ContributionFilterRegistry');
+export interface ContributionFilterRegistry {
+
+    /**
+     * Add filters to be applied for every type of contribution.
+     */
+    addFilters(types: '*', filters: Filter<Object>[]): void;
+
+    /**
+     * Given a list of contribution types, register filters to apply.
+     * @param types types for which to register the filters.
+     */
+    addFilters(types: ContributionType[], filters: Filter<Object>[]): void;
+
+    /**
+     * Applies the filters for the given contribution type. Generic filters will be applied on any given type.
+     * @param toFilter the elements to filter
+     * @param type the contribution type for which potentially filters were registered
+     * @returns the filtered elements
+     */
+    applyFilters<T extends Object>(toFilter: T[], type: ContributionType): T[]
+}
+
+export const FilterContribution = Symbol('FilterContribution');
+/**
+ * Register filters to remove contributions.
+ */
+export interface FilterContribution {
+    /**
+     * Use the registry to register your contribution filters.
+     * * Note that filtering contributions based on their class (constructor) name is discouraged.
+     * Class names are minified in production builds and therefore not reliable.
+     * Use instance of checks or direct constructor comparison instead:
+     *
+     * ```ts
+     * registry.addFilters('*', [
+     *     contrib => !(contrib instanceof SampleFilteredCommandContribution)
+     * ]);
+     * ```
+     */
+    registerContributionFilters(registry: ContributionFilterRegistry): void;
+}

package/src/common/contribution-filter/filter.ts

@@ -1,23 +1,23 @@
-// *****************************************************************************
-// Copyright (C) 2021 STMicroelectronics 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 const Filter = Symbol('Filter');
-
-/**
- * @param toTest Object that should be tested
- * @returns `true` if the object passes the test, `false` otherwise.
- */
-export type Filter<T extends Object> = (toTest: T) => boolean;
+// *****************************************************************************
+// Copyright (C) 2021 STMicroelectronics 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 const Filter = Symbol('Filter');
+
+/**
+ * @param toTest Object that should be tested
+ * @returns `true` if the object passes the test, `false` otherwise.
+ */
+export type Filter<T extends Object> = (toTest: T) => boolean;

package/src/common/contribution-filter/index.ts

@@ -1,19 +1,19 @@
-// *****************************************************************************
-// Copyright (C) 2021 STMicroelectronics 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 * from './contribution-filter';
-export * from './contribution-filter-registry';
-export * from './filter';
+// *****************************************************************************
+// Copyright (C) 2021 STMicroelectronics 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 * from './contribution-filter';
+export * from './contribution-filter-registry';
+export * from './filter';

package/src/common/contribution-provider.ts

@@ -1,96 +1,96 @@
-// *****************************************************************************
-// 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 { interfaces } from 'inversify';
-import { ContributionFilterRegistry } from './contribution-filter';
-
-export const ContributionProvider = Symbol('ContributionProvider');
-
-export interface ContributionProvider<T extends object> {
-
-    /**
-     * @param recursive `true` if the contributions should be collected from the parent containers as well. Otherwise, `false`. It is `false` by default.
-     */
-    getContributions(recursive?: boolean): T[]
-}
-
-class ContainerBasedContributionProvider<T extends object> implements ContributionProvider<T> {
-
-    protected services: T[] | undefined;
-
-    constructor(
-        protected readonly serviceIdentifier: interfaces.ServiceIdentifier<T>,
-        protected readonly container: interfaces.Container
-    ) { }
-
-    getContributions(recursive?: boolean): T[] {
-        if (this.services === undefined) {
-            const currentServices: T[] = [];
-            let filterRegistry: ContributionFilterRegistry | undefined;
-            let currentContainer: interfaces.Container | null = this.container;
-            // eslint-disable-next-line no-null/no-null
-            while (currentContainer !== null) {
-                if (currentContainer.isBound(this.serviceIdentifier)) {
-                    try {
-                        currentServices.push(...currentContainer.getAll(this.serviceIdentifier));
-                    } catch (error) {
-                        console.error(error);
-                    }
-                }
-                if (filterRegistry === undefined && currentContainer.isBound(ContributionFilterRegistry)) {
-                    filterRegistry = currentContainer.get(ContributionFilterRegistry);
-                }
-                // eslint-disable-next-line no-null/no-null
-                currentContainer = recursive === true ? currentContainer.parent : null;
-            }
-
-            this.services = filterRegistry ? filterRegistry.applyFilters(currentServices, this.serviceIdentifier) : currentServices;
-
-        }
-        return this.services;
-    }
-}
-
-export type Bindable = interfaces.Bind | interfaces.Container;
-export namespace Bindable {
-    export function isContainer(arg: Bindable): arg is interfaces.Container {
-        return typeof arg !== 'function'
-            // https://github.com/eclipse-theia/theia/issues/3204#issue-371029654
-            // In InversifyJS `4.14.0` containers no longer have a property `guid`.
-            && ('guid' in arg || 'parent' in arg);
-    }
-}
-
-export function bindContributionProvider(bindable: Bindable, id: symbol): void {
-    const bindingToSyntax = (Bindable.isContainer(bindable) ? bindable.bind(ContributionProvider) : bindable(ContributionProvider));
-    bindingToSyntax
-        .toDynamicValue(ctx => new ContainerBasedContributionProvider(id, ctx.container))
-        .inSingletonScope().whenTargetNamed(id);
-}
-
-/**
- * Helper function to bind a service to a list of contributions easily.
- * @param bindable a Container or the bind function directly.
- * @param service an already bound service to refer the contributions to.
- * @param contributions array of contribution identifiers to bind the service to.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export function bindContribution(bindable: Bindable, service: interfaces.ServiceIdentifier<any>, contributions: interfaces.ServiceIdentifier<any>[]): void {
-    const bind: interfaces.Bind = Bindable.isContainer(bindable) ? bindable.bind.bind(bindable) : bindable;
-    for (const contribution of contributions) {
-        bind(contribution).toService(service);
-    }
-}
+// *****************************************************************************
+// 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 { interfaces } from 'inversify';
+import { ContributionFilterRegistry } from './contribution-filter';
+
+export const ContributionProvider = Symbol('ContributionProvider');
+
+export interface ContributionProvider<T extends object> {
+
+    /**
+     * @param recursive `true` if the contributions should be collected from the parent containers as well. Otherwise, `false`. It is `false` by default.
+     */
+    getContributions(recursive?: boolean): T[]
+}
+
+class ContainerBasedContributionProvider<T extends object> implements ContributionProvider<T> {
+
+    protected services: T[] | undefined;
+
+    constructor(
+        protected readonly serviceIdentifier: interfaces.ServiceIdentifier<T>,
+        protected readonly container: interfaces.Container
+    ) { }
+
+    getContributions(recursive?: boolean): T[] {
+        if (this.services === undefined) {
+            const currentServices: T[] = [];
+            let filterRegistry: ContributionFilterRegistry | undefined;
+            let currentContainer: interfaces.Container | null = this.container;
+            // eslint-disable-next-line no-null/no-null
+            while (currentContainer !== null) {
+                if (currentContainer.isBound(this.serviceIdentifier)) {
+                    try {
+                        currentServices.push(...currentContainer.getAll(this.serviceIdentifier));
+                    } catch (error) {
+                        console.error(error);
+                    }
+                }
+                if (filterRegistry === undefined && currentContainer.isBound(ContributionFilterRegistry)) {
+                    filterRegistry = currentContainer.get(ContributionFilterRegistry);
+                }
+                // eslint-disable-next-line no-null/no-null
+                currentContainer = recursive === true ? currentContainer.parent : null;
+            }
+
+            this.services = filterRegistry ? filterRegistry.applyFilters(currentServices, this.serviceIdentifier) : currentServices;
+
+        }
+        return this.services;
+    }
+}
+
+export type Bindable = interfaces.Bind | interfaces.Container;
+export namespace Bindable {
+    export function isContainer(arg: Bindable): arg is interfaces.Container {
+        return typeof arg !== 'function'
+            // https://github.com/eclipse-theia/theia/issues/3204#issue-371029654
+            // In InversifyJS `4.14.0` containers no longer have a property `guid`.
+            && ('guid' in arg || 'parent' in arg);
+    }
+}
+
+export function bindContributionProvider(bindable: Bindable, id: symbol): void {
+    const bindingToSyntax = (Bindable.isContainer(bindable) ? bindable.bind(ContributionProvider) : bindable(ContributionProvider));
+    bindingToSyntax
+        .toDynamicValue(ctx => new ContainerBasedContributionProvider(id, ctx.container))
+        .inSingletonScope().whenTargetNamed(id);
+}
+
+/**
+ * Helper function to bind a service to a list of contributions easily.
+ * @param bindable a Container or the bind function directly.
+ * @param service an already bound service to refer the contributions to.
+ * @param contributions array of contribution identifiers to bind the service to.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function bindContribution(bindable: Bindable, service: interfaces.ServiceIdentifier<any>, contributions: interfaces.ServiceIdentifier<any>[]): void {
+    const bind: interfaces.Bind = Bindable.isContainer(bindable) ? bindable.bind.bind(bindable) : bindable;
+    for (const contribution of contributions) {
+        bind(contribution).toService(service);
+    }
+}