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

package/src/browser/tree/tree-compression/tree-compression-service.ts

@@ -1,125 +1,125 @@
-// *****************************************************************************
-// Copyright (C) 2021 SAP SE or an SAP affiliate company 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 } from 'inversify';
-import { ArrayUtils } from '../../../common/types';
-import { TreeNode } from '../tree';
-import { ExpandableTreeNode } from '../tree-expansion';
-
-export interface CompressionParent extends ExpandableTreeNode {
-    children: [CompressionChild];
-}
-
-export interface CompressionChild extends ExpandableTreeNode {
-    parent: CompressionParent;
-}
-
-export type CompressionParticipant = CompressionChild | CompressionParent;
-
-export interface CompressionHead extends CompressionParent {
-    parent: ExpandableTreeNode;
-}
-
-export interface CompressionTail extends CompressionChild { }
-
-export const CompressionToggle = Symbol('CompressionToggle');
-export interface CompressionToggle {
-    compress: boolean;
-}
-
-@injectable()
-export class TreeCompressionService {
-    /**
-     * @returns `true` if the node has a single child that is a CompositeTreeNode
-     * In that case, the child can be shown in the same row as the parent.
-     */
-    isCompressionParent(node?: unknown): node is CompressionParent {
-        return this.isVisibleExpandableNode(node) && node.children.length === 1 && this.isVisibleExpandableNode(node.children[0]);
-    }
-
-    protected isVisibleExpandableNode(node?: unknown): node is ExpandableTreeNode {
-        return ExpandableTreeNode.is(node) && TreeNode.isVisible(node);
-    }
-
-    /**
-     * @returns `true` if the node is a CompositeTreeNode and is its parent's sole child
-     * In that case, the node can be shown in the same row as its parent.
-     */
-    isCompressionChild(node?: TreeNode): node is CompressionChild {
-        return this.isCompressionParent(node?.parent);
-    }
-
-    /**
-     * @returns `true` if the node is a CompositeTreeNode with a sole child, and the same is not true of its parent.
-     * In that case, the node will appear as the first member of a compressed row.
-     */
-    isCompressionHead(node?: unknown): node is CompressionHead {
-        return this.isCompressionParent(node) && !this.isCompressionParent(node.parent);
-    }
-
-    /**
-     * @returns `true` if the node's parent is a CompositeTreeNode with a sole child, and the same is not true of the node.
-     * In that case, the node will appear as the last member of a compressed row.
-     */
-    isCompressionTail(node?: TreeNode): node is CompressionTail {
-        return this.isCompressionChild(node) && !this.isCompressionParent(node);
-    }
-
-    /**
-     * @returns `true` if the node is part of a compression row, either a {@link CompressionChild} or {@link CompressionParent}
-     */
-    isCompressionParticipant(node?: TreeNode): node is CompressionParticipant {
-        return this.isCompressionParent(node) || this.isCompressionChild(node);
-    }
-
-    /**
-     * @returns a sequence of compressed items for the node if it is a {@link CompressionHead}.
-     */
-    getCompressedChildren(node?: CompressionHead): ArrayUtils.Tail<CompressionChild>;
-    getCompressedChildren(node: unknown): ArrayUtils.Tail<CompressionChild> | undefined {
-        if (this.isCompressionHead(node)) {
-            const items = [];
-            let next: TreeNode = node.children[0];
-            while (this.isCompressionChild(next)) {
-                items.push(next);
-                next = next.children[0];
-            }
-            return ArrayUtils.asTail(items);
-        }
-    }
-
-    /**
-     * @returns The {@link CompressionHead} of the node's compression chain, or undefined if the node is not a {@link CompressionParticipant}.
-     */
-    getCompressionHead(node?: TreeNode): CompressionHead | undefined {
-        while (this.isCompressionParticipant(node)) {
-            if (this.isCompressionHead(node)) {
-                return node;
-            }
-            node = node.parent;
-        }
-    }
-
-    /**
-     * @returns The compression chain of which the `node` is a part, or `undefined` if the `node` is not a {@link CompressionParticipant}
-     */
-    getCompressionChain(node?: TreeNode): ArrayUtils.HeadAndTail<CompressionParticipant> | undefined {
-        const head = this.getCompressionHead(node);
-        if (head) {
-            return ArrayUtils.asHeadAndTail([head as CompressionParticipant].concat(this.getCompressedChildren(head)));
-        }
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2021 SAP SE or an SAP affiliate company 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 } from 'inversify';
+import { ArrayUtils } from '../../../common/types';
+import { TreeNode } from '../tree';
+import { ExpandableTreeNode } from '../tree-expansion';
+
+export interface CompressionParent extends ExpandableTreeNode {
+    children: [CompressionChild];
+}
+
+export interface CompressionChild extends ExpandableTreeNode {
+    parent: CompressionParent;
+}
+
+export type CompressionParticipant = CompressionChild | CompressionParent;
+
+export interface CompressionHead extends CompressionParent {
+    parent: ExpandableTreeNode;
+}
+
+export interface CompressionTail extends CompressionChild { }
+
+export const CompressionToggle = Symbol('CompressionToggle');
+export interface CompressionToggle {
+    compress: boolean;
+}
+
+@injectable()
+export class TreeCompressionService {
+    /**
+     * @returns `true` if the node has a single child that is a CompositeTreeNode
+     * In that case, the child can be shown in the same row as the parent.
+     */
+    isCompressionParent(node?: unknown): node is CompressionParent {
+        return this.isVisibleExpandableNode(node) && node.children.length === 1 && this.isVisibleExpandableNode(node.children[0]);
+    }
+
+    protected isVisibleExpandableNode(node?: unknown): node is ExpandableTreeNode {
+        return ExpandableTreeNode.is(node) && TreeNode.isVisible(node);
+    }
+
+    /**
+     * @returns `true` if the node is a CompositeTreeNode and is its parent's sole child
+     * In that case, the node can be shown in the same row as its parent.
+     */
+    isCompressionChild(node?: TreeNode): node is CompressionChild {
+        return this.isCompressionParent(node?.parent);
+    }
+
+    /**
+     * @returns `true` if the node is a CompositeTreeNode with a sole child, and the same is not true of its parent.
+     * In that case, the node will appear as the first member of a compressed row.
+     */
+    isCompressionHead(node?: unknown): node is CompressionHead {
+        return this.isCompressionParent(node) && !this.isCompressionParent(node.parent);
+    }
+
+    /**
+     * @returns `true` if the node's parent is a CompositeTreeNode with a sole child, and the same is not true of the node.
+     * In that case, the node will appear as the last member of a compressed row.
+     */
+    isCompressionTail(node?: TreeNode): node is CompressionTail {
+        return this.isCompressionChild(node) && !this.isCompressionParent(node);
+    }
+
+    /**
+     * @returns `true` if the node is part of a compression row, either a {@link CompressionChild} or {@link CompressionParent}
+     */
+    isCompressionParticipant(node?: TreeNode): node is CompressionParticipant {
+        return this.isCompressionParent(node) || this.isCompressionChild(node);
+    }
+
+    /**
+     * @returns a sequence of compressed items for the node if it is a {@link CompressionHead}.
+     */
+    getCompressedChildren(node?: CompressionHead): ArrayUtils.Tail<CompressionChild>;
+    getCompressedChildren(node: unknown): ArrayUtils.Tail<CompressionChild> | undefined {
+        if (this.isCompressionHead(node)) {
+            const items = [];
+            let next: TreeNode = node.children[0];
+            while (this.isCompressionChild(next)) {
+                items.push(next);
+                next = next.children[0];
+            }
+            return ArrayUtils.asTail(items);
+        }
+    }
+
+    /**
+     * @returns The {@link CompressionHead} of the node's compression chain, or undefined if the node is not a {@link CompressionParticipant}.
+     */
+    getCompressionHead(node?: TreeNode): CompressionHead | undefined {
+        while (this.isCompressionParticipant(node)) {
+            if (this.isCompressionHead(node)) {
+                return node;
+            }
+            node = node.parent;
+        }
+    }
+
+    /**
+     * @returns The compression chain of which the `node` is a part, or `undefined` if the `node` is not a {@link CompressionParticipant}
+     */
+    getCompressionChain(node?: TreeNode): ArrayUtils.HeadAndTail<CompressionParticipant> | undefined {
+        const head = this.getCompressionHead(node);
+        if (head) {
+            return ArrayUtils.asHeadAndTail([head as CompressionParticipant].concat(this.getCompressedChildren(head)));
+        }
+    }
+}

package/src/browser/tree/tree-compression/tree-compression.css

@@ -1,28 +1,28 @@
-/********************************************************************************
- * Copyright (C) 2022 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
- ********************************************************************************/
-
-.theia-tree-compressed-selected {
-  text-decoration: underline;
-}
-
-.theia-tree-compressed-label-separator {
-  padding: 0 2px;
-  opacity: 0.5;
-}
-
-.theia-tree-compressed-label-part:hover {
-  text-decoration: underline;
-}
+/********************************************************************************
+ * Copyright (C) 2022 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
+ ********************************************************************************/
+
+.theia-tree-compressed-selected {
+  text-decoration: underline;
+}
+
+.theia-tree-compressed-label-separator {
+  padding: 0 2px;
+  opacity: 0.5;
+}
+
+.theia-tree-compressed-label-part:hover {
+  text-decoration: underline;
+}

package/src/browser/tree/tree-consistency.spec.ts

@@ -1,105 +1,105 @@
-// *****************************************************************************
-// 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 * as assert from 'assert';
-import { injectable } from 'inversify';
-import { createTreeTestContainer } from './test/tree-test-container';
-import { TreeImpl, CompositeTreeNode, TreeNode } from './tree';
-import { TreeModel } from './tree-model';
-import { ExpandableTreeNode } from './tree-expansion';
-import { TreeLabelProvider } from './tree-label-provider';
-
-@injectable()
-class ConsistencyTestTree extends TreeImpl {
-
-    public resolveCounter = 0;
-
-    protected override async resolveChildren(parent: CompositeTreeNode): Promise<TreeNode[]> {
-        if (parent.id === 'expandable') {
-            const step: () => Promise<TreeNode[]> = async () => {
-                // a predicate to emulate bad timing, i.e.
-                // children of a node gets resolved when a root is changed
-                if (this.root && this.root !== parent.parent) {
-                    this.resolveCounter++;
-                    return [];
-                } else {
-                    await new Promise(resolve => setTimeout(resolve, 10));
-                    return step();
-                }
-            };
-            return step();
-        }
-        return super.resolveChildren(parent);
-    }
-
-}
-
-/**
- * Return roots having the same id, but not object identity.
- */
-function createConsistencyTestRoot(rootName: string): CompositeTreeNode {
-    const children: TreeNode[] = [];
-    const root: CompositeTreeNode = {
-        id: 'root',
-        name: rootName,
-        parent: undefined,
-        children
-    };
-    const parent: ExpandableTreeNode = {
-        id: 'expandable',
-        name: 'expandable',
-        parent: root,
-        expanded: true,
-        children: []
-    };
-    children.push(parent);
-    return root;
-}
-
-describe('Tree Consistency', () => {
-
-    it('setting different tree roots should finish', async () => {
-        const container = createTreeTestContainer();
-        container.bind(TreeLabelProvider).toSelf().inSingletonScope();
-        const labelProvider = container.get(TreeLabelProvider);
-
-        container.bind(ConsistencyTestTree).toSelf();
-        container.rebind(TreeImpl).toService(ConsistencyTestTree);
-        const tree = container.get(ConsistencyTestTree);
-
-        const model = container.get<TreeModel>(TreeModel);
-
-        model.root = createConsistencyTestRoot('Foo');
-        await new Promise(resolve => setTimeout(resolve, 50));
-
-        model.root = createConsistencyTestRoot('Bar');
-        await new Promise(resolve => setTimeout(resolve, 50));
-
-        let resolveCounter = tree.resolveCounter;
-        assert.deepStrictEqual(tree.resolveCounter, 1);
-        for (let i = 0; i < 10; i++) {
-            await new Promise(resolve => setTimeout(resolve, 50));
-            if (resolveCounter === tree.resolveCounter) {
-                assert.deepStrictEqual(tree.resolveCounter, 1);
-                assert.deepStrictEqual(labelProvider.getName(model.root)!, 'Bar');
-                return;
-            }
-            resolveCounter = tree.resolveCounter;
-        }
-        assert.ok(false, 'Resolving does not stop, attempts: ' + tree.resolveCounter);
-    });
-
-});
+// *****************************************************************************
+// 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 * as assert from 'assert';
+import { injectable } from 'inversify';
+import { createTreeTestContainer } from './test/tree-test-container';
+import { TreeImpl, CompositeTreeNode, TreeNode } from './tree';
+import { TreeModel } from './tree-model';
+import { ExpandableTreeNode } from './tree-expansion';
+import { TreeLabelProvider } from './tree-label-provider';
+
+@injectable()
+class ConsistencyTestTree extends TreeImpl {
+
+    public resolveCounter = 0;
+
+    protected override async resolveChildren(parent: CompositeTreeNode): Promise<TreeNode[]> {
+        if (parent.id === 'expandable') {
+            const step: () => Promise<TreeNode[]> = async () => {
+                // a predicate to emulate bad timing, i.e.
+                // children of a node gets resolved when a root is changed
+                if (this.root && this.root !== parent.parent) {
+                    this.resolveCounter++;
+                    return [];
+                } else {
+                    await new Promise(resolve => setTimeout(resolve, 10));
+                    return step();
+                }
+            };
+            return step();
+        }
+        return super.resolveChildren(parent);
+    }
+
+}
+
+/**
+ * Return roots having the same id, but not object identity.
+ */
+function createConsistencyTestRoot(rootName: string): CompositeTreeNode {
+    const children: TreeNode[] = [];
+    const root: CompositeTreeNode = {
+        id: 'root',
+        name: rootName,
+        parent: undefined,
+        children
+    };
+    const parent: ExpandableTreeNode = {
+        id: 'expandable',
+        name: 'expandable',
+        parent: root,
+        expanded: true,
+        children: []
+    };
+    children.push(parent);
+    return root;
+}
+
+describe('Tree Consistency', () => {
+
+    it('setting different tree roots should finish', async () => {
+        const container = createTreeTestContainer();
+        container.bind(TreeLabelProvider).toSelf().inSingletonScope();
+        const labelProvider = container.get(TreeLabelProvider);
+
+        container.bind(ConsistencyTestTree).toSelf();
+        container.rebind(TreeImpl).toService(ConsistencyTestTree);
+        const tree = container.get(ConsistencyTestTree);
+
+        const model = container.get<TreeModel>(TreeModel);
+
+        model.root = createConsistencyTestRoot('Foo');
+        await new Promise(resolve => setTimeout(resolve, 50));
+
+        model.root = createConsistencyTestRoot('Bar');
+        await new Promise(resolve => setTimeout(resolve, 50));
+
+        let resolveCounter = tree.resolveCounter;
+        assert.deepStrictEqual(tree.resolveCounter, 1);
+        for (let i = 0; i < 10; i++) {
+            await new Promise(resolve => setTimeout(resolve, 50));
+            if (resolveCounter === tree.resolveCounter) {
+                assert.deepStrictEqual(tree.resolveCounter, 1);
+                assert.deepStrictEqual(labelProvider.getName(model.root)!, 'Bar');
+                return;
+            }
+            resolveCounter = tree.resolveCounter;
+        }
+        assert.ok(false, 'Resolving does not stop, attempts: ' + tree.resolveCounter);
+    });
+
+});

package/src/browser/tree/tree-container.spec.ts

@@ -1,45 +1,45 @@
-// *****************************************************************************
-// Copyright (C) 2022 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 * as assert from 'assert';
-import { Container } from 'inversify';
-import { createTreeContainer, isTreeServices } from './tree-container';
-import { TreeSearch } from './tree-search';
-import { defaultTreeProps, TreeProps } from './tree-widget';
-
-describe('TreeContainer', () => {
-    describe('IsTreeServices should accurately distinguish TreeProps from TreeContainerProps', () => {
-        it('should assign search:boolean to TreeProps', () => {
-            assert(isTreeServices({
-                ...defaultTreeProps, search: true, multiSelect: true, globalSelection: true, contextMenuPath: ['so-contextual']
-            }) === false);
-        });
-        it('should assign search:not-a-boolean to TreeContainerProps', () => {
-            assert(isTreeServices({ search: TreeSearch }) === true);
-        });
-        const nonDefault = { search: !defaultTreeProps.search, contextMenu: ['no-default-for-this'] };
-        it('should use props passed in as just props', () => {
-            const parent = new Container();
-            const child = createTreeContainer(parent, nonDefault);
-            assert.deepStrictEqual(child.get(TreeProps), { ...defaultTreeProps, ...nonDefault });
-        });
-        it('should use props passed in as part of TreeContainerProps', () => {
-            const parent = new Container();
-            const child = createTreeContainer(parent, { props: nonDefault });
-            assert.deepStrictEqual(child.get(TreeProps), { ...defaultTreeProps, ...nonDefault });
-        });
-    });
-});
+// *****************************************************************************
+// Copyright (C) 2022 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 * as assert from 'assert';
+import { Container } from 'inversify';
+import { createTreeContainer, isTreeServices } from './tree-container';
+import { TreeSearch } from './tree-search';
+import { defaultTreeProps, TreeProps } from './tree-widget';
+
+describe('TreeContainer', () => {
+    describe('IsTreeServices should accurately distinguish TreeProps from TreeContainerProps', () => {
+        it('should assign search:boolean to TreeProps', () => {
+            assert(isTreeServices({
+                ...defaultTreeProps, search: true, multiSelect: true, globalSelection: true, contextMenuPath: ['so-contextual']
+            }) === false);
+        });
+        it('should assign search:not-a-boolean to TreeContainerProps', () => {
+            assert(isTreeServices({ search: TreeSearch }) === true);
+        });
+        const nonDefault = { search: !defaultTreeProps.search, contextMenu: ['no-default-for-this'] };
+        it('should use props passed in as just props', () => {
+            const parent = new Container();
+            const child = createTreeContainer(parent, nonDefault);
+            assert.deepStrictEqual(child.get(TreeProps), { ...defaultTreeProps, ...nonDefault });
+        });
+        it('should use props passed in as part of TreeContainerProps', () => {
+            const parent = new Container();
+            const child = createTreeContainer(parent, { props: nonDefault });
+            assert.deepStrictEqual(child.get(TreeProps), { ...defaultTreeProps, ...nonDefault });
+        });
+    });
+});