@theia/process 1.67.0-next.56 → 1.67.0-next.86

package/lib/common/shell-command-builder.slow-spec.js

@@ -0,0 +1,405 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2020 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
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * This test suite assumes that we run in a NodeJS environment!
+ */
+const child_process_1 = require("child_process");
+const path_1 = require("path");
+const shell_command_builder_1 = require("./shell-command-builder");
+const chalk = require("chalk"); // tslint:disable-line:no-implicit-dependencies
+const isWindows = process.platform === 'win32';
+/**
+ * Extra debugging info (very verbose).
+ */
+const _debug = Boolean(process.env['THEIA_PROCESS_TEST_DEBUG']);
+/**
+ * On Windows, some shells simply mess up the terminal's output.
+ * Enable if you still want to test those.
+ */
+const _runWeirdShell = Boolean(process.env['THEIA_PROCESS_TEST_WEIRD_SHELL']) || undefined;
+/**
+ * You might only have issues with a specific shell (`cmd.exe` I am looking at you).
+ */
+const _onlyTestShell = process.env['THEIA_PROCESS_TEST_ONLY'] || undefined;
+/**
+ * Only log if environment variable is set.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function debug(...parts) {
+    if (_debug) {
+        console.debug(...parts);
+    }
+}
+const testResources = (0, path_1.join)(__dirname, '../../src/common/tests');
+const spawnOptions = {
+    // We do our own quoting, don't rely on the one done by NodeJS:
+    windowsVerbatimArguments: true,
+    stdio: ['pipe', 'pipe', 'pipe'],
+};
+// Formatting options, used with `scanLines` for debugging.
+const stdoutFormat = (prefix) => (data) => `${chalk.bold(chalk.yellow(`${prefix} STDOUT:`))} ${chalk.bgYellow(chalk.black(data))}`;
+const stderrFormat = (prefix) => (data) => `${chalk.bold(chalk.red(`${prefix} STDERR:`))} ${chalk.bgRed(chalk.white(data))}`;
+// Default error scanner
+const errorScanner = (handle) => {
+    if (/^\s*\w+Error:/.test(handle.line) ||
+        /^\s*Cannot find /.test(handle.line)) {
+        throw new Error(handle.text);
+    }
+};
+// Yarn mangles the PATH and creates some proxy script around node(.exe),
+// which messes up our environment, failing the tests.
+const hostNodePath = process.env['npm_node_execpath'] ||
+    process.env['NODE'];
+if (!hostNodePath) {
+    throw new Error('Could not determine the real node path.');
+}
+const shellCommandBuilder = new shell_command_builder_1.ShellCommandBuilder();
+const shellConfigs = [{
+        name: 'bash',
+        path: isWindows
+            ? _runWeirdShell && execShellCommand('where bash.exe')
+            : execShellCommand('command -v bash'),
+        nodePath: isWindows && 'node' // Good enough
+    }, {
+        name: 'wsl',
+        path: isWindows
+            ? _runWeirdShell && execShellCommand('where wsl.exe')
+            : undefined,
+        nodePath: isWindows && 'node' // Good enough
+    }, {
+        name: 'cmd',
+        path: isWindows
+            ? execShellCommand('where cmd.exe')
+            : undefined,
+    }, {
+        name: 'powershell',
+        path: execShellCommand(isWindows
+            ? 'where powershell'
+            : 'command -v pwsh'),
+    }];
+/* eslint-disable max-len */
+// 18d/12m/19y - Ubuntu 16.04:
+// Powershell sometimes fails when running as part of an npm lifecycle script.
+// See following error:
+//
+//
+//  FailFast:
+//  The type initializer for 'Microsoft.PowerShell.ApplicationInsightsTelemetry' threw an exception.
+//
+//     at System.Environment.FailFast(System.String, System.Exception)
+//     at System.Environment.FailFast(System.String, System.Exception)
+//     at Microsoft.PowerShell.UnmanagedPSEntry.Start(System.String, System.String[], Int32)
+//     at Microsoft.PowerShell.ManagedPSEntry.Main(System.String[])
+//
+//  Exception details:
+//  System.TypeInitializationException: The type initializer for 'Microsoft.PowerShell.ApplicationInsightsTelemetry' threw an exception. ---> System.ArgumentException: Item has already been added. Key in dictionary: 'SPAWN_WRAP_SHIM_ROOT'  Key being added: 'SPAWN_WRAP_SHIM_ROOT'
+//     at System.Collections.Hashtable.Insert(Object key, Object nvalue, Boolean add)
+//     at System.Environment.ToHashtable(IEnumerable`1 pairs)
+//     at System.Environment.GetEnvironmentVariables()
+//     at Microsoft.ApplicationInsights.Extensibility.Implementation.Platform.PlatformImplementation..ctor()
+//     at Microsoft.ApplicationInsights.Extensibility.Implementation.Platform.PlatformSingleton.get_Current()
+//     at Microsoft.ApplicationInsights.Extensibility.Implementation.TelemetryConfigurationFactory.Initialize(TelemetryConfiguration configuration, TelemetryModules modules)
+//     at Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.get_Active()
+//     at Microsoft.PowerShell.ApplicationInsightsTelemetry..cctor()
+//     --- End of inner exception stack trace ---
+//     at Microsoft.PowerShell.ApplicationInsightsTelemetry.SendPSCoreStartupTelemetry()
+//     at Microsoft.PowerShell.ConsoleHost.Start(String bannerText, String helpText, String[] args)
+//     at Microsoft.PowerShell.ConsoleShell.Start(String bannerText, String helpText, String[] args)
+//     at Microsoft.PowerShell.UnmanagedPSEntry.Start(String consoleFilePath, String[] args, Int32 argc)
+/* eslint-enable max-len */
+let id = 0;
+for (const shellConfig of shellConfigs) {
+    let skipMessage;
+    if (typeof _onlyTestShell === 'string' && shellConfig.name !== _onlyTestShell) {
+        skipMessage = `only testing ${_onlyTestShell}`;
+    }
+    else if (!shellConfig.path) {
+        // For each shell, skip if we could not find the executable path.
+        skipMessage = 'cannot find shell';
+    }
+    else {
+        // Run a test in the shell to catch runtime issues.
+        // CI seems to have issues with some shells depending on the environment...
+        try {
+            const debugName = `${shellConfig.name}/test`;
+            const shellTest = (0, child_process_1.spawnSync)(shellConfig.path, {
+                input: 'echo abcdefghijkl\n\n',
+                timeout: 5000,
+            });
+            debug(stdoutFormat(debugName)(shellTest.stdout.toString()));
+            debug(stderrFormat(debugName)(shellTest.stderr.toString()));
+            if (!/abcdefghijkl/m.test(shellTest.output.toString())) {
+                skipMessage = 'wrong test output';
+            }
+        }
+        catch (error) {
+            console.error(error);
+            skipMessage = 'error occurred';
+        }
+    }
+    /**
+     * If skipMessage is set, we should skip the test and explain why.
+     */
+    const describeOrSkip = (callback) => {
+        const describeMessage = `test ${shellConfig.name} commands`;
+        if (typeof skipMessage === 'undefined') {
+            describe(describeMessage, callback);
+        }
+        else {
+            describe.skip(`${describeMessage} - skip: ${skipMessage}`, callback);
+        }
+    };
+    describeOrSkip(function () {
+        this.timeout(10000);
+        let nodePath;
+        let cwd;
+        let submit;
+        let processInfo;
+        let context;
+        beforeEach(() => {
+            // In WSL, the node path is different than the host one (Windows vs Linux).
+            nodePath = shellConfig.nodePath || hostNodePath;
+            // On windows, when running bash we need to convert paths from Windows
+            // to their mounting point, assuming bash is running within WSL.
+            if (isWindows && /bash|wsl/.test(shellConfig.name)) {
+                cwd = convertWindowsPath(testResources);
+            }
+            else {
+                cwd = testResources;
+            }
+            // When running powershell, it seems like good measure to send `\n` twice...
+            if (shellConfig.name === 'powershell') {
+                submit = '\n\n';
+            }
+            // TestContext holds all state for a given test.
+            const testContextName = `${shellConfig.name}/${++id}`;
+            context = new TestCaseContext(testContextName, submit);
+            processInfo = createShell(context, shellConfig.path);
+        });
+        afterEach(() => {
+            processInfo.shell.kill();
+            context.finalize();
+        });
+        it('use simple environment variables', async () => {
+            const envName = 'SIMPLE_NAME';
+            const envValue = 'SIMPLE_VALUE';
+            await testCommandLine(context, processInfo, {
+                cwd, args: [nodePath, '-p', `\`[\${process.env['${envName}']}]\``],
+                env: {
+                    [envName]: envValue,
+                }
+            }, [
+                // stderr
+                scanLines(context, processInfo.shell.stderr, errorScanner, stderrFormat(context.name)),
+                // stdout
+                scanLines(context, processInfo.shell.stdout, handle => {
+                    errorScanner(handle);
+                    if (handle.line.includes(`[${envValue}]`)) {
+                        handle.resolve();
+                    }
+                }, stdoutFormat(context.name)),
+            ]);
+        });
+        it('use problematic environment variables', async () => {
+            const envName = 'A?B_C | D $PATH';
+            const envValue = 'SUCCESS';
+            await testCommandLine(context, processInfo, {
+                cwd, args: [nodePath, '-p', `\`[\${process.env['${envName}']}]\``],
+                env: {
+                    [envName]: envValue,
+                }
+            }, [
+                // stderr
+                scanLines(context, processInfo.shell.stderr, errorScanner, stderrFormat(context.name)),
+                // stdout
+                scanLines(context, processInfo.shell.stdout, handle => {
+                    errorScanner(handle);
+                    if (handle.line.includes(`[${envValue}]`)) {
+                        handle.resolve();
+                    }
+                    if (handle.line.includes('[undefined]')) {
+                        handle.reject(new Error(handle.text));
+                    }
+                }, stdoutFormat(context.name)),
+            ]);
+        });
+        it('command with complex arguments', async () => {
+            const left = 'ABC';
+            const right = 'DEF';
+            await testCommandLine(context, processInfo, {
+                cwd, args: [nodePath, '-e', `{
+                        const left = '${left}';
+                        const right = '${right}';
+                        console.log(\`[\${left}|\${right}]\`);
+                    }`],
+            }, [
+                // stderr
+                scanLines(context, processInfo.shell.stderr, errorScanner, stderrFormat(context.name)),
+                // stdout
+                scanLines(context, processInfo.shell.stdout, handle => {
+                    errorScanner(handle);
+                    if (handle.line.includes(`[${left}|${right}]`)) {
+                        handle.resolve();
+                    }
+                }, stdoutFormat(context.name)),
+            ]);
+        });
+    });
+}
+/**
+ * Allow `command` to fail and return undefined instead.
+ */
+function execShellCommand(command) {
+    try {
+        // If trimmed output is an empty string, return `undefined` instead:
+        return (0, child_process_1.execSync)(command).toString().trim() || undefined;
+    }
+    catch (error) {
+        console.error(command, error);
+        return undefined;
+    }
+}
+/**
+ * When executing `bash.exe` on Windows, the `C:`, `D:`, etc drives are mounted under `/mnt/<drive>/...`
+ */
+function convertWindowsPath(windowsPath) {
+    return windowsPath
+        // Convert back-slashes to forward-slashes
+        .replace(/\\/g, '/')
+        // Convert drive-letter to usual mounting point in WSL
+        .replace(/^[A-Za-z]:\//, s => `/mnt/${s[0].toLowerCase()}/`);
+}
+/**
+ * Display trailing whitespace in a string, such as \r and \n.
+ */
+function displayWhitespaces(line) {
+    return line
+        .replace(/\r?\n/, s => s.length === 2 ? '<\\r\\n>\r\n' : '<\\n>\n');
+}
+/**
+ * Actually run `prepareCommandLine`.
+ */
+async function testCommandLine(context, processInfo, options, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+firstOf) {
+    const commandLine = shellCommandBuilder.buildCommand(processInfo, options);
+    debug(`${chalk.bold(chalk.white(`${context.name} STDIN:`))} ${chalk.bgWhite(chalk.black(displayWhitespaces(commandLine)))}`);
+    processInfo.shell.stdin.write(commandLine + context.submit);
+    return Promise.race(firstOf);
+}
+/**
+ * Creates a `(Test)ProcessInfo` object by spawning the specified shell.
+ */
+function createShell(context, shellExecutable, shellArguments = []) {
+    const shell = (0, child_process_1.spawn)(shellExecutable, shellArguments, spawnOptions);
+    debug(chalk.magenta(`${chalk.bold(`${context.name} SPAWN:`)} ${shellExecutable} ${shellArguments.join(' ')}`));
+    shell.on('close', (code, signal) => debug(chalk.magenta(`${chalk.bold(`${context.name} CLOSE:`)} ${shellExecutable} code(${code}) signal(${signal})`)));
+    return {
+        executable: shellExecutable,
+        arguments: [],
+        shell,
+    };
+}
+/**
+ * Fire `callback` once per new detected line.
+ */
+async function scanLines(context, stream, callback, debugFormat = (s) => s) {
+    return new Promise((resolve, reject) => {
+        let line = '';
+        let text = '';
+        stream.on('close', () => {
+            debug(debugFormat('<CLOSED>'));
+        });
+        // The `data` listener will be collected on 'close', which will happen
+        // once we kill the process.
+        stream.on('data', data => {
+            if (context.resolved) {
+                return;
+            }
+            const split = data.toString().split('\n');
+            while (!context.resolved && split.length > 1) {
+                line += split.shift() + '\n';
+                text += line;
+                debug(debugFormat(displayWhitespaces(line)));
+                try {
+                    callback({
+                        resolve: (value) => {
+                            if (!context.resolved) {
+                                context.resolve();
+                                resolve(value);
+                                debug(chalk.bold(chalk.green(`${context.name} SCANLINES RESOLVED`)));
+                            }
+                        },
+                        reject: (reason) => {
+                            if (!context.resolved) {
+                                context.resolve();
+                                reject(reason);
+                                debug(chalk.bold(chalk.red(`${context.name} SCANLINES REJECTED`)));
+                            }
+                        },
+                        line,
+                        text,
+                    });
+                }
+                catch (error) {
+                    debug(chalk.bold(chalk.red(`${context.name} SCANLINES THROWED`)));
+                    context.resolve();
+                    reject(error);
+                    break;
+                }
+                line = '';
+            }
+            line += split[0];
+        });
+    });
+}
+/**
+ * We need a test case context to help with catching listeners that timed-out,
+ * and synchronize multiple listeners so that when one resolves the test case,
+ * the others can be put in "sleep mode" until destruction.
+ */
+class TestCaseContext {
+    constructor(
+    /**
+     * A name associated with this context, to help with debugging.
+     */
+    name, 
+    /**
+     * The characters to send in order to submit a command (mostly
+     * powershell is causing issues).
+     */
+    submit = '\n', 
+    /**
+     * @internal Current state of the test case, if it is finished or not.
+     */
+    resolved = false) {
+        this.name = name;
+        this.submit = submit;
+        this.resolved = resolved;
+    }
+    resolve() {
+        this.resolved = true;
+    }
+    finalize() {
+        if (!this.resolved) {
+            this.resolve();
+            debug(chalk.red(`${chalk.bold(`${this.name} CONTEXT:`)} context wasn't resolved when finalizing, resolving!`));
+        }
+    }
+}
+//# sourceMappingURL=shell-command-builder.slow-spec.js.map

package/lib/common/shell-command-builder.slow-spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shell-command-builder.slow-spec.js","sourceRoot":"","sources":["../../src/common/shell-command-builder.slow-spec.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,0CAA0C;AAC1C,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;;AAEhF;;GAEG;AAEH,iDAAuF;AAEvF,+BAA4B;AAC5B,mEAA+F;AAC/F,+BAA+B,CAAC,+CAA+C;AAM/E,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC;AAC/C;;GAEG;AACH,MAAM,MAAM,GAAY,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC,CAAC;AACzE;;;GAGG;AACH,MAAM,cAAc,GAAqB,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC,IAAI,SAAS,CAAC;AAC7G;;GAEG;AACH,MAAM,cAAc,GAAuB,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,IAAI,SAAS,CAAC;AAC/F;;GAEG;AACH,8DAA8D;AAC9D,SAAS,KAAK,CAAC,GAAG,KAAY;IAC1B,IAAI,MAAM,EAAE,CAAC;QACT,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC;IAC5B,CAAC;AACL,CAAC;AAED,MAAM,aAAa,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,wBAAwB,CAAC,CAAC;AAChE,MAAM,YAAY,GAAiB;IAC/B,+DAA+D;IAC/D,wBAAwB,EAAE,IAAI;IAC9B,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;CAClC,CAAC;AAEF,2DAA2D;AAC3D,MAAM,YAAY,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC,IAAY,EAAE,EAAE,CACtD,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,UAAU,CAAC,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;AAC5F,MAAM,YAAY,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC,IAAY,EAAE,EAAE,CACtD,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,UAAU,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;AAEtF,wBAAwB;AACxB,MAAM,YAAY,GAAG,CAAC,MAA4B,EAAE,EAAE;IAClD,IACI,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QACjC,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EACtC,CAAC;QACC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;AACL,CAAC,CAAC;AAEF,yEAAyE;AACzE,sDAAsD;AACtD,MAAM,YAAY,GACd,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;IAChC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IAChB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,mBAAmB,GAAG,IAAI,2CAAmB,EAAE,CAAC;AACtD,MAAM,YAAY,GAAG,CAAC;QAClB,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,SAAS;YACX,CAAC,CAAC,cAAc,IAAI,gBAAgB,CAAC,gBAAgB,CAAC;YACtD,CAAC,CAAC,gBAAgB,CAAC,iBAAiB,CAAC;QACzC,QAAQ,EACJ,SAAS,IAAI,MAAM,CAAC,cAAc;KACzC,EAAE;QACC,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,SAAS;YACX,CAAC,CAAC,cAAc,IAAI,gBAAgB,CAAC,eAAe,CAAC;YACrD,CAAC,CAAC,SAAS;QACf,QAAQ,EACJ,SAAS,IAAI,MAAM,CAAC,cAAc;KACzC,EAAE;QACC,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,SAAS;YACX,CAAC,CAAC,gBAAgB,CAAC,eAAe,CAAC;YACnC,CAAC,CAAC,SAAS;KAClB,EAAE;QACC,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,gBAAgB,CAAC,SAAS;YAC5B,CAAC,CAAC,kBAAkB;YACpB,CAAC,CAAC,iBAAiB,CAAC;KAC3B,CAAC,CAAC;AAEH,4BAA4B;AAE5B,8BAA8B;AAC9B,8EAA8E;AAC9E,uBAAuB;AACvB,EAAE;AACF,EAAE;AACF,aAAa;AACb,oGAAoG;AACpG,EAAE;AACF,sEAAsE;AACtE,sEAAsE;AACtE,4FAA4F;AAC5F,mEAAmE;AACnE,EAAE;AACF,sBAAsB;AACtB,uRAAuR;AACvR,qFAAqF;AACrF,6DAA6D;AAC7D,sDAAsD;AACtD,4GAA4G;AAC5G,6GAA6G;AAC7G,6KAA6K;AAC7K,yFAAyF;AACzF,oEAAoE;AACpE,iDAAiD;AACjD,wFAAwF;AACxF,mGAAmG;AACnG,oGAAoG;AACpG,wGAAwG;AAExG,2BAA2B;AAE3B,IAAI,EAAE,GAAG,CAAC,CAAC;AACX,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;IAErC,IAAI,WAA+B,CAAC;IAEpC,IAAI,OAAO,cAAc,KAAK,QAAQ,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;QAC5E,WAAW,GAAG,gBAAgB,cAAc,EAAE,CAAC;IAEnD,CAAC;SAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QAC3B,iEAAiE;QACjE,WAAW,GAAG,mBAAmB,CAAC;IAEtC,CAAC;SAAM,CAAC;QACJ,mDAAmD;QACnD,2EAA2E;QAC3E,IAAI,CAAC;YACD,MAAM,SAAS,GAAG,GAAG,WAAW,CAAC,IAAI,OAAO,CAAC;YAC7C,MAAM,SAAS,GAAG,IAAA,yBAAS,EAAC,WAAW,CAAC,IAAI,EAAE;gBAC1C,KAAK,EAAE,uBAAuB;gBAC9B,OAAO,EAAE,IAAK;aACjB,CAAC,CAAC;YACH,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAC5D,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAC5D,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;gBACrD,WAAW,GAAG,mBAAmB,CAAC;YACtC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACrB,WAAW,GAAG,gBAAgB,CAAC;QACnC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,cAAc,GAAG,CAAC,QAAqC,EAAE,EAAE;QAC7D,MAAM,eAAe,GAAG,QAAQ,WAAW,CAAC,IAAI,WAAW,CAAC;QAC5D,IAAI,OAAO,WAAW,KAAK,WAAW,EAAE,CAAC;YACrC,QAAQ,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;QACxC,CAAC;aAAM,CAAC;YACJ,QAAQ,CAAC,IAAI,CAAC,GAAG,eAAe,YAAY,WAAW,EAAE,EAAE,QAAQ,CAAC,CAAC;QACzE,CAAC;IACL,CAAC,CAAC;IAEF,cAAc,CAAC;QACX,IAAI,CAAC,OAAO,CAAC,KAAM,CAAC,CAAC;QAErB,IAAI,QAAgB,CAAC;QACrB,IAAI,GAAW,CAAC;QAChB,IAAI,MAA0B,CAAC;QAC/B,IAAI,WAA4B,CAAC;QACjC,IAAI,OAAwB,CAAC;QAE7B,UAAU,CAAC,GAAG,EAAE;YACZ,2EAA2E;YAC3E,QAAQ,GAAG,WAAW,CAAC,QAAQ,IAAI,YAAY,CAAC;YAEhD,sEAAsE;YACtE,gEAAgE;YAChE,IAAI,SAAS,IAAI,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjD,GAAG,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC;YAC5C,CAAC;iBAAM,CAAC;gBACJ,GAAG,GAAG,aAAa,CAAC;YACxB,CAAC;YAED,4EAA4E;YAC5E,IAAI,WAAW,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBACpC,MAAM,GAAG,MAAM,CAAC;YACpB,CAAC;YAED,gDAAgD;YAChD,MAAM,eAAe,GAAG,GAAG,WAAW,CAAC,IAAI,IAAI,EAAE,EAAE,EAAE,CAAC;YACtD,OAAO,GAAG,IAAI,eAAe,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;YACvD,WAAW,GAAG,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,IAAK,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACX,WAAW,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YACzB,OAAO,CAAC,QAAQ,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;YAC9C,MAAM,OAAO,GAAG,aAAa,CAAC;YAC9B,MAAM,QAAQ,GAAG,cAAc,CAAC;YAChC,MAAM,eAAe,CACjB,OAAO,EAAE,WAAW,EACpB;gBACI,GAAG,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE,IAAI,EAAE,sBAAsB,OAAO,QAAQ,CAAC;gBAClE,GAAG,EAAE;oBACD,CAAC,OAAO,CAAC,EAAE,QAAQ;iBACtB;aACJ,EAAE;gBACH,SAAS;gBACT,SAAS,CAAO,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,MAAO,EAAE,YAAY,EAAE,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAC7F,SAAS;gBACT,SAAS,CAAO,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,MAAO,EAAE,MAAM,CAAC,EAAE;oBACzD,YAAY,CAAC,MAAM,CAAC,CAAC;oBACrB,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;wBACxC,MAAM,CAAC,OAAO,EAAE,CAAC;oBACrB,CAAC;gBACL,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;aACjC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;YACnD,MAAM,OAAO,GAAG,iBAAiB,CAAC;YAClC,MAAM,QAAQ,GAAG,SAAS,CAAC;YAC3B,MAAM,eAAe,CACjB,OAAO,EAAE,WAAW,EACpB;gBACI,GAAG,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE,IAAI,EAAE,sBAAsB,OAAO,QAAQ,CAAC;gBAClE,GAAG,EAAE;oBACD,CAAC,OAAO,CAAC,EAAE,QAAQ;iBACtB;aACJ,EAAE;gBACH,SAAS;gBACT,SAAS,CAAO,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,MAAO,EAAE,YAAY,EAAE,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAC7F,SAAS;gBACT,SAAS,CAAO,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,MAAO,EAAE,MAAM,CAAC,EAAE;oBACzD,YAAY,CAAC,MAAM,CAAC,CAAC;oBACrB,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;wBACxC,MAAM,CAAC,OAAO,EAAE,CAAC;oBACrB,CAAC;oBACD,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;wBACtC,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;oBAC1C,CAAC;gBACL,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;aACjC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;YAC5C,MAAM,IAAI,GAAG,KAAK,CAAC;YACnB,MAAM,KAAK,GAAG,KAAK,CAAC;YACpB,MAAM,eAAe,CACjB,OAAO,EAAE,WAAW,EACpB;gBACI,GAAG,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE,IAAI,EAAE;wCACR,IAAI;yCACH,KAAK;;sBAExB,CAAC;aACN,EAAE;gBACH,SAAS;gBACT,SAAS,CAAO,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,MAAO,EAAE,YAAY,EAAE,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAC7F,SAAS;gBACT,SAAS,CAAO,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,MAAO,EAAE,MAAM,CAAC,EAAE;oBACzD,YAAY,CAAC,MAAM,CAAC,CAAC;oBACrB,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;wBAC7C,MAAM,CAAC,OAAO,EAAE,CAAC;oBACrB,CAAC;gBACL,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;aACjC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IAEP,CAAC,CAAC,CAAC;AAEP,CAAC;AAED;;GAEG;AACH,SAAS,gBAAgB,CAAC,OAAe;IACrC,IAAI,CAAC;QACD,oEAAoE;QACpE,OAAO,IAAA,wBAAQ,EAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,SAAS,CAAC;IAC5D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9B,OAAO,SAAS,CAAC;IACrB,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CAAC,WAAmB;IAC3C,OAAO,WAAW;QACd,0CAA0C;SACzC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;QACpB,sDAAsD;SACrD,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;AACrE,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CAAC,IAAY;IACpC,OAAO,IAAI;SACN,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAC5E,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,eAAe,CAC1B,OAAwB,EACxB,WAA4B,EAC5B,OAA2B;AAC3B,8DAA8D;AAC9D,OAA4B;IAG5B,MAAM,WAAW,GAAG,mBAAmB,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAC3E,KAAK,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,SAAS,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC7H,WAAW,CAAC,KAAK,CAAC,KAAM,CAAC,KAAK,CAAC,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7D,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAChB,OAAwB,EACxB,eAAuB,EACvB,iBAA2B,EAAE;IAE7B,MAAM,KAAK,GAAG,IAAA,qBAAK,EAAC,eAAe,EAAE,cAAc,EAAE,YAAY,CAAC,CAAC;IACnE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,SAAS,CAAC,IAAI,eAAe,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/G,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CACnD,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,SAAS,CAAC,IAAI,eAAe,SAAS,IAAI,YAAY,MAAM,GAAG,CAC/F,CAAC,CAAC,CAAC;IACJ,OAAO;QACH,UAAU,EAAE,eAAe;QAC3B,SAAS,EAAE,EAAE;QACb,KAAK;KACR,CAAC;AACN,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,SAAS,CACpB,OAAwB,EACxB,MAAgB,EAChB,QAA6C,EAC7C,cAAc,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC;IAE9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACnC,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACpB,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,sEAAsE;QACtE,4BAA4B;QAC5B,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;YACrB,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACnB,OAAO;YACX,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC1C,OAAO,CAAC,OAAO,CAAC,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3C,IAAI,IAAI,KAAK,CAAC,KAAK,EAAG,GAAG,IAAI,CAAC;gBAC9B,IAAI,IAAI,IAAI,CAAC;gBACb,KAAK,CAAC,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAC7C,IAAI,CAAC;oBACD,QAAQ,CAAC;wBACL,OAAO,EAAE,CAAC,KAAQ,EAAE,EAAE;4BAClB,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;gCACpB,OAAO,CAAC,OAAO,EAAE,CAAC;gCAClB,OAAO,CAAC,KAAK,CAAC,CAAC;gCACf,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,qBAAqB,CAAC,CAAC,CAAC,CAAC;4BACzE,CAAC;wBACL,CAAC;wBACD,MAAM,EAAE,CAAC,MAAc,EAAE,EAAE;4BACvB,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;gCACpB,OAAO,CAAC,OAAO,EAAE,CAAC;gCAClB,MAAM,CAAC,MAAM,CAAC,CAAC;gCACf,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,qBAAqB,CAAC,CAAC,CAAC,CAAC;4BACvE,CAAC;wBACL,CAAC;wBACD,IAAI;wBACJ,IAAI;qBACP,CAAC,CAAC;gBACP,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACb,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,oBAAoB,CAAC,CAAC,CAAC,CAAC;oBAClE,OAAO,CAAC,OAAO,EAAE,CAAC;oBAClB,MAAM,CAAC,KAAK,CAAC,CAAC;oBACd,MAAM;gBACV,CAAC;gBACD,IAAI,GAAG,EAAE,CAAC;YACd,CAAC;YACD,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;QACrB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AAEP,CAAC;AAqBD;;;;GAIG;AACH,MAAM,eAAe;IAEjB;IACI;;OAEG;IACM,IAAY;IACrB;;;OAGG;IACI,SAAS,IAAI;IACpB;;OAEG;IACI,WAAW,KAAK;QATd,SAAI,GAAJ,IAAI,CAAQ;QAKd,WAAM,GAAN,MAAM,CAAO;QAIb,aAAQ,GAAR,QAAQ,CAAQ;IACvB,CAAC;IAEL,OAAO;QACH,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACzB,CAAC;IAED,QAAQ;QACJ,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjB,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,WAAW,CAAC,sDAAsD,CAAC,CAAC,CAAC;QACnH,CAAC;IACL,CAAC;CAEJ"}

package/lib/common/shell-quoting.d.ts

@@ -0,0 +1,92 @@
+/**
+ * Defines how an argument should be quoted if it contains
+ * spaces or unsupported characters.
+ */
+export declare const enum ShellQuoting {
+    /**
+     * Character escaping should be used. This for example
+     * uses \ on bash and ` on PowerShell.
+     */
+    Escape = "escape",
+    /**
+     * Strong string quoting should be used. This for example
+     * uses " for Windows cmd and ' for bash and PowerShell.
+     * Strong quoting treats arguments as literal strings.
+     * Under PowerShell echo 'The value is $(2 * 3)' will
+     * print `The value is $(2 * 3)`
+     */
+    Strong = "strong",
+    /**
+     * Weak string quoting should be used. This for example
+     * uses " for Windows cmd, bash and PowerShell. Weak quoting
+     * still performs some kind of evaluation inside the quoted
+     * string.  Under PowerShell echo "The value is $(2 * 3)"
+     * will print `The value is 6`
+     */
+    Weak = "weak"
+}
+/**
+ * A string that will be quoted depending on the used shell.
+ */
+export interface ShellQuotedString {
+    /**
+     * The actual string value.
+     */
+    value: string;
+    /**
+     * The quoting style to use.
+     */
+    quoting: ShellQuoting;
+}
+/**
+ * Functions that provide shell quoting capabilities.
+ */
+export interface ShellQuotingFunctions {
+    characters: {
+        /** Characters that require quotes, white space is always implied. */
+        needQuotes?: string;
+        /** The character used to escape sequences. */
+        escape?: string;
+        /** The character used to quote sequences, preventing variable expansion. */
+        strong?: string;
+        /** The character used to quote sequences, allowing variable expansion. */
+        weak?: string;
+    };
+    /**
+     * Should add escape-characters in front of forbidden characters.
+     */
+    escape?(this: any, arg: string): string;
+    /**
+     * Should quote the argument in such a way that variables CANNOT be expanded.
+     */
+    strong?(this: any, arg: string): string;
+    /**
+     * Should quote the argument in such a way that variables CAN be expanded.
+     */
+    weak?(this: any, arg: string): string;
+}
+/**
+ * Converts a list of args into an escaped shell command.
+ *
+ * There are two main use cases when handling command/arguments for a shell:
+ * 1. User already wrote the escaped commandline, then just use that.
+ * 2. User wants a specific process to be invoked with some arguments.
+ *
+ * The `createShellCommandLine` function is useful for the latter.
+ *
+ * @param args Standard list of spawn/exec arguments, first item is the command.
+ * @param quotingFunctions Collection of functions to process arguments.
+ */
+export declare function createShellCommandLine(args: Array<string | ShellQuotedString>, quotingFunctions?: ShellQuotingFunctions): string;
+/**
+ * Escape (or quote) a given input.
+ *
+ * @param arg Input to escape.
+ * @param quotingFunctions Collection of functions to process the given `arg`.
+ * @param quotingType Override the quoting type specified by the given `arg`.
+ */
+export declare function escapeForShell(arg: string | ShellQuotedString, quotingFunctions?: ShellQuotingFunctions, quotingType?: ShellQuoting): string;
+export declare const BashQuotingFunctions: Required<ShellQuotingFunctions>;
+export declare const CmdQuotingFunctions: Required<ShellQuotingFunctions>;
+export declare const PowershellQuotingFunctions: Required<ShellQuotingFunctions>;
+//# sourceMappingURL=shell-quoting.d.ts.map

package/lib/common/shell-quoting.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shell-quoting.d.ts","sourceRoot":"","sources":["../../src/common/shell-quoting.ts"],"names":[],"mappings":"AAyBA;;;GAGG;AACH,0BAAkB,YAAY;IAE1B;;;OAGG;IACH,MAAM,WAAW;IAEjB;;;;;;OAMG;IACH,MAAM,WAAW;IAEjB;;;;;;OAMG;IACH,IAAI,SAAS;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC;CACzB;AAID;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAElC,UAAU,EAAE;QACR,qEAAqE;QACrE,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,8CAA8C;QAC9C,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,4EAA4E;QAC5E,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,0EAA0E;QAC1E,IAAI,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;IAED;;OAEG;IAEH,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;IAEvC;;OAEG;IAEH,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IAExC;;OAEG;IAEH,IAAI,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CACzC;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,GAAG,iBAAiB,CAAC,EAAE,gBAAgB,CAAC,EAAE,qBAAqB,GAAG,MAAM,CAEhI;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,EAAE,gBAAgB,CAAC,EAAE,qBAAqB,EAAE,WAAW,CAAC,EAAE,YAAY,GAAG,MAAM,CAkB5I;AAED,eAAO,MAAM,oBAAoB,EAAE,QAAQ,CAAC,qBAAqB,CAyBhE,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CAAC,qBAAqB,CA8B/D,CAAC;AAEF,eAAO,MAAM,0BAA0B,EAAE,QAAQ,CAAC,qBAAqB,CAyBtE,CAAC"}

package/lib/common/shell-quoting.js

@@ -0,0 +1,146 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2020 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
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PowershellQuotingFunctions = exports.CmdQuotingFunctions = exports.BashQuotingFunctions = exports.escapeForShell = exports.createShellCommandLine = void 0;
+/**
+ * Converts a list of args into an escaped shell command.
+ *
+ * There are two main use cases when handling command/arguments for a shell:
+ * 1. User already wrote the escaped commandline, then just use that.
+ * 2. User wants a specific process to be invoked with some arguments.
+ *
+ * The `createShellCommandLine` function is useful for the latter.
+ *
+ * @param args Standard list of spawn/exec arguments, first item is the command.
+ * @param quotingFunctions Collection of functions to process arguments.
+ */
+function createShellCommandLine(args, quotingFunctions) {
+    return args.map(arg => escapeForShell(arg, quotingFunctions)).join(' ');
+}
+exports.createShellCommandLine = createShellCommandLine;
+/**
+ * Escape (or quote) a given input.
+ *
+ * @param arg Input to escape.
+ * @param quotingFunctions Collection of functions to process the given `arg`.
+ * @param quotingType Override the quoting type specified by the given `arg`.
+ */
+function escapeForShell(arg, quotingFunctions, quotingType) {
+    let value;
+    let quoting = quotingType;
+    if (typeof arg === 'string') {
+        if (!quoting) {
+            return arg;
+        }
+        value = arg;
+    }
+    else {
+        if (!quoting) {
+            quoting = arg.quoting;
+        }
+        value = arg.value;
+    }
+    if (quotingFunctions && typeof quotingFunctions[quoting] === 'function') {
+        return quotingFunctions[quoting](value);
+    }
+    return value;
+}
+exports.escapeForShell = escapeForShell;
+exports.BashQuotingFunctions = {
+    characters: {
+        needQuotes: '()',
+        escape: '\\',
+        strong: '\'',
+        weak: '"',
+    },
+    escape(arg) {
+        return arg
+            .replace(/[\s\\|(){}<>$&;"']/g, '\\$&');
+    },
+    strong(arg) {
+        // ('+) becomes ('"'+"')
+        return `'${arg
+            .replace(/'+/g, '\'"$&"\'')}'`;
+    },
+    weak(arg) {
+        return `"${arg
+            // Escape escape-characters.
+            .replace(/\\"/g, '\\\\"')
+            // Escape user-specified double-quotes.
+            .replace(/"/g, '\\"')
+            // Escape trailing (\), we don't want the user to escape our last quote.
+            .replace(/\\$/g, '\\\\')}"`;
+    },
+};
+exports.CmdQuotingFunctions = {
+    characters: {
+        weak: '"',
+    },
+    escape(arg) {
+        return arg
+            // Escape forbidden characters (see: cmd /?).
+            .replace(/[%&<>()@^|]/g, '^$&')
+            // Some characters must be escaped using `\`.
+            .replace(/[\\"]/g, '\\$&')
+            // Double-quote whitespaces, else we cannot escape it.
+            .replace(/\s+/g, '"$&"');
+    },
+    strong(arg) {
+        return this.weak(arg)
+            // Try to prevent variable expansion.
+            .replace(/%/g, '"%"');
+    },
+    weak(arg) {
+        return `"${arg
+            // Escape double quotes.
+            .replace(/\\"/g, '\\\\"')
+            .replace(/"/g, '\\"')
+            // Escape forbidden characters (see: cmd /?)
+            .replace(/[&<>()@^|]/g, '^$&')
+            // Escape trailing backslash, we don't want the user to escape our last quote.
+            .replace(/\\$/g, '\\\\')
+            // Escape line returns
+            .replace(/\r?\n/g, '^$&')}"`;
+    },
+};
+exports.PowershellQuotingFunctions = {
+    characters: {
+        needQuotes: '()',
+        escape: '`',
+        strong: '\'',
+        weak: '"',
+    },
+    escape(arg) {
+        return arg.replace(/[`|{}()<>;"' ]/g, '`$&');
+    },
+    strong(arg) {
+        // In powershell, one must write ('') for a single quote to be displayed
+        // within a single quoted string.
+        return `'${arg
+            .replace(/'/g, '\'\'')}'`;
+    },
+    weak(arg) {
+        return `"${arg
+            // Escape escape-characters.
+            .replace(/`"/g, '``"')
+            // Escape user-specified backticks.
+            .replace(/"/g, '`"')
+            // Escape trailing (`), we don't want the user to escape our last quote.
+            .replace(/`$/g, '``')}"`;
+    },
+};
+//# sourceMappingURL=shell-quoting.js.map