@theia/variable-resolver 1.48.1 → 1.48.3

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';

package/src/browser/variable-input-schema.ts

@@ -1,131 +1,131 @@
-// *****************************************************************************
-// 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/configurationResolverSchema.ts#L23
- */
-
-const idDescription = "The input's id is used to associate an input with a variable of the form ${input:id}.";
-const typeDescription = 'The type of user input prompt to use.';
-const descriptionDescription = 'The description is shown when the user is prompted for input.';
-const defaultDescription = 'The default value for the input.';
-
-import { IJSONSchema } from '@theia/core/lib/common/json-schema';
-
-export const inputsSchema: IJSONSchema = {
-    definitions: {
-        inputs: {
-            type: 'array',
-            description: 'User inputs. Used for defining user input prompts, such as free string input or a choice from several options.',
-            items: {
-                oneOf: [
-                    {
-                        type: 'object',
-                        required: ['id', 'type', 'description'],
-                        additionalProperties: false,
-                        properties: {
-                            id: {
-                                type: 'string',
-                                description: idDescription
-                            },
-                            type: {
-                                type: 'string',
-                                description: typeDescription,
-                                enum: ['promptString'],
-                                enumDescriptions: [
-                                    "The 'promptString' type opens an input box to ask the user for input."
-                                ]
-                            },
-                            description: {
-                                type: 'string',
-                                description: descriptionDescription
-                            },
-                            default: {
-                                type: 'string',
-                                description: defaultDescription
-                            },
-                        }
-                    },
-                    {
-                        type: 'object',
-                        required: ['id', 'type', 'description', 'options'],
-                        additionalProperties: false,
-                        properties: {
-                            id: {
-                                type: 'string',
-                                description: idDescription
-                            },
-                            type: {
-                                type: 'string',
-                                description: typeDescription,
-                                enum: ['pickString'],
-                                enumDescriptions: [
-                                    "The 'pickString' type shows a selection list.",
-                                ]
-                            },
-                            description: {
-                                type: 'string',
-                                description: descriptionDescription
-                            },
-                            default: {
-                                type: 'string',
-                                description: defaultDescription
-                            },
-                            options: {
-                                type: 'array',
-                                description: 'An array of strings that defines the options for a quick pick.',
-                                items: {
-                                    type: 'string'
-                                }
-                            }
-                        }
-                    },
-                    {
-                        type: 'object',
-                        required: ['id', 'type', 'command'],
-                        additionalProperties: false,
-                        properties: {
-                            id: {
-                                type: 'string',
-                                description: idDescription
-                            },
-                            type: {
-                                type: 'string',
-                                description: typeDescription,
-                                enum: ['command'],
-                                enumDescriptions: [
-                                    "The 'command' type executes a command.",
-                                ]
-                            },
-                            command: {
-                                type: 'string',
-                                description: 'The command to execute for this input variable.'
-                            },
-                            args: {
-                                type: 'object',
-                                description: 'Optional arguments passed to the command.'
-                            }
-                        }
-                    }
-                ]
-            }
-        }
-    }
-};
+// *****************************************************************************
+// 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/configurationResolverSchema.ts#L23
+ */
+
+const idDescription = "The input's id is used to associate an input with a variable of the form ${input:id}.";
+const typeDescription = 'The type of user input prompt to use.';
+const descriptionDescription = 'The description is shown when the user is prompted for input.';
+const defaultDescription = 'The default value for the input.';
+
+import { IJSONSchema } from '@theia/core/lib/common/json-schema';
+
+export const inputsSchema: IJSONSchema = {
+    definitions: {
+        inputs: {
+            type: 'array',
+            description: 'User inputs. Used for defining user input prompts, such as free string input or a choice from several options.',
+            items: {
+                oneOf: [
+                    {
+                        type: 'object',
+                        required: ['id', 'type', 'description'],
+                        additionalProperties: false,
+                        properties: {
+                            id: {
+                                type: 'string',
+                                description: idDescription
+                            },
+                            type: {
+                                type: 'string',
+                                description: typeDescription,
+                                enum: ['promptString'],
+                                enumDescriptions: [
+                                    "The 'promptString' type opens an input box to ask the user for input."
+                                ]
+                            },
+                            description: {
+                                type: 'string',
+                                description: descriptionDescription
+                            },
+                            default: {
+                                type: 'string',
+                                description: defaultDescription
+                            },
+                        }
+                    },
+                    {
+                        type: 'object',
+                        required: ['id', 'type', 'description', 'options'],
+                        additionalProperties: false,
+                        properties: {
+                            id: {
+                                type: 'string',
+                                description: idDescription
+                            },
+                            type: {
+                                type: 'string',
+                                description: typeDescription,
+                                enum: ['pickString'],
+                                enumDescriptions: [
+                                    "The 'pickString' type shows a selection list.",
+                                ]
+                            },
+                            description: {
+                                type: 'string',
+                                description: descriptionDescription
+                            },
+                            default: {
+                                type: 'string',
+                                description: defaultDescription
+                            },
+                            options: {
+                                type: 'array',
+                                description: 'An array of strings that defines the options for a quick pick.',
+                                items: {
+                                    type: 'string'
+                                }
+                            }
+                        }
+                    },
+                    {
+                        type: 'object',
+                        required: ['id', 'type', 'command'],
+                        additionalProperties: false,
+                        properties: {
+                            id: {
+                                type: 'string',
+                                description: idDescription
+                            },
+                            type: {
+                                type: 'string',
+                                description: typeDescription,
+                                enum: ['command'],
+                                enumDescriptions: [
+                                    "The 'command' type executes a command.",
+                                ]
+                            },
+                            command: {
+                                type: 'string',
+                                description: 'The command to execute for this input variable.'
+                            },
+                            args: {
+                                type: 'object',
+                                description: 'Optional arguments passed to the command.'
+                            }
+                        }
+                    }
+                ]
+            }
+        }
+    }
+};