@theia/variable-resolver 1.48.1 → 1.48.2

package/src/browser/variable.spec.ts

@@ -1,106 +1,106 @@
-// *****************************************************************************
-// 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 * as chai from 'chai';
-import { Container, ContainerModule } from '@theia/core/shared/inversify';
-import { ILogger, Disposable } from '@theia/core/lib/common';
-import { MockLogger } from '@theia/core/lib/common/test/mock-logger';
-import { Variable, VariableRegistry } from './variable';
-
-const expect = chai.expect;
-let variableRegistry: VariableRegistry;
-
-before(() => {
-    chai.config.showDiff = true;
-    chai.config.includeStack = true;
-});
-
-describe('variable api', () => {
-    let testContainer: Container;
-
-    before(() => {
-        testContainer = new Container();
-        const module = new ContainerModule((bind, unbind, isBound, rebind) => {
-            bind(ILogger).to(MockLogger);
-            bind(VariableRegistry).toSelf();
-        });
-        testContainer.load(module);
-    });
-
-    beforeEach(() => {
-        variableRegistry = testContainer.get<VariableRegistry>(VariableRegistry);
-    });
-
-    it('should register and return variable', () => {
-        registerTestVariable();
-
-        const variable = variableRegistry.getVariable(TEST_VARIABLE.name);
-        expect(variable).is.not.undefined;
-        if (variable) {
-            expect(variable.name).is.equal(TEST_VARIABLE.name);
-        }
-    });
-
-    it('should not register a variable for already existed name', () => {
-        const variables: Variable[] = [
-            {
-                name: 'workspaceRoot',
-                description: 'workspace root URI',
-                resolve: () => Promise.resolve('')
-            },
-            {
-                name: 'workspaceRoot',
-                description: 'workspace root URI 2',
-                resolve: () => Promise.resolve('')
-            }
-        ];
-        variables.forEach(v => variableRegistry.registerVariable(v));
-
-        const registeredVariables = variableRegistry.getVariables();
-        expect(registeredVariables.length).to.be.equal(1);
-        expect(registeredVariables[0].name).to.be.equal('workspaceRoot');
-        expect(registeredVariables[0].description).to.be.equal('workspace root URI');
-    });
-
-    it('should dispose variable', () => {
-        const disposable = registerTestVariable();
-        disposable.dispose();
-
-        const variable = variableRegistry.getVariable(TEST_VARIABLE.name);
-        expect(variable).is.undefined;
-    });
-
-    it('should unregister variables on dispose', () => {
-        registerTestVariable();
-
-        let variables = variableRegistry.getVariables();
-        expect(variables.length).to.be.equal(1);
-
-        variableRegistry.dispose();
-
-        variables = variableRegistry.getVariables();
-        expect(variables.length).to.be.equal(0);
-    });
-});
-
-const TEST_VARIABLE: Variable = {
-    name: 'workspaceRoot',
-    resolve: () => Promise.resolve('')
-};
-
-function registerTestVariable(): Disposable {
-    return variableRegistry.registerVariable(TEST_VARIABLE);
-}
+// *****************************************************************************
+// 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 * as chai from 'chai';
+import { Container, ContainerModule } from '@theia/core/shared/inversify';
+import { ILogger, Disposable } from '@theia/core/lib/common';
+import { MockLogger } from '@theia/core/lib/common/test/mock-logger';
+import { Variable, VariableRegistry } from './variable';
+
+const expect = chai.expect;
+let variableRegistry: VariableRegistry;
+
+before(() => {
+    chai.config.showDiff = true;
+    chai.config.includeStack = true;
+});
+
+describe('variable api', () => {
+    let testContainer: Container;
+
+    before(() => {
+        testContainer = new Container();
+        const module = new ContainerModule((bind, unbind, isBound, rebind) => {
+            bind(ILogger).to(MockLogger);
+            bind(VariableRegistry).toSelf();
+        });
+        testContainer.load(module);
+    });
+
+    beforeEach(() => {
+        variableRegistry = testContainer.get<VariableRegistry>(VariableRegistry);
+    });
+
+    it('should register and return variable', () => {
+        registerTestVariable();
+
+        const variable = variableRegistry.getVariable(TEST_VARIABLE.name);
+        expect(variable).is.not.undefined;
+        if (variable) {
+            expect(variable.name).is.equal(TEST_VARIABLE.name);
+        }
+    });
+
+    it('should not register a variable for already existed name', () => {
+        const variables: Variable[] = [
+            {
+                name: 'workspaceRoot',
+                description: 'workspace root URI',
+                resolve: () => Promise.resolve('')
+            },
+            {
+                name: 'workspaceRoot',
+                description: 'workspace root URI 2',
+                resolve: () => Promise.resolve('')
+            }
+        ];
+        variables.forEach(v => variableRegistry.registerVariable(v));
+
+        const registeredVariables = variableRegistry.getVariables();
+        expect(registeredVariables.length).to.be.equal(1);
+        expect(registeredVariables[0].name).to.be.equal('workspaceRoot');
+        expect(registeredVariables[0].description).to.be.equal('workspace root URI');
+    });
+
+    it('should dispose variable', () => {
+        const disposable = registerTestVariable();
+        disposable.dispose();
+
+        const variable = variableRegistry.getVariable(TEST_VARIABLE.name);
+        expect(variable).is.undefined;
+    });
+
+    it('should unregister variables on dispose', () => {
+        registerTestVariable();
+
+        let variables = variableRegistry.getVariables();
+        expect(variables.length).to.be.equal(1);
+
+        variableRegistry.dispose();
+
+        variables = variableRegistry.getVariables();
+        expect(variables.length).to.be.equal(0);
+    });
+});
+
+const TEST_VARIABLE: Variable = {
+    name: 'workspaceRoot',
+    resolve: () => Promise.resolve('')
+};
+
+function registerTestVariable(): Disposable {
+    return variableRegistry.registerVariable(TEST_VARIABLE);
+}

