azure-pipelines-task-lib 3.2.0 → 4.0.0-preview

package/taskcommand.d.ts

@@ -1,10 +1,10 @@
-export declare class TaskCommand {
-    constructor(command: any, properties: any, message: any);
-    command: string;
-    message: string;
-    properties: {
-        [key: string]: string;
-    };
-    toString(): string;
-}
-export declare function commandFromString(commandLine: any): TaskCommand;
+export declare class TaskCommand {
+    constructor(command: any, properties: any, message: any);
+    command: string;
+    message: string;
+    properties: {
+        [key: string]: string;
+    };
+    toString(): string;
+}
+export declare function commandFromString(commandLine: any): TaskCommand;

package/taskcommand.js

@@ -1,103 +1,103 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.commandFromString = exports.TaskCommand = void 0;
-//
-// Command Format:
-//    ##vso[artifact.command key=value;key=value]user message
-//    
-// Examples:
-//    ##vso[task.progress value=58]
-//    ##vso[task.issue type=warning;]This is the user warning message
-//
-var CMD_PREFIX = '##vso[';
-var TaskCommand = /** @class */ (function () {
-    function TaskCommand(command, properties, message) {
-        if (!command) {
-            command = 'missing.command';
-        }
-        this.command = command;
-        this.properties = properties;
-        this.message = message;
-    }
-    TaskCommand.prototype.toString = function () {
-        var cmdStr = CMD_PREFIX + this.command;
-        if (this.properties && Object.keys(this.properties).length > 0) {
-            cmdStr += ' ';
-            for (var key in this.properties) {
-                if (this.properties.hasOwnProperty(key)) {
-                    var val = this.properties[key];
-                    if (val) {
-                        // safely append the val - avoid blowing up when attempting to
-                        // call .replace() if message is not a string for some reason
-                        cmdStr += key + '=' + escape('' + (val || '')) + ';';
-                    }
-                }
-            }
-        }
-        cmdStr += ']';
-        // safely append the message - avoid blowing up when attempting to
-        // call .replace() if message is not a string for some reason
-        var message = '' + (this.message || '');
-        cmdStr += escapedata(message);
-        return cmdStr;
-    };
-    return TaskCommand;
-}());
-exports.TaskCommand = TaskCommand;
-function commandFromString(commandLine) {
-    var preLen = CMD_PREFIX.length;
-    var lbPos = commandLine.indexOf('[');
-    var rbPos = commandLine.indexOf(']');
-    if (lbPos == -1 || rbPos == -1 || rbPos - lbPos < 3) {
-        throw new Error('Invalid command brackets');
-    }
-    var cmdInfo = commandLine.substring(lbPos + 1, rbPos);
-    var spaceIdx = cmdInfo.indexOf(' ');
-    var command = cmdInfo;
-    var properties = {};
-    if (spaceIdx > 0) {
-        command = cmdInfo.trim().substring(0, spaceIdx);
-        var propSection = cmdInfo.trim().substring(spaceIdx + 1);
-        var propLines = propSection.split(';');
-        propLines.forEach(function (propLine) {
-            propLine = propLine.trim();
-            if (propLine.length > 0) {
-                var eqIndex = propLine.indexOf('=');
-                if (eqIndex == -1) {
-                    throw new Error('Invalid property: ' + propLine);
-                }
-                var key = propLine.substring(0, eqIndex);
-                var val = propLine.substring(eqIndex + 1);
-                properties[key] = unescape(val);
-            }
-        });
-    }
-    var msg = unescapedata(commandLine.substring(rbPos + 1));
-    var cmd = new TaskCommand(command, properties, msg);
-    return cmd;
-}
-exports.commandFromString = commandFromString;
-function escapedata(s) {
-    return s.replace(/%/g, '%AZP25')
-        .replace(/\r/g, '%0D')
-        .replace(/\n/g, '%0A');
-}
-function unescapedata(s) {
-    return s.replace(/%0D/g, '\r')
-        .replace(/%0A/g, '\n')
-        .replace(/%AZP25/g, '%');
-}
-function escape(s) {
-    return s.replace(/%/g, '%AZP25')
-        .replace(/\r/g, '%0D')
-        .replace(/\n/g, '%0A')
-        .replace(/]/g, '%5D')
-        .replace(/;/g, '%3B');
-}
-function unescape(s) {
-    return s.replace(/%0D/g, '\r')
-        .replace(/%0A/g, '\n')
-        .replace(/%5D/g, ']')
-        .replace(/%3B/g, ';')
-        .replace(/%AZP25/g, '%');
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.commandFromString = exports.TaskCommand = void 0;
+//
+// Command Format:
+//    ##vso[artifact.command key=value;key=value]user message
+//    
+// Examples:
+//    ##vso[task.progress value=58]
+//    ##vso[task.issue type=warning;]This is the user warning message
+//
+var CMD_PREFIX = '##vso[';
+var TaskCommand = /** @class */ (function () {
+    function TaskCommand(command, properties, message) {
+        if (!command) {
+            command = 'missing.command';
+        }
+        this.command = command;
+        this.properties = properties;
+        this.message = message;
+    }
+    TaskCommand.prototype.toString = function () {
+        var cmdStr = CMD_PREFIX + this.command;
+        if (this.properties && Object.keys(this.properties).length > 0) {
+            cmdStr += ' ';
+            for (var key in this.properties) {
+                if (this.properties.hasOwnProperty(key)) {
+                    var val = this.properties[key];
+                    if (val) {
+                        // safely append the val - avoid blowing up when attempting to
+                        // call .replace() if message is not a string for some reason
+                        cmdStr += key + '=' + escape('' + (val || '')) + ';';
+                    }
+                }
+            }
+        }
+        cmdStr += ']';
+        // safely append the message - avoid blowing up when attempting to
+        // call .replace() if message is not a string for some reason
+        var message = '' + (this.message || '');
+        cmdStr += escapedata(message);
+        return cmdStr;
+    };
+    return TaskCommand;
+}());
+exports.TaskCommand = TaskCommand;
+function commandFromString(commandLine) {
+    var preLen = CMD_PREFIX.length;
+    var lbPos = commandLine.indexOf('[');
+    var rbPos = commandLine.indexOf(']');
+    if (lbPos == -1 || rbPos == -1 || rbPos - lbPos < 3) {
+        throw new Error('Invalid command brackets');
+    }
+    var cmdInfo = commandLine.substring(lbPos + 1, rbPos);
+    var spaceIdx = cmdInfo.indexOf(' ');
+    var command = cmdInfo;
+    var properties = {};
+    if (spaceIdx > 0) {
+        command = cmdInfo.trim().substring(0, spaceIdx);
+        var propSection = cmdInfo.trim().substring(spaceIdx + 1);
+        var propLines = propSection.split(';');
+        propLines.forEach(function (propLine) {
+            propLine = propLine.trim();
+            if (propLine.length > 0) {
+                var eqIndex = propLine.indexOf('=');
+                if (eqIndex == -1) {
+                    throw new Error('Invalid property: ' + propLine);
+                }
+                var key = propLine.substring(0, eqIndex);
+                var val = propLine.substring(eqIndex + 1);
+                properties[key] = unescape(val);
+            }
+        });
+    }
+    var msg = unescapedata(commandLine.substring(rbPos + 1));
+    var cmd = new TaskCommand(command, properties, msg);
+    return cmd;
+}
+exports.commandFromString = commandFromString;
+function escapedata(s) {
+    return s.replace(/%/g, '%AZP25')
+        .replace(/\r/g, '%0D')
+        .replace(/\n/g, '%0A');
+}
+function unescapedata(s) {
+    return s.replace(/%0D/g, '\r')
+        .replace(/%0A/g, '\n')
+        .replace(/%AZP25/g, '%');
+}
+function escape(s) {
+    return s.replace(/%/g, '%AZP25')
+        .replace(/\r/g, '%0D')
+        .replace(/\n/g, '%0A')
+        .replace(/]/g, '%5D')
+        .replace(/;/g, '%3B');
+}
+function unescape(s) {
+    return s.replace(/%0D/g, '\r')
+        .replace(/%0A/g, '\n')
+        .replace(/%5D/g, ']')
+        .replace(/%3B/g, ';')
+        .replace(/%AZP25/g, '%');
+}

