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

package/src/browser/quick-input/quick-help-service.ts

@@ -1,87 +1,87 @@
-// *****************************************************************************
-// 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 { inject, injectable } from 'inversify';
-import { CancellationToken } from '../../common';
-import { QuickAccessContribution, QuickAccessProvider, QuickAccessRegistry } from './quick-access';
-import { QuickInputService, QuickPickItem, QuickPickSeparator } from './quick-input-service';
-
-@injectable()
-export class QuickHelpService implements QuickAccessProvider, QuickAccessContribution {
-    static PREFIX = '?';
-
-    @inject(QuickAccessRegistry)
-    protected quickAccessRegistry: QuickAccessRegistry;
-
-    @inject(QuickInputService)
-    protected quickInputService: QuickInputService;
-
-    getPicks(filter: string, token: CancellationToken): (QuickPickItem | QuickPickSeparator)[] {
-        const { editorProviders, globalProviders } = this.getQuickAccessProviders();
-        const result: (QuickPickItem | QuickPickSeparator)[] = editorProviders.length === 0 || globalProviders.length === 0 ?
-            // Without groups
-            [
-                ...(editorProviders.length === 0 ? globalProviders : editorProviders)
-            ] :
-
-            // With groups
-            [
-                { type: 'separator', label: 'global commands' },
-                ...globalProviders,
-                { type: 'separator', label: 'editor commands' },
-                ...editorProviders
-            ];
-        return result;
-    }
-
-    private getQuickAccessProviders(): { editorProviders: QuickPickItem[], globalProviders: QuickPickItem[] } {
-        const globalProviders: QuickPickItem[] = [];
-        const editorProviders: QuickPickItem[] = [];
-
-        const providers = this.quickAccessRegistry.getQuickAccessProviders();
-
-        for (const provider of providers.sort((providerA, providerB) => providerA.prefix.localeCompare(providerB.prefix))) {
-            if (provider.prefix === QuickHelpService.PREFIX) {
-                continue; // exclude help which is already active
-            }
-
-            for (const helpEntry of provider.helpEntries) {
-                const prefix = helpEntry.prefix || provider.prefix;
-                const label = prefix || '\u2026' /* ... */;
-
-                (helpEntry.needsEditor ? editorProviders : globalProviders).push({
-                    label,
-                    ariaLabel: `${label}, ${helpEntry.description}`,
-                    description: helpEntry.description,
-                    execute: () => this.quickInputService.open(prefix)
-                });
-            }
-        }
-
-        return { editorProviders, globalProviders };
-    }
-
-    registerQuickAccessProvider(): void {
-        this.quickAccessRegistry.registerQuickAccessProvider(
-            {
-                getInstance: () => this,
-                prefix: QuickHelpService.PREFIX,
-                placeholder: 'Type "?" to get help on the actions you can take from here.',
-                helpEntries: [{ description: 'Show all Quick Access Providers', needsEditor: false }]
-            }
-        );
-    }
-}
+// *****************************************************************************
+// 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 { inject, injectable } from 'inversify';
+import { CancellationToken } from '../../common';
+import { QuickAccessContribution, QuickAccessProvider, QuickAccessRegistry } from './quick-access';
+import { QuickInputService, QuickPickItem, QuickPickSeparator } from './quick-input-service';
+
+@injectable()
+export class QuickHelpService implements QuickAccessProvider, QuickAccessContribution {
+    static PREFIX = '?';
+
+    @inject(QuickAccessRegistry)
+    protected quickAccessRegistry: QuickAccessRegistry;
+
+    @inject(QuickInputService)
+    protected quickInputService: QuickInputService;
+
+    getPicks(filter: string, token: CancellationToken): (QuickPickItem | QuickPickSeparator)[] {
+        const { editorProviders, globalProviders } = this.getQuickAccessProviders();
+        const result: (QuickPickItem | QuickPickSeparator)[] = editorProviders.length === 0 || globalProviders.length === 0 ?
+            // Without groups
+            [
+                ...(editorProviders.length === 0 ? globalProviders : editorProviders)
+            ] :
+
+            // With groups
+            [
+                { type: 'separator', label: 'global commands' },
+                ...globalProviders,
+                { type: 'separator', label: 'editor commands' },
+                ...editorProviders
+            ];
+        return result;
+    }
+
+    private getQuickAccessProviders(): { editorProviders: QuickPickItem[], globalProviders: QuickPickItem[] } {
+        const globalProviders: QuickPickItem[] = [];
+        const editorProviders: QuickPickItem[] = [];
+
+        const providers = this.quickAccessRegistry.getQuickAccessProviders();
+
+        for (const provider of providers.sort((providerA, providerB) => providerA.prefix.localeCompare(providerB.prefix))) {
+            if (provider.prefix === QuickHelpService.PREFIX) {
+                continue; // exclude help which is already active
+            }
+
+            for (const helpEntry of provider.helpEntries) {
+                const prefix = helpEntry.prefix || provider.prefix;
+                const label = prefix || '\u2026' /* ... */;
+
+                (helpEntry.needsEditor ? editorProviders : globalProviders).push({
+                    label,
+                    ariaLabel: `${label}, ${helpEntry.description}`,
+                    description: helpEntry.description,
+                    execute: () => this.quickInputService.open(prefix)
+                });
+            }
+        }
+
+        return { editorProviders, globalProviders };
+    }
+
+    registerQuickAccessProvider(): void {
+        this.quickAccessRegistry.registerQuickAccessProvider(
+            {
+                getInstance: () => this,
+                prefix: QuickHelpService.PREFIX,
+                placeholder: 'Type "?" to get help on the actions you can take from here.',
+                helpEntries: [{ description: 'Show all Quick Access Providers', needsEditor: false }]
+            }
+        );
+    }
+}