package/src/browser/variable.ts

@@ -1,111 +1,111 @@
-// *****************************************************************************
-// 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 } from '@theia/core/shared/inversify';
-import { Disposable, DisposableCollection, MaybePromise } from '@theia/core';
-import URI from '@theia/core/lib/common/uri';
-import { CommandIdVariables } from '../common/variable-types';
-
-/**
- * Variable can be used inside of strings using ${variableName} syntax.
- */
-export interface Variable {
-
-    /**
-     * A unique name of this variable.
-     */
-    readonly name: string;
-
-    /**
-     * A human-readable description of this variable.
-     */
-    readonly description?: string;
-
-    /**
-     * Resolve to a string value of this variable or
-     * `undefined` if variable cannot be resolved.
-     * Never reject.
-     */
-    resolve(
-        context?: URI,
-        argument?: string,
-        configurationSection?: string,
-        commandIdVariables?: CommandIdVariables,
-        configuration?: unknown
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    ): MaybePromise<any>;
-}
-
-export const VariableContribution = Symbol('VariableContribution');
-/**
- * The variable contribution should be implemented to register custom variables.
- */
-export interface VariableContribution {
-    registerVariables(variables: VariableRegistry): void;
-}
-
-/**
- * The variable registry manages variables.
- */
-@injectable()
-export class VariableRegistry implements Disposable {
-
-    protected readonly variables: Map<string, Variable> = new Map();
-    protected readonly toDispose = new DisposableCollection();
-
-    dispose(): void {
-        this.toDispose.dispose();
-    }
-
-    /**
-     * Register the given variable.
-     * Do nothing if a variable is already registered for the given variable name.
-     */
-    registerVariable(variable: Variable): Disposable {
-        if (this.variables.has(variable.name)) {
-            console.warn(`A variables with name ${variable.name} is already registered.`);
-            return Disposable.NULL;
-        }
-        this.variables.set(variable.name, variable);
-        const disposable = {
-            dispose: () => this.variables.delete(variable.name)
-        };
-        this.toDispose.push(disposable);
-        return disposable;
-    }
-
-    /**
-     * Return all registered variables.
-     */
-    getVariables(): Variable[] {
-        return [...this.variables.values()];
-    }
-
-    /**
-     * Get a variable for the given name or `undefined` if none.
-     */
-    getVariable(name: string): Variable | undefined {
-        return this.variables.get(name);
-    }
-
-    /**
-     * Register an array of variables.
-     * Do nothing if a variable is already registered for the given variable name.
-     */
-    registerVariables(variables: Variable[]): Disposable[] {
-        return variables.map(v => this.registerVariable(v));
-    }
-}
+// *****************************************************************************
+// 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 } from '@theia/core/shared/inversify';
+import { Disposable, DisposableCollection, MaybePromise } from '@theia/core';
+import URI from '@theia/core/lib/common/uri';
+import { CommandIdVariables } from '../common/variable-types';
+
+/**
+ * Variable can be used inside of strings using ${variableName} syntax.
+ */
+export interface Variable {
+
+    /**
+     * A unique name of this variable.
+     */
+    readonly name: string;
+
+    /**
+     * A human-readable description of this variable.
+     */
+    readonly description?: string;
+
+    /**
+     * Resolve to a string value of this variable or
+     * `undefined` if variable cannot be resolved.
+     * Never reject.
+     */
+    resolve(
+        context?: URI,
+        argument?: string,
+        configurationSection?: string,
+        commandIdVariables?: CommandIdVariables,
+        configuration?: unknown
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    ): MaybePromise<any>;
+}
+
+export const VariableContribution = Symbol('VariableContribution');
+/**
+ * The variable contribution should be implemented to register custom variables.
+ */
+export interface VariableContribution {
+    registerVariables(variables: VariableRegistry): void;
+}
+
+/**
+ * The variable registry manages variables.
+ */
+@injectable()
+export class VariableRegistry implements Disposable {
+
+    protected readonly variables: Map<string, Variable> = new Map();
+    protected readonly toDispose = new DisposableCollection();
+
+    dispose(): void {
+        this.toDispose.dispose();
+    }
+
+    /**
+     * Register the given variable.
+     * Do nothing if a variable is already registered for the given variable name.
+     */
+    registerVariable(variable: Variable): Disposable {
+        if (this.variables.has(variable.name)) {
+            console.warn(`A variables with name ${variable.name} is already registered.`);
+            return Disposable.NULL;
+        }
+        this.variables.set(variable.name, variable);
+        const disposable = {
+            dispose: () => this.variables.delete(variable.name)
+        };
+        this.toDispose.push(disposable);
+        return disposable;
+    }
+
+    /**
+     * Return all registered variables.
+     */
+    getVariables(): Variable[] {
+        return [...this.variables.values()];
+    }
+
+    /**
+     * Get a variable for the given name or `undefined` if none.
+     */
+    getVariable(name: string): Variable | undefined {
+        return this.variables.get(name);
+    }
+
+    /**
+     * Register an array of variables.
+     * Do nothing if a variable is already registered for the given variable name.
+     */
+    registerVariables(variables: Variable[]): Disposable[] {
+        return variables.map(v => this.registerVariable(v));
+    }
+}

package/src/common/variable-types.ts

@@ -1,23 +1,23 @@
-// *****************************************************************************
-// 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
-// *****************************************************************************
-
-/**
- * Holds variable-names to command id mappings (e.g. Provided by specific plugins / extensions)
- * see "variables": https://code.visualstudio.com/api/references/contribution-points#contributes.debuggers
- */
-export interface CommandIdVariables {
-    [id: string]: string
-}
+// *****************************************************************************
+// 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
+// *****************************************************************************
+
+/**
+ * Holds variable-names to command id mappings (e.g. Provided by specific plugins / extensions)
+ * see "variables": https://code.visualstudio.com/api/references/contribution-points#contributes.debuggers
+ */
+export interface CommandIdVariables {
+    [id: string]: string
+}