@theia/variable-resolver 1.48.1 → 1.48.2

package/src/browser/variable-input.ts

@@ -1,47 +1,47 @@
-// *****************************************************************************
-// 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
-// *****************************************************************************
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-/*
- * copied from
- * https://github.com/microsoft/vscode/blob/0a34756cae4fc67739e60c708b04637089f8bb0d/src/vs/workbench/services/configurationResolver/common/configurationResolver.ts#L41-L63
- */
-export interface VariablePromptStringInput {
-    id: string;
-    type: 'promptString';
-    description: string;
-    default?: string;
-}
-
-export interface VariablePickStringInput {
-    id: string;
-    type: 'pickString';
-    description: string;
-    options: string[];
-    default?: string;
-}
-
-export interface VariableCommandInput {
-    id: string;
-    type: 'command';
-    command: string;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    args?: any;
-}
-
-export type VariableInput = VariablePromptStringInput | VariablePickStringInput | VariableCommandInput;
+// *****************************************************************************
+// 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
+// *****************************************************************************
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+/*
+ * copied from
+ * https://github.com/microsoft/vscode/blob/0a34756cae4fc67739e60c708b04637089f8bb0d/src/vs/workbench/services/configurationResolver/common/configurationResolver.ts#L41-L63
+ */
+export interface VariablePromptStringInput {
+    id: string;
+    type: 'promptString';
+    description: string;
+    default?: string;
+}
+
+export interface VariablePickStringInput {
+    id: string;
+    type: 'pickString';
+    description: string;
+    options: string[];
+    default?: string;
+}
+
+export interface VariableCommandInput {
+    id: string;
+    type: 'command';
+    command: string;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    args?: any;
+}
+
+export type VariableInput = VariablePromptStringInput | VariablePickStringInput | VariableCommandInput;

package/src/browser/variable-quick-open-service.ts