package/src/browser/quick-input/quick-input-frontend-contribution.ts

@@ -1,33 +1,33 @@
-// *****************************************************************************
-// 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, inject, named } from 'inversify';
-import { ContributionProvider } from '../../common';
-import { FrontendApplicationContribution } from '../frontend-application-contribution';
-import { QuickAccessContribution } from './quick-access';
-
-@injectable()
-export class QuickInputFrontendContribution implements FrontendApplicationContribution {
-
-    @inject(ContributionProvider) @named(QuickAccessContribution)
-    protected readonly contributionProvider: ContributionProvider<QuickAccessContribution>;
-
-    onStart(): void {
-        this.contributionProvider.getContributions().forEach(contrib => {
-            contrib.registerQuickAccessProvider();
-        });
-    }
-}
+// *****************************************************************************
+// 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, inject, named } from 'inversify';
+import { ContributionProvider } from '../../common';
+import { FrontendApplicationContribution } from '../frontend-application-contribution';
+import { QuickAccessContribution } from './quick-access';
+
+@injectable()
+export class QuickInputFrontendContribution implements FrontendApplicationContribution {
+
+    @inject(ContributionProvider) @named(QuickAccessContribution)
+    protected readonly contributionProvider: ContributionProvider<QuickAccessContribution>;
+
+    onStart(): void {
+        this.contributionProvider.getContributions().forEach(contrib => {
+            contrib.registerQuickAccessProvider();
+        });
+    }
+}

package/src/browser/quick-input/quick-input-service.spec.ts

