From e39e25ee2d55aa8409847aa5c5ce4ad7357863b2 Mon Sep 17 00:00:00 2001 From: Patrick Stadler Date: Tue, 18 Feb 2014 11:40:05 +0100 Subject: [PATCH] fix docs, bump version --- README.md | 4 +++- lib/transport/transport.js | 8 ++++---- package.json | 4 ++-- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cf47975..8707818 100644 --- a/README.md +++ b/README.md @@ -378,6 +378,8 @@ is formatted correctly within the current context. transport.log('Copying files to remote hosts'); ``` +### transport.prompt(message[, options]) → input + Prompt for user input. ```javascript @@ -386,7 +388,7 @@ if(input.indexOf('yes') === -1) { local.abort('user canceled flight'); } -// prompt for password (hide input UNIX style) +// prompt for password (with UNIX-style hidden input) var password = local.prompt('Enter your password:', { hidden: true }); ``` diff --git a/lib/transport/transport.js b/lib/transport/transport.js index 8ef63d8..27fe097 100644 --- a/lib/transport/transport.js +++ b/lib/transport/transport.js @@ -187,14 +187,14 @@ Transport.prototype = { * local.abort('user canceled flight'); * } * - * // prompt for password (hide input UNIX style) + * // prompt for password (with UNIX-style hidden input) * var password = local.prompt('Enter your password:', { hidden: true }); * ``` * - * @method(query[, options]) + * @method prompt(message[, options]) * @return input */ - prompt: function(query, options) { + prompt: function(message, options) { options = options || {}; var fiber = Fiber.current; @@ -204,7 +204,7 @@ Transport.prototype = { prompt.get([{ name: 'input', - description: ' ' + query.white, + description: ' ' + message.white, hidden: options.hidden || false, required: options.required || false }], function(err, result) { diff --git a/package.json b/package.json index b67dc0f..47b38cd 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "flightplan", "description": "Run a sequence of commands against local and remote hosts", - "version": "0.1.4", + "version": "0.1.5", "author": "Patrick Stadler ", "keywords": [ "deploy", @@ -38,7 +38,7 @@ }, "devDependencies": { "gulp": "~3.5.2", - "gulp-jshint": "~1.4.0", + "gulp-jshint": "~1.4.2", "jshint-stylish": "~0.1.5", "markdox": "~0.1.2" },