@@ -1,62 +1,62 @@
-// *****************************************************************************
-// Copyright (C) 2018 Red Hat, Inc. and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { inject, injectable, optional } from '@theia/core/shared/inversify';
-import { MessageService } from '@theia/core/lib/common/message-service';
-import { VariableRegistry, Variable } from './variable';
-import { VariableResolverService } from './variable-resolver-service';
-import { QuickPickItem, QuickInputService } from '@theia/core/lib/browser';
-
-@injectable()
-export class VariableQuickOpenService {
-
-    protected items: Array<QuickPickItem>;
-
-    @inject(MessageService)
-    protected readonly messages: MessageService;
-
-    @inject(QuickInputService) @optional()
-    protected readonly quickInputService: QuickInputService;
-
-    @inject(VariableResolverService)
-    protected readonly variableResolver: VariableResolverService;
-
-    constructor(
-        @inject(VariableRegistry) protected readonly variableRegistry: VariableRegistry
-    ) { }
-
-    open(): void {
-        this.items = this.variableRegistry.getVariables().map(v => ({
-            label: '${' + v.name + '}',
-            detail: v.description,
-            execute: () => {
-                setTimeout(() => this.showValue(v));
-            }
-        }));
-
-        this.quickInputService?.showQuickPick(this.items, { placeholder: 'Registered variables' });
-    }
-
-    protected async showValue(variable: Variable): Promise<void> {
-        const argument = await this.quickInputService?.input({
-            placeHolder: 'Type a variable argument'
-        });
-        const value = await this.variableResolver.resolve('${' + variable.name + ':' + argument + '}');
-        if (typeof value === 'string') {
-            this.messages.info(value);
-        }
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2018 Red Hat, Inc. and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { inject, injectable, optional } from '@theia/core/shared/inversify';
+import { MessageService } from '@theia/core/lib/common/message-service';
+import { VariableRegistry, Variable } from './variable';
+import { VariableResolverService } from './variable-resolver-service';
+import { QuickPickItem, QuickInputService } from '@theia/core/lib/browser';
+
+@injectable()
+export class VariableQuickOpenService {
+
+    protected items: Array<QuickPickItem>;
+
+    @inject(MessageService)
+    protected readonly messages: MessageService;
+
+    @inject(QuickInputService) @optional()
+    protected readonly quickInputService: QuickInputService;
+
+    @inject(VariableResolverService)
+    protected readonly variableResolver: VariableResolverService;
+
+    constructor(
+        @inject(VariableRegistry) protected readonly variableRegistry: VariableRegistry
+    ) { }
+
+    open(): void {
+        this.items = this.variableRegistry.getVariables().map(v => ({
+            label: '${' + v.name + '}',
+            detail: v.description,
+            execute: () => {
+                setTimeout(() => this.showValue(v));
+            }
+        }));
+
+        this.quickInputService?.showQuickPick(this.items, { placeholder: 'Registered variables' });
+    }
+
+    protected async showValue(variable: Variable): Promise<void> {
+        const argument = await this.quickInputService?.input({
+            placeHolder: 'Type a variable argument'
+        });
+        const value = await this.variableResolver.resolve('${' + variable.name + ':' + argument + '}');
+        if (typeof value === 'string') {
+            this.messages.info(value);
+        }
+    }
+}

package/src/browser/variable-resolver-frontend-contribution.spec.ts

@@ -1,98 +1,98 @@
-// *****************************************************************************
-// Copyright (C) 2018 Red Hat, Inc. and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { enableJSDOM } from '@theia/core/lib/browser/test/jsdom';
-
-let disableJSDOM = enableJSDOM();
-
-import { FrontendApplicationConfigProvider } from '@theia/core/lib/browser/frontend-application-config-provider';
-FrontendApplicationConfigProvider.set({});
-
-import * as chai from 'chai';
-import { Container, ContainerModule } from '@theia/core/shared/inversify';
-import { ILogger, bindContributionProvider } from '@theia/core/lib/common';
-import { MockLogger } from '@theia/core/lib/common/test/mock-logger';
-import { VariableContribution, VariableRegistry } from './variable';
-import { VariableQuickOpenService } from './variable-quick-open-service';
-import { VariableResolverFrontendContribution } from './variable-resolver-frontend-contribution';
-
-disableJSDOM();
-
-const expect = chai.expect;
-
-before(() => {
-    chai.config.showDiff = true;
-    chai.config.includeStack = true;
-});
-
-describe('variable-resolver-frontend-contribution', () => {
-
-    let testContainer: Container;
-    let variableRegistry: VariableRegistry;
-
-    before(() => {
-        disableJSDOM = enableJSDOM();
-
-        testContainer = new Container();
-        const module = new ContainerModule((bind, unbind, isBound, rebind) => {
-            bindContributionProvider(bind, VariableContribution);
-            bind(VariableContribution).toConstantValue(new TestVariableContribution());
-
-            bind(ILogger).to(MockLogger);
-            bind(VariableRegistry).toSelf().inSingletonScope();
-
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            bind(VariableQuickOpenService).toConstantValue({} as any); // mock VariableQuickOpenService
-
-            bind(VariableResolverFrontendContribution).toSelf();
-        });
-        testContainer.load(module);
-    });
-
-    after(() => {
-        disableJSDOM();
-    });
-
-    beforeEach(() => {
-        variableRegistry = testContainer.get<VariableRegistry>(VariableRegistry);
-
-        const variableRegistrar = testContainer.get(VariableResolverFrontendContribution);
-        variableRegistrar.onStart();
-    });
-
-    it('should register all variables from the contribution points', () => {
-        const variables = variableRegistry.getVariables();
-        expect(variables.length).to.be.equal(2);
-        expect(variables[0].name).to.be.equal('file');
-        expect(variables[1].name).to.be.equal('lineNumber');
-    });
-});
-
-export class TestVariableContribution implements VariableContribution {
-
-    registerVariables(variables: VariableRegistry): void {
-        variables.registerVariable({
-            name: 'file',
-            description: 'Resolves to file name opened in the current editor',
-            resolve: () => Promise.resolve('package.json')
-        });
-        variables.registerVariable({
-            name: 'lineNumber',
-            description: 'Resolves to current line number',
-            resolve: () => Promise.resolve('5')
-        });
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2018 Red Hat, Inc. and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { enableJSDOM } from '@theia/core/lib/browser/test/jsdom';
+
+let disableJSDOM = enableJSDOM();
+
+import { FrontendApplicationConfigProvider } from '@theia/core/lib/browser/frontend-application-config-provider';
+FrontendApplicationConfigProvider.set({});
+
+import * as chai from 'chai';
+import { Container, ContainerModule } from '@theia/core/shared/inversify';
+import { ILogger, bindContributionProvider } from '@theia/core/lib/common';
+import { MockLogger } from '@theia/core/lib/common/test/mock-logger';
+import { VariableContribution, VariableRegistry } from './variable';
+import { VariableQuickOpenService } from './variable-quick-open-service';
+import { VariableResolverFrontendContribution } from './variable-resolver-frontend-contribution';
+
+disableJSDOM();
+
+const expect = chai.expect;
+
+before(() => {
+    chai.config.showDiff = true;
+    chai.config.includeStack = true;
+});
+
+describe('variable-resolver-frontend-contribution', () => {
+
+    let testContainer: Container;
+    let variableRegistry: VariableRegistry;
+
+    before(() => {
+        disableJSDOM = enableJSDOM();
+
+        testContainer = new Container();
+        const module = new ContainerModule((bind, unbind, isBound, rebind) => {
+            bindContributionProvider(bind, VariableContribution);
+            bind(VariableContribution).toConstantValue(new TestVariableContribution());
+
+            bind(ILogger).to(MockLogger);
+            bind(VariableRegistry).toSelf().inSingletonScope();
+
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            bind(VariableQuickOpenService).toConstantValue({} as any); // mock VariableQuickOpenService
+
+            bind(VariableResolverFrontendContribution).toSelf();
+        });
+        testContainer.load(module);
+    });
+
+    after(() => {
+        disableJSDOM();
+    });
+
+    beforeEach(() => {
+        variableRegistry = testContainer.get<VariableRegistry>(VariableRegistry);
+
+        const variableRegistrar = testContainer.get(VariableResolverFrontendContribution);
+        variableRegistrar.onStart();
+    });
+
+    it('should register all variables from the contribution points', () => {
+        const variables = variableRegistry.getVariables();
+        expect(variables.length).to.be.equal(2);
+        expect(variables[0].name).to.be.equal('file');
+        expect(variables[1].name).to.be.equal('lineNumber');
+    });
+});
+
+export class TestVariableContribution implements VariableContribution {
+
+    registerVariables(variables: VariableRegistry): void {
+        variables.registerVariable({
+            name: 'file',
+            description: 'Resolves to file name opened in the current editor',
+            resolve: () => Promise.resolve('package.json')
+        });
+        variables.registerVariable({
+            name: 'lineNumber',
+            description: 'Resolves to current line number',
+            resolve: () => Promise.resolve('5')
+        });
+    }
+}

package/src/browser/variable-resolver-frontend-contribution.ts

@@ -1,50 +1,50 @@
-// *****************************************************************************
-// Copyright (C) 2018 Red Hat, Inc. and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { injectable, inject, named } from '@theia/core/shared/inversify';
-import { FrontendApplicationContribution } from '@theia/core/lib/browser';
-import { Command, CommandContribution, CommandRegistry, ContributionProvider } from '@theia/core/lib/common';
-import { VariableContribution, VariableRegistry } from './variable';
-import { VariableQuickOpenService } from './variable-quick-open-service';
-
-export const LIST_VARIABLES: Command = {
-    id: 'variable.list',
-    label: 'Variable: List All'
-};
-
-@injectable()
-export class VariableResolverFrontendContribution implements FrontendApplicationContribution, CommandContribution {
-
-    constructor(
-        @inject(ContributionProvider) @named(VariableContribution)
-        protected readonly contributionProvider: ContributionProvider<VariableContribution>,
-        @inject(VariableRegistry) protected readonly variableRegistry: VariableRegistry,
-        @inject(VariableQuickOpenService) protected readonly variableQuickOpenService: VariableQuickOpenService
-    ) { }
-
-    onStart(): void {
-        this.contributionProvider.getContributions().forEach(contrib =>
-            contrib.registerVariables(this.variableRegistry)
-        );
-    }
-
-    registerCommands(commands: CommandRegistry): void {
-        commands.registerCommand(LIST_VARIABLES, {
-            isEnabled: () => true,
-            execute: () => this.variableQuickOpenService.open()
-        });
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2018 Red Hat, Inc. and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { injectable, inject, named } from '@theia/core/shared/inversify';
+import { FrontendApplicationContribution } from '@theia/core/lib/browser';
+import { Command, CommandContribution, CommandRegistry, ContributionProvider } from '@theia/core/lib/common';
+import { VariableContribution, VariableRegistry } from './variable';
+import { VariableQuickOpenService } from './variable-quick-open-service';
+
+export const LIST_VARIABLES: Command = {
+    id: 'variable.list',
+    label: 'Variable: List All'
+};
+
+@injectable()
+export class VariableResolverFrontendContribution implements FrontendApplicationContribution, CommandContribution {
+
+    constructor(
+        @inject(ContributionProvider) @named(VariableContribution)
+        protected readonly contributionProvider: ContributionProvider<VariableContribution>,
+        @inject(VariableRegistry) protected readonly variableRegistry: VariableRegistry,
+        @inject(VariableQuickOpenService) protected readonly variableQuickOpenService: VariableQuickOpenService
+    ) { }
+
+    onStart(): void {
+        this.contributionProvider.getContributions().forEach(contrib =>
+            contrib.registerVariables(this.variableRegistry)
+        );
+    }
+
+    registerCommands(commands: CommandRegistry): void {
+        commands.registerCommand(LIST_VARIABLES, {
+            isEnabled: () => true,
+            execute: () => this.variableQuickOpenService.open()
+        });
+    }
+}

package/src/browser/variable-resolver-frontend-module.ts

@@ -1,40 +1,40 @@
-// *****************************************************************************
-// Copyright (C) 2018 Red Hat, Inc. and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { ContainerModule } from '@theia/core/shared/inversify';
-import { bindContributionProvider, CommandContribution } from '@theia/core';
-import { FrontendApplicationContribution } from '@theia/core/lib/browser';
-import { VariableRegistry, VariableContribution } from './variable';
-import { VariableQuickOpenService } from './variable-quick-open-service';
-import { VariableResolverFrontendContribution } from './variable-resolver-frontend-contribution';
-import { VariableResolverService } from './variable-resolver-service';
-import { CommonVariableContribution } from './common-variable-contribution';
-
-export default new ContainerModule(bind => {
-    bind(VariableRegistry).toSelf().inSingletonScope();
-    bind(VariableResolverService).toSelf().inSingletonScope();
-    bindContributionProvider(bind, VariableContribution);
-
-    bind(VariableResolverFrontendContribution).toSelf().inSingletonScope();
-    for (const identifier of [FrontendApplicationContribution, CommandContribution]) {
-        bind(identifier).toService(VariableResolverFrontendContribution);
-    }
-
-    bind(VariableQuickOpenService).toSelf().inSingletonScope();
-
-    bind(CommonVariableContribution).toSelf().inSingletonScope();
-    bind(VariableContribution).toService(CommonVariableContribution);
-});
+// *****************************************************************************
+// Copyright (C) 2018 Red Hat, Inc. and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { ContainerModule } from '@theia/core/shared/inversify';
+import { bindContributionProvider, CommandContribution } from '@theia/core';
+import { FrontendApplicationContribution } from '@theia/core/lib/browser';
+import { VariableRegistry, VariableContribution } from './variable';
+import { VariableQuickOpenService } from './variable-quick-open-service';
+import { VariableResolverFrontendContribution } from './variable-resolver-frontend-contribution';
+import { VariableResolverService } from './variable-resolver-service';
+import { CommonVariableContribution } from './common-variable-contribution';
+
+export default new ContainerModule(bind => {
+    bind(VariableRegistry).toSelf().inSingletonScope();
+    bind(VariableResolverService).toSelf().inSingletonScope();
+    bindContributionProvider(bind, VariableContribution);
+
+    bind(VariableResolverFrontendContribution).toSelf().inSingletonScope();
+    for (const identifier of [FrontendApplicationContribution, CommandContribution]) {
+        bind(identifier).toService(VariableResolverFrontendContribution);
+    }
+
+    bind(VariableQuickOpenService).toSelf().inSingletonScope();
+
+    bind(CommonVariableContribution).toSelf().inSingletonScope();
+    bind(VariableContribution).toService(CommonVariableContribution);
+});