@@ -1,176 +1,176 @@
-// *****************************************************************************
-// 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 * as chai from 'chai';
-import { filterItems, findMatches, QuickPickItem } from './quick-input-service';
-
-const expect = chai.expect;
-
-describe('quick-input-service', () => {
-
-    describe('#findMatches', () => {
-
-        it('should return the proper highlights when matches are found', () => {
-            expect(findMatches('abc', 'a')).deep.equal([{ start: 0, end: 1 }]);
-            expect(findMatches('abc', 'ab')).deep.equal([{ start: 0, end: 1 }, { start: 1, end: 2 }]);
-            expect(findMatches('abc', 'ac')).deep.equal([{ start: 0, end: 1 }, { start: 2, end: 3 }]);
-            expect(findMatches('abc', 'abc')).deep.equal([{ start: 0, end: 1 }, { start: 1, end: 2 }, { start: 2, end: 3 }]);
-        });
-
-        it('should fail when out of order', () => {
-            expect(findMatches('abc', 'ba')).equal(undefined);
-        });
-
-        it('should return `undefined` when no matches are found', () => {
-            expect(findMatches('abc', 'f')).equal(undefined);
-        });
-
-        it('should return `undefined` when no filter is present', () => {
-            expect(findMatches('abc', '')).equal(undefined);
-        });
-
-    });
-
-    describe('#filterItems', () => {
-
-        let items: QuickPickItem[] = [];
-
-        beforeEach(() => {
-            items = [
-                { label: 'a' },
-                { label: 'abc', description: 'v' },
-                { label: 'def', description: 'd', detail: 'y' },
-                { label: 'z', description: 'z', detail: 'z' }
-            ];
-        });
-
-        it('should return the full list when no filter is present', () => {
-            const result = filterItems(items, '');
-            expect(result).deep.equal(items);
-        });
-
-        it('should filter items based on the label', () => {
-            const expectation: QuickPickItem = {
-                label: 'abc',
-                highlights: {
-                    label: [
-                        { start: 0, end: 1 },
-                        { start: 1, end: 2 },
-                        { start: 2, end: 3 }
-                    ]
-                }
-            };
-            const result = filterItems(items, 'abc').filter(QuickPickItem.is);
-            expect(result).length(1);
-            expect(result[0].label).equal(expectation.label);
-            expect(result[0].highlights?.label).deep.equal(expectation.highlights?.label);
-        });
-
-        it('should filter items based on `description` if `label` does not match', () => {
-            const expectation: QuickPickItem = {
-                label: 'abc',
-                description: 'v',
-                highlights: {
-                    description: [
-                        { start: 0, end: 1 }
-                    ]
-                }
-            };
-            const result = filterItems(items, 'v').filter(QuickPickItem.is);
-            expect(result).length(1);
-            expect(result[0].label).equal(expectation.label);
-            expect(result[0].description).equal(expectation.description);
-            expect(result[0].highlights?.label).equal(undefined);
-            expect(result[0].highlights?.description).deep.equal(expectation.highlights?.description);
-        });
-
-        it('should filter items based on `detail` if `label` and `description` does not match', () => {
-            const expectation: QuickPickItem = {
-                label: 'def',
-                description: 'd',
-                detail: 'y',
-                highlights: {
-                    detail: [
-                        { start: 0, end: 1 }
-                    ]
-                }
-            };
-            const result = filterItems(items, 'y').filter(QuickPickItem.is);
-            expect(result).length(1);
-            expect(result[0].label).equal(expectation.label);
-            expect(result[0].description).equal(expectation.description);
-            expect(result[0].detail).equal(expectation.detail);
-            expect(result[0].highlights?.label).equal(undefined);
-            expect(result[0].highlights?.description).equal(undefined);
-            expect(result[0].highlights?.detail).deep.equal(expectation.highlights?.detail);
-        });
-
-        it('should return multiple highlights if it matches multiple properties', () => {
-            const expectation: QuickPickItem = {
-                label: 'z',
-                description: 'z',
-                detail: 'z',
-                highlights: {
-                    label: [
-                        { start: 0, end: 1 }
-                    ],
-                    description: [
-                        { start: 0, end: 1 }
-                    ],
-                    detail: [
-                        { start: 0, end: 1 }
-                    ]
-                }
-            };
-            const result = filterItems(items, 'z').filter(QuickPickItem.is);
-            expect(result).length(1);
-
-            expect(result[0].label).equal(expectation.label);
-            expect(result[0].description).equal(expectation.description);
-            expect(result[0].detail).equal(expectation.detail);
-
-            expect(result[0].highlights?.label).deep.equal(expectation.highlights?.label);
-            expect(result[0].highlights?.description).deep.equal(expectation.highlights?.description);
-            expect(result[0].highlights?.detail).deep.equal(expectation.highlights?.detail);
-        });
-
-        it('should reset highlights upon subsequent searches', () => {
-            const expectation: QuickPickItem = {
-                label: 'abc',
-                highlights: {
-                    label: [
-                        { start: 0, end: 1 },
-                        { start: 1, end: 2 },
-                        { start: 2, end: 3 }
-                    ]
-                }
-            };
-            let result = filterItems(items, 'abc').filter(QuickPickItem.is);
-            expect(result).length(1);
-            expect(result[0].label).equal(expectation.label);
-            expect(result[0].highlights?.label).deep.equal(expectation.highlights?.label);
-
-            result = filterItems(items, '').filter(QuickPickItem.is);
-            expect(result[0].highlights?.label).equal(undefined);
-        });
-
-        it('should return an empty list when no matches are found', () => {
-            expect(filterItems(items, 'yyy')).deep.equal([]);
-        });
-
-    });
-
-});
+// *****************************************************************************
+// 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 * as chai from 'chai';
+import { filterItems, findMatches, QuickPickItem } from './quick-input-service';
+
+const expect = chai.expect;
+
+describe('quick-input-service', () => {
+
+    describe('#findMatches', () => {
+
+        it('should return the proper highlights when matches are found', () => {
+            expect(findMatches('abc', 'a')).deep.equal([{ start: 0, end: 1 }]);
+            expect(findMatches('abc', 'ab')).deep.equal([{ start: 0, end: 1 }, { start: 1, end: 2 }]);
+            expect(findMatches('abc', 'ac')).deep.equal([{ start: 0, end: 1 }, { start: 2, end: 3 }]);
+            expect(findMatches('abc', 'abc')).deep.equal([{ start: 0, end: 1 }, { start: 1, end: 2 }, { start: 2, end: 3 }]);
+        });
+
+        it('should fail when out of order', () => {
+            expect(findMatches('abc', 'ba')).equal(undefined);
+        });
+
+        it('should return `undefined` when no matches are found', () => {
+            expect(findMatches('abc', 'f')).equal(undefined);
+        });
+
+        it('should return `undefined` when no filter is present', () => {
+            expect(findMatches('abc', '')).equal(undefined);
+        });
+
+    });
+
+    describe('#filterItems', () => {
+
+        let items: QuickPickItem[] = [];
+
+        beforeEach(() => {
+            items = [
+                { label: 'a' },
+                { label: 'abc', description: 'v' },
+                { label: 'def', description: 'd', detail: 'y' },
+                { label: 'z', description: 'z', detail: 'z' }
+            ];
+        });
+
+        it('should return the full list when no filter is present', () => {
+            const result = filterItems(items, '');
+            expect(result).deep.equal(items);
+        });
+
+        it('should filter items based on the label', () => {
+            const expectation: QuickPickItem = {
+                label: 'abc',
+                highlights: {
+                    label: [
+                        { start: 0, end: 1 },
+                        { start: 1, end: 2 },
+                        { start: 2, end: 3 }
+                    ]
+                }
+            };
+            const result = filterItems(items, 'abc').filter(QuickPickItem.is);
+            expect(result).length(1);
+            expect(result[0].label).equal(expectation.label);
+            expect(result[0].highlights?.label).deep.equal(expectation.highlights?.label);
+        });
+
+        it('should filter items based on `description` if `label` does not match', () => {
+            const expectation: QuickPickItem = {
+                label: 'abc',
+                description: 'v',
+                highlights: {
+                    description: [
+                        { start: 0, end: 1 }
+                    ]
+                }
+            };
+            const result = filterItems(items, 'v').filter(QuickPickItem.is);
+            expect(result).length(1);
+            expect(result[0].label).equal(expectation.label);
+            expect(result[0].description).equal(expectation.description);
+            expect(result[0].highlights?.label).equal(undefined);
+            expect(result[0].highlights?.description).deep.equal(expectation.highlights?.description);
+        });
+
+        it('should filter items based on `detail` if `label` and `description` does not match', () => {
+            const expectation: QuickPickItem = {
+                label: 'def',
+                description: 'd',
+                detail: 'y',
+                highlights: {
+                    detail: [
+                        { start: 0, end: 1 }
+                    ]
+                }
+            };
+            const result = filterItems(items, 'y').filter(QuickPickItem.is);
+            expect(result).length(1);
+            expect(result[0].label).equal(expectation.label);
+            expect(result[0].description).equal(expectation.description);
+            expect(result[0].detail).equal(expectation.detail);
+            expect(result[0].highlights?.label).equal(undefined);
+            expect(result[0].highlights?.description).equal(undefined);
+            expect(result[0].highlights?.detail).deep.equal(expectation.highlights?.detail);
+        });
+
+        it('should return multiple highlights if it matches multiple properties', () => {
+            const expectation: QuickPickItem = {
+                label: 'z',
+                description: 'z',
+                detail: 'z',
+                highlights: {
+                    label: [
+                        { start: 0, end: 1 }
+                    ],
+                    description: [
+                        { start: 0, end: 1 }
+                    ],
+                    detail: [
+                        { start: 0, end: 1 }
+                    ]
+                }
+            };
+            const result = filterItems(items, 'z').filter(QuickPickItem.is);
+            expect(result).length(1);
+
+            expect(result[0].label).equal(expectation.label);
+            expect(result[0].description).equal(expectation.description);
+            expect(result[0].detail).equal(expectation.detail);
+
+            expect(result[0].highlights?.label).deep.equal(expectation.highlights?.label);
+            expect(result[0].highlights?.description).deep.equal(expectation.highlights?.description);
+            expect(result[0].highlights?.detail).deep.equal(expectation.highlights?.detail);
+        });
+
+        it('should reset highlights upon subsequent searches', () => {
+            const expectation: QuickPickItem = {
+                label: 'abc',
+                highlights: {
+                    label: [
+                        { start: 0, end: 1 },
+                        { start: 1, end: 2 },
+                        { start: 2, end: 3 }
+                    ]
+                }
+            };
+            let result = filterItems(items, 'abc').filter(QuickPickItem.is);
+            expect(result).length(1);
+            expect(result[0].label).equal(expectation.label);
+            expect(result[0].highlights?.label).deep.equal(expectation.highlights?.label);
+
+            result = filterItems(items, '').filter(QuickPickItem.is);
+            expect(result[0].highlights?.label).equal(undefined);
+        });
+
+        it('should return an empty list when no matches are found', () => {
+            expect(filterItems(items, 'yyy')).deep.equal([]);
+        });
+
+    });
+
+});

package/src/browser/quick-input/quick-input-service.ts

@@ -1,17 +1,17 @@
-// *****************************************************************************
-// 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
-// *****************************************************************************
-
-export * from '../../common/quick-pick-service';
+// *****************************************************************************
+// 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
+// *****************************************************************************
+
+export * from '../../common/quick-pick-service';