@theia/variable-resolver 1.53.0-next.5 → 1.53.0-next.55

package/README.md

@@ -1,114 +1,114 @@
-<div align='center'>
-
-<br />
-
-<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
-
-<h2>ECLIPSE THEIA - VARIABLE-RESOLVER EXTENSION</h2>
-
-<hr />
-
-</div>
-
-## Description
-
-The `@theia/variable-resolved` extension provides variable substitution mechanism inside of strings using `${variableName}` syntax.
-
-### Variable Contribution Point
-Extension provides a hook that allows any extensions to contribute its own variables.
-Here's the example of contributing two variables:
-- `${file}` - returns the name of the file opened in the current editor
-- `${lineNumber}` - returns the current line number in the current file
-
-```typescript
-@injectable()
-export class EditorVariableContribution implements VariableContribution {
-
-    constructor(
-        @inject(EditorManager) protected readonly editorManager: EditorManager
-    ) { }
-
-    registerVariables(variables: VariableRegistry): void {
-        variables.registerVariable({
-            name: 'file',
-            description: 'The name of the file opened in the current editor',
-            resolve: () => {
-                const currentEditor = this.getCurrentEditor();
-                if (currentEditor) {
-                    return currentEditor.uri.displayName;
-                }
-                return undefined;
-            }
-        });
-        variables.registerVariable({
-            name: 'lineNumber',
-            description: 'The current line number in the current file',
-            resolve: () => {
-                const currentEditor = this.getCurrentEditor();
-                if (currentEditor) {
-                    return `${currentEditor.cursor.line + 1}`;
-                }
-                return undefined;
-            }
-        });
-    }
-
-    protected getCurrentEditor(): TextEditor | undefined {
-        const currentEditor = this.editorManager.currentEditor;
-        if (currentEditor) {
-            return currentEditor.editor;
-        }
-        return undefined;
-    }
-}
-```
-
-Note that a Variable is resolved to `MaybePromise<string | undefined>` which means that it can be resolved synchronously or within a Promise.
-
-### Using the Variable Resolver Service
-
-There's the example of how one can use Variable Resolver Service in its own plugin:
-```typescript
-@injectable()
-export class MyService {
-
-    constructor(
-        @inject(VariableResolverService) protected readonly variableResolver: VariableResolverService
-    ) { }
-
-    async resolve(): Promise<void> {
-        const text = 'cursor is in file ${file} on line ${lineNumber}';
-        const resolved = await this.variableResolver.resolve(text);
-        console.log(resolved);
-    }
-}
-```
-
-If `package.json` file is currently opened and cursor is on line 5 then the following output will be logged to the console:
-```
-cursor is in file package.json on line 5
-```
-
-## Additional Information
-
-- [API documentation for `@theia/variable-resolver`](https://eclipse-theia.github.io/theia/docs/next/modules/variable_resolver.html)
-- [Theia - GitHub](https://github.com/eclipse-theia/theia)
-- [Theia - Website](https://theia-ide.org/)
-
-## License
-
-- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
-- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
-
-## Trademark
-"Theia" is a trademark of the Eclipse Foundation
-https://www.eclipse.org/theia
-
-
-# Theia - Variable Resolver Extension
-
-The extension
-
-## License
-- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
-- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
+<div align='center'>
+
+<br />
+
+<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
+
+<h2>ECLIPSE THEIA - VARIABLE-RESOLVER EXTENSION</h2>
+
+<hr />
+
+</div>
+
+## Description
+
+The `@theia/variable-resolved` extension provides variable substitution mechanism inside of strings using `${variableName}` syntax.
+
+### Variable Contribution Point
+Extension provides a hook that allows any extensions to contribute its own variables.
+Here's the example of contributing two variables:
+- `${file}` - returns the name of the file opened in the current editor
+- `${lineNumber}` - returns the current line number in the current file
+
+```typescript
+@injectable()
+export class EditorVariableContribution implements VariableContribution {
+
+    constructor(
+        @inject(EditorManager) protected readonly editorManager: EditorManager
+    ) { }
+
+    registerVariables(variables: VariableRegistry): void {
+        variables.registerVariable({
+            name: 'file',
+            description: 'The name of the file opened in the current editor',
+            resolve: () => {
+                const currentEditor = this.getCurrentEditor();
+                if (currentEditor) {
+                    return currentEditor.uri.displayName;
+                }
+                return undefined;
+            }
+        });
+        variables.registerVariable({
+            name: 'lineNumber',
+            description: 'The current line number in the current file',
+            resolve: () => {
+                const currentEditor = this.getCurrentEditor();
+                if (currentEditor) {
+                    return `${currentEditor.cursor.line + 1}`;
+                }
+                return undefined;
+            }
+        });
+    }
+
+    protected getCurrentEditor(): TextEditor | undefined {
+        const currentEditor = this.editorManager.currentEditor;
+        if (currentEditor) {
+            return currentEditor.editor;
+        }
+        return undefined;
+    }
+}
+```
+
+Note that a Variable is resolved to `MaybePromise<string | undefined>` which means that it can be resolved synchronously or within a Promise.
+
+### Using the Variable Resolver Service
+
+There's the example of how one can use Variable Resolver Service in its own plugin:
+```typescript
+@injectable()
+export class MyService {
+
+    constructor(
+        @inject(VariableResolverService) protected readonly variableResolver: VariableResolverService
+    ) { }
+
+    async resolve(): Promise<void> {
+        const text = 'cursor is in file ${file} on line ${lineNumber}';
+        const resolved = await this.variableResolver.resolve(text);
+        console.log(resolved);
+    }
+}
+```
+
+If `package.json` file is currently opened and cursor is on line 5 then the following output will be logged to the console:
+```
+cursor is in file package.json on line 5
+```
+
+## Additional Information
+
+- [API documentation for `@theia/variable-resolver`](https://eclipse-theia.github.io/theia/docs/next/modules/variable_resolver.html)
+- [Theia - GitHub](https://github.com/eclipse-theia/theia)
+- [Theia - Website](https://theia-ide.org/)
+
+## License
+
+- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
+- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
+
+## Trademark
+"Theia" is a trademark of the Eclipse Foundation
+https://www.eclipse.org/theia
+
+
+# Theia - Variable Resolver Extension
+
+The extension
+
+## License
+- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
+- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@theia/variable-resolver",
-  "version": "1.53.0-next.5+1e5fb536d",
+  "version": "1.53.0-next.55+d1a989a68c",
   "description": "Theia - Variable Resolver Extension",
   "dependencies": {
-    "@theia/core": "1.53.0-next.5+1e5fb536d",
+    "@theia/core": "1.53.0-next.55+d1a989a68c",
     "tslib": "^2.6.2"
   },
   "publishConfig": {
@@ -45,10 +45,10 @@
     "watch": "theiaext watch"
   },
   "devDependencies": {
-    "@theia/ext-scripts": "1.52.0"
+    "@theia/ext-scripts": "1.53.0"
   },
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "1e5fb536d65550ad8fa0fefcec731645b2afc74a"
+  "gitHead": "d1a989a68c1b5ec1f9098e9126653c6346844769"
 }

package/src/browser/common-variable-contribution.ts

@@ -1,151 +1,151 @@
-// *****************************************************************************
-// 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 { injectable, inject, optional } from '@theia/core/shared/inversify';
-import { VariableContribution, VariableRegistry } from './variable';
-import { ApplicationServer } from '@theia/core/lib/common/application-protocol';
-import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
-import { CommandService } from '@theia/core/lib/common/command';
-import { OS } from '@theia/core/lib/common/os';
-import { PreferenceService } from '@theia/core/lib/browser/preferences/preference-service';
-import { ResourceContextKey } from '@theia/core/lib/browser/resource-context-key';
-import { VariableInput } from './variable-input';
-import { QuickInputService, QuickPickValue } from '@theia/core/lib/browser';
-import { MaybeArray, RecursivePartial } from '@theia/core/lib/common/types';
-import { cancelled } from '@theia/core/lib/common/cancellation';
-import URI from '@theia/core/lib/common/uri';
-
-@injectable()
-export class CommonVariableContribution implements VariableContribution {
-
-    @inject(EnvVariablesServer)
-    protected readonly env: EnvVariablesServer;
-
-    @inject(CommandService)
-    protected readonly commands: CommandService;
-
-    @inject(PreferenceService)
-    protected readonly preferences: PreferenceService;
-
-    @inject(ResourceContextKey)
-    protected readonly resourceContextKey: ResourceContextKey;
-
-    @inject(QuickInputService) @optional()
-    protected readonly quickInputService: QuickInputService;
-
-    @inject(ApplicationServer)
-    protected readonly appServer: ApplicationServer;
-
-    async registerVariables(variables: VariableRegistry): Promise<void> {
-        const execPath = await this.env.getExecPath();
-        variables.registerVariable({
-            name: 'execPath',
-            resolve: () => execPath
-        });
-        variables.registerVariable({
-            name: 'pathSeparator',
-            resolve: () => OS.backend.isWindows ? '\\' : '/'
-        });
-        variables.registerVariable({
-            name: 'env',
-            resolve: async (_, envVariableName) => {
-                const envVariable = envVariableName && await this.env.getValue(envVariableName);
-                const envValue = envVariable && envVariable.value;
-                return envValue || '';
-            }
-        });
-        variables.registerVariable({
-            name: 'config',
-            resolve: (resourceUri = new URI(this.resourceContextKey.get()), preferenceName) => {
-                if (!preferenceName) {
-                    return undefined;
-                }
-                return this.preferences.get(preferenceName, undefined, resourceUri && resourceUri.toString());
-            }
-        });
-        variables.registerVariable({
-            name: 'command',
-            resolve: async (contextUri, commandId, configurationSection, commandIdVariables, configuration) => {
-                if (commandId) {
-                    if (commandIdVariables?.[commandId]) {
-                        commandId = commandIdVariables[commandId];
-                    }
-                    const result = await this.commands.executeCommand(commandId, configuration);
-                    // eslint-disable-next-line no-null/no-null
-                    if (result === null) {
-                        throw cancelled();
-                    }
-                    return result;
-                }
-            }
-        });
-        variables.registerVariable({
-            name: 'input',
-            resolve: async (resourceUri = new URI(this.resourceContextKey.get()), variable, section) => {
-                if (!variable || !section) {
-                    return undefined;
-                }
-                const configuration = this.preferences.get<RecursivePartial<{ inputs: MaybeArray<VariableInput> }>>(section, undefined, resourceUri && resourceUri.toString());
-                const inputs = !!configuration && 'inputs' in configuration ? configuration.inputs : undefined;
-                const input = Array.isArray(inputs) && inputs.find(item => !!item && item.id === variable);
-                if (!input) {
-                    return undefined;
-                }
-                if (input.type === 'promptString') {
-                    if (typeof input.description !== 'string') {
-                        return undefined;
-                    }
-                    return this.quickInputService?.input({
-                        prompt: input.description,
-                        value: input.default
-                    });
-                }
-                if (input.type === 'pickString') {
-                    if (typeof input.description !== 'string' || !Array.isArray(input.options)) {
-                        return undefined;
-                    }
-                    const elements: Array<QuickPickValue<string>> = [];
-                    for (const option of input.options) {
-                        if (typeof option !== 'string') {
-                            return undefined;
-                        }
-                        if (option === input.default) {
-                            elements.unshift({
-                                description: 'Default',
-                                label: option,
-                                value: option
-                            });
-                        } else {
-                            elements.push({
-                                label: option,
-                                value: option
-                            });
-                        }
-                    }
-                    const selectedPick = await this.quickInputService?.showQuickPick(elements, { placeholder: input.description });
-                    return selectedPick?.value;
-                }
-                if (input.type === 'command') {
-                    if (typeof input.command !== 'string') {
-                        return undefined;
-                    }
-                    return this.commands.executeCommand(input.command, input.args);
-                }
-                return undefined;
-            }
-        });
-    }
-}
+// *****************************************************************************
+// 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 { injectable, inject, optional } from '@theia/core/shared/inversify';
+import { VariableContribution, VariableRegistry } from './variable';
+import { ApplicationServer } from '@theia/core/lib/common/application-protocol';
+import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
+import { CommandService } from '@theia/core/lib/common/command';
+import { OS } from '@theia/core/lib/common/os';
+import { PreferenceService } from '@theia/core/lib/browser/preferences/preference-service';
+import { ResourceContextKey } from '@theia/core/lib/browser/resource-context-key';
+import { VariableInput } from './variable-input';
+import { QuickInputService, QuickPickValue } from '@theia/core/lib/browser';
+import { MaybeArray, RecursivePartial } from '@theia/core/lib/common/types';
+import { cancelled } from '@theia/core/lib/common/cancellation';
+import URI from '@theia/core/lib/common/uri';
+
+@injectable()
+export class CommonVariableContribution implements VariableContribution {
+
+    @inject(EnvVariablesServer)
+    protected readonly env: EnvVariablesServer;
+
+    @inject(CommandService)
+    protected readonly commands: CommandService;
+
+    @inject(PreferenceService)
+    protected readonly preferences: PreferenceService;
+
+    @inject(ResourceContextKey)
+    protected readonly resourceContextKey: ResourceContextKey;
+
+    @inject(QuickInputService) @optional()
+    protected readonly quickInputService: QuickInputService;
+
+    @inject(ApplicationServer)
+    protected readonly appServer: ApplicationServer;
+
+    async registerVariables(variables: VariableRegistry): Promise<void> {
+        const execPath = await this.env.getExecPath();
+        variables.registerVariable({
+            name: 'execPath',
+            resolve: () => execPath
+        });
+        variables.registerVariable({
+            name: 'pathSeparator',
+            resolve: () => OS.backend.isWindows ? '\\' : '/'
+        });
+        variables.registerVariable({
+            name: 'env',
+            resolve: async (_, envVariableName) => {
+                const envVariable = envVariableName && await this.env.getValue(envVariableName);
+                const envValue = envVariable && envVariable.value;
+                return envValue || '';
+            }
+        });
+        variables.registerVariable({
+            name: 'config',
+            resolve: (resourceUri = new URI(this.resourceContextKey.get()), preferenceName) => {
+                if (!preferenceName) {
+                    return undefined;
+                }
+                return this.preferences.get(preferenceName, undefined, resourceUri && resourceUri.toString());
+            }
+        });
+        variables.registerVariable({
+            name: 'command',
+            resolve: async (contextUri, commandId, configurationSection, commandIdVariables, configuration) => {
+                if (commandId) {
+                    if (commandIdVariables?.[commandId]) {
+                        commandId = commandIdVariables[commandId];
+                    }
+                    const result = await this.commands.executeCommand(commandId, configuration);
+                    // eslint-disable-next-line no-null/no-null
+                    if (result === null) {
+                        throw cancelled();
+                    }
+                    return result;
+                }
+            }
+        });
+        variables.registerVariable({
+            name: 'input',
+            resolve: async (resourceUri = new URI(this.resourceContextKey.get()), variable, section) => {
+                if (!variable || !section) {
+                    return undefined;
+                }
+                const configuration = this.preferences.get<RecursivePartial<{ inputs: MaybeArray<VariableInput> }>>(section, undefined, resourceUri && resourceUri.toString());
+                const inputs = !!configuration && 'inputs' in configuration ? configuration.inputs : undefined;
+                const input = Array.isArray(inputs) && inputs.find(item => !!item && item.id === variable);
+                if (!input) {
+                    return undefined;
+                }
+                if (input.type === 'promptString') {
+                    if (typeof input.description !== 'string') {
+                        return undefined;
+                    }
+                    return this.quickInputService?.input({
+                        prompt: input.description,
+                        value: input.default
+                    });
+                }
+                if (input.type === 'pickString') {
+                    if (typeof input.description !== 'string' || !Array.isArray(input.options)) {
+                        return undefined;
+                    }
+                    const elements: Array<QuickPickValue<string>> = [];
+                    for (const option of input.options) {
+                        if (typeof option !== 'string') {
+                            return undefined;
+                        }
+                        if (option === input.default) {
+                            elements.unshift({
+                                description: 'Default',
+                                label: option,
+                                value: option
+                            });
+                        } else {
+                            elements.push({
+                                label: option,
+                                value: option
+                            });
+                        }
+                    }
+                    const selectedPick = await this.quickInputService?.showQuickPick(elements, { placeholder: input.description });
+                    return selectedPick?.value;
+                }
+                if (input.type === 'command') {
+                    if (typeof input.command !== 'string') {
+                        return undefined;
+                    }
+                    return this.commands.executeCommand(input.command, input.args);
+                }
+                return undefined;
+            }
+        });
+    }
+}

package/src/browser/index.ts

@@ -1,19 +1,19 @@
-// *****************************************************************************
-// 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
-// *****************************************************************************
-
-export * from './variable';
-export * from './variable-quick-open-service';
-export * from './variable-resolver-service';
+// *****************************************************************************
+// 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
+// *****************************************************************************
+
+export * from './variable';
+export * from './variable-quick-open-service';
+export * from './variable-resolver-service';