package/toolrunner.d.ts

@@ -1,159 +1,159 @@
-/// <reference types="node" />
-import Q = require('q');
-import events = require('events');
-/**
- * Interface for exec options
- */
-export interface IExecOptions extends IExecSyncOptions {
-    /** optional.  whether to fail if output to stderr.  defaults to false */
-    failOnStdErr?: boolean;
-    /** optional.  defaults to failing on non zero.  ignore will not fail leaving it up to the caller */
-    ignoreReturnCode?: boolean;
-}
-/**
- * Interface for execSync options
- */
-export interface IExecSyncOptions {
-    /** optional working directory.  defaults to current */
-    cwd?: string;
-    /** optional envvar dictionary.  defaults to current process's env */
-    env?: {
-        [key: string]: string | undefined;
-    };
-    /** optional.  defaults to false */
-    silent?: boolean;
-    /** Optional. Default is process.stdout. */
-    outStream?: NodeJS.WritableStream;
-    /** Optional. Default is process.stderr. */
-    errStream?: NodeJS.WritableStream;
-    /** optional. Whether to skip quoting/escaping arguments if needed.  defaults to false. */
-    windowsVerbatimArguments?: boolean;
-    /** optional. Run command inside of the shell.  Defaults to false. */
-    shell?: boolean;
-}
-/**
- * Interface for exec results returned from synchronous exec functions
- */
-export interface IExecSyncResult {
-    /** standard output */
-    stdout: string;
-    /** error output */
-    stderr: string;
-    /** return code */
-    code: number;
-    /** Error on failure */
-    error: Error;
-}
-export declare class ToolRunner extends events.EventEmitter {
-    constructor(toolPath: string);
-    private readonly cmdSpecialChars;
-    private toolPath;
-    private args;
-    private pipeOutputToTool;
-    private pipeOutputToFile;
-    private childProcess;
-    private _debug;
-    private _argStringToArray;
-    private _getCommandString;
-    private _processLineBuffer;
-    /**
-     * Wraps an arg string with specified char if it's not already wrapped
-     * @returns {string} Arg wrapped with specified char
-     * @param {string} arg Input argument string
-     * @param {string} wrapChar A char input string should be wrapped with
-     */
-    private _wrapArg;
-    /**
-     * Unwraps an arg string wrapped with specified char
-     * @param arg Arg wrapped with specified char
-     * @param wrapChar A char to be removed
-     */
-    private _unwrapArg;
-    /**
-     * Determine if arg string is wrapped with specified char
-     * @param arg Input arg string
-     */
-    private _isWrapped;
-    private _getSpawnFileName;
-    private _getSpawnArgs;
-    /**
-     * Escape specified character.
-     * @param arg String to escape char in
-     * @param charToEscape Char should be escaped
-     */
-    private _escapeChar;
-    private _isCmdFile;
-    /**
-     * Determine whether the cmd arg needs to be quoted. Returns true if arg contains any of special chars array.
-     * @param arg The cmd command arg.
-     * @param additionalChars Additional chars which should be also checked.
-     */
-    private _needQuotesForCmd;
-    private _windowsQuoteCmdArg;
-    private _uv_quote_cmd_arg;
-    private _cloneExecOptions;
-    private _getSpawnOptions;
-    private _getSpawnSyncOptions;
-    private execWithPiping;
-    /**
-     * Add argument
-     * Append an argument or an array of arguments
-     * returns ToolRunner for chaining
-     *
-     * @param     val        string cmdline or array of strings
-     * @returns   ToolRunner
-     */
-    arg(val: string | string[]): ToolRunner;
-    /**
-     * Parses an argument line into one or more arguments
-     * e.g. .line('"arg one" two -z') is equivalent to .arg(['arg one', 'two', '-z'])
-     * returns ToolRunner for chaining
-     *
-     * @param     val        string argument line
-     * @returns   ToolRunner
-     */
-    line(val: string): ToolRunner;
-    /**
-     * Add argument(s) if a condition is met
-     * Wraps arg().  See arg for details
-     * returns ToolRunner for chaining
-     *
-     * @param     condition     boolean condition
-     * @param     val     string cmdline or array of strings
-     * @returns   ToolRunner
-     */
-    argIf(condition: any, val: any): this;
-    /**
-     * Pipe output of exec() to another tool
-     * @param tool
-     * @param file  optional filename to additionally stream the output to.
-     * @returns {ToolRunner}
-     */
-    pipeExecOutputToTool(tool: ToolRunner, file?: string): ToolRunner;
-    /**
-     * Exec a tool.
-     * Output will be streamed to the live console.
-     * Returns promise with return code
-     *
-     * @param     tool     path to tool to exec
-     * @param     options  optional exec options.  See IExecOptions
-     * @returns   number
-     */
-    exec(options?: IExecOptions): Q.Promise<number>;
-    /**
-     * Exec a tool synchronously.
-     * Output will be *not* be streamed to the live console.  It will be returned after execution is complete.
-     * Appropriate for short running tools
-     * Returns IExecSyncResult with output and return code
-     *
-     * @param     tool     path to tool to exec
-     * @param     options  optional exec options.  See IExecSyncOptions
-     * @returns   IExecSyncResult
-     */
-    execSync(options?: IExecSyncOptions): IExecSyncResult;
-    /**
-     * Used to close child process by sending SIGNINT signal.
-     * It allows executed script to have some additional logic on SIGINT, before exiting.
-     */
-    killChildProcess(): void;
-}
+/// <reference types="node" />
+import Q = require('q');
+import events = require('events');
+/**
+ * Interface for exec options
+ */
+export interface IExecOptions extends IExecSyncOptions {
+    /** optional.  whether to fail if output to stderr.  defaults to false */
+    failOnStdErr?: boolean;
+    /** optional.  defaults to failing on non zero.  ignore will not fail leaving it up to the caller */
+    ignoreReturnCode?: boolean;
+}
+/**
+ * Interface for execSync options
+ */
+export interface IExecSyncOptions {
+    /** optional working directory.  defaults to current */
+    cwd?: string;
+    /** optional envvar dictionary.  defaults to current process's env */
+    env?: {
+        [key: string]: string | undefined;
+    };
+    /** optional.  defaults to false */
+    silent?: boolean;
+    /** Optional. Default is process.stdout. */
+    outStream?: NodeJS.WritableStream;
+    /** Optional. Default is process.stderr. */
+    errStream?: NodeJS.WritableStream;
+    /** optional. Whether to skip quoting/escaping arguments if needed.  defaults to false. */
+    windowsVerbatimArguments?: boolean;
+    /** optional. Run command inside of the shell.  Defaults to false. */
+    shell?: boolean;
+}
+/**
+ * Interface for exec results returned from synchronous exec functions
+ */
+export interface IExecSyncResult {
+    /** standard output */
+    stdout: string;
+    /** error output */
+    stderr: string;
+    /** return code */
+    code: number;
+    /** Error on failure */
+    error: Error;
+}
+export declare class ToolRunner extends events.EventEmitter {
+    constructor(toolPath: string);
+    private readonly cmdSpecialChars;
+    private toolPath;
+    private args;
+    private pipeOutputToTool;
+    private pipeOutputToFile;
+    private childProcess;
+    private _debug;
+    private _argStringToArray;
+    private _getCommandString;
+    private _processLineBuffer;
+    /**
+     * Wraps an arg string with specified char if it's not already wrapped
+     * @returns {string} Arg wrapped with specified char
+     * @param {string} arg Input argument string
+     * @param {string} wrapChar A char input string should be wrapped with
+     */
+    private _wrapArg;
+    /**
+     * Unwraps an arg string wrapped with specified char
+     * @param arg Arg wrapped with specified char
+     * @param wrapChar A char to be removed
+     */
+    private _unwrapArg;
+    /**
+     * Determine if arg string is wrapped with specified char
+     * @param arg Input arg string
+     */
+    private _isWrapped;
+    private _getSpawnFileName;
+    private _getSpawnArgs;
+    /**
+     * Escape specified character.
+     * @param arg String to escape char in
+     * @param charToEscape Char should be escaped
+     */
+    private _escapeChar;
+    private _isCmdFile;
+    /**
+     * Determine whether the cmd arg needs to be quoted. Returns true if arg contains any of special chars array.
+     * @param arg The cmd command arg.
+     * @param additionalChars Additional chars which should be also checked.
+     */
+    private _needQuotesForCmd;
+    private _windowsQuoteCmdArg;
+    private _uv_quote_cmd_arg;
+    private _cloneExecOptions;
+    private _getSpawnOptions;
+    private _getSpawnSyncOptions;
+    private execWithPiping;
+    /**
+     * Add argument
+     * Append an argument or an array of arguments
+     * returns ToolRunner for chaining
+     *
+     * @param     val        string cmdline or array of strings
+     * @returns   ToolRunner
+     */
+    arg(val: string | string[]): ToolRunner;
+    /**
+     * Parses an argument line into one or more arguments
+     * e.g. .line('"arg one" two -z') is equivalent to .arg(['arg one', 'two', '-z'])
+     * returns ToolRunner for chaining
+     *
+     * @param     val        string argument line
+     * @returns   ToolRunner
+     */
+    line(val: string): ToolRunner;
+    /**
+     * Add argument(s) if a condition is met
+     * Wraps arg().  See arg for details
+     * returns ToolRunner for chaining
+     *
+     * @param     condition     boolean condition
+     * @param     val     string cmdline or array of strings
+     * @returns   ToolRunner
+     */
+    argIf(condition: any, val: any): this;
+    /**
+     * Pipe output of exec() to another tool
+     * @param tool
+     * @param file  optional filename to additionally stream the output to.
+     * @returns {ToolRunner}
+     */
+    pipeExecOutputToTool(tool: ToolRunner, file?: string): ToolRunner;
+    /**
+     * Exec a tool.
+     * Output will be streamed to the live console.
+     * Returns promise with return code
+     *
+     * @param     tool     path to tool to exec
+     * @param     options  optional exec options.  See IExecOptions
+     * @returns   number
+     */
+    exec(options?: IExecOptions): Q.Promise<number>;
+    /**
+     * Exec a tool synchronously.
+     * Output will be *not* be streamed to the live console.  It will be returned after execution is complete.
+     * Appropriate for short running tools
+     * Returns IExecSyncResult with output and return code
+     *
+     * @param     tool     path to tool to exec
+     * @param     options  optional exec options.  See IExecSyncOptions
+     * @returns   IExecSyncResult
+     */
+    execSync(options?: IExecSyncOptions): IExecSyncResult;
+    /**
+     * Used to close child process by sending SIGNINT signal.
+     * It allows executed script to have some additional logic on SIGINT, before exiting.
+     */
+    killChildProcess(): void;
+}