add advanced options to Transport#exec()

Author: pstadler

README.md

@@ -377,6 +377,19 @@ var result = transport.echo('Hello world');
 console.log(result); // { code: 0, stdout: 'Hello world\n', stderr: null }
 ```
 
+#### Advanced options
+Flightplan uses `child_process#exec()` for executing local commands and
+`mscdex/ssh2#exec()` for remote commands. Options passed with `exec` will
+be forwarded to either of these functions.
+
+```javascript
+// increase maxBuffer for child_process#exec()
+local.ls('-al', {exec: {maxBuffer: 2000*1024}});
+
+// enable pty for mscdex/ssh2#exec()
+remote.ls('-al', {exec: {pty: true}});
+```
+
 ### <a name="transport.sudo(command%5B%2C%20options%5D)"></a>transport.sudo(command[, options]) → code: int, stdout: String, stderr: String
 
 Execute a command as another user with `sudo()`. It has the same

lib/transport/index.js

@@ -117,6 +117,19 @@ Transport.prototype._exec = function() {
  * console.log(result); // { code: 0, stdout: 'Hello world\n', stderr: null }
  * ```
  *
+ * #### Advanced options
+ * Flightplan uses `child_process#exec()` for executing local commands and
+ * `mscdex/ssh2#exec()` for remote commands. Options passed with `exec` will
+ * be forwarded to either of these functions.
+ *
+ * ```javascript
+ * // increase maxBuffer for child_process#exec()
+ * local.ls('-al', {exec: {maxBuffer: 2000*1024}});
+ *
+ * // enable pty for mscdex/ssh2#exec()
+ * remote.ls('-al', {exec: {pty: true}});
+ * ```
+ *
  * @method exec(command[, options])
  * @return code: int, stdout: String, stderr: String
  */

lib/transport/shell.js

@@ -30,7 +30,7 @@ Shell.prototype._exec = function(command, options) {
   self._logger.command(command);
 
   var fiber = Fiber.current;
-  var proc = exec(command, { maxBuffer: 1000*1024 });
+  var proc = exec(command, extend({ maxBuffer: 1000*1024 }, options.exec));
 
   proc.stdout.on('data', function(data) {
     result.stdout = (result.stdout || '') + data;

lib/transport/ssh.js

@@ -52,7 +52,7 @@ SSH.prototype._exec = function(command, options) {
 
   var fiber = Fiber.current;
 
-  self._connection.exec(command, function(err, stream) {
+  self._connection.exec(command, options.exec || {}, function(err, stream) {
 
     stream.on('data', function(data) {
       result.stdout = (result.stdout || '') + data;

package.json

@@ -1,7 +1,7 @@
 {
   "name": "flightplan",
   "description": "Library for streamlining application deployment or systems administration tasks",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "author": "Patrick Stadler <[email protected]>",
   "keywords": [
     "deploy",