Edit File - File Manager

Edit File: prompt.html

<!DOCTYPE html> <html> <head> <title>prompt.js</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> prompt.js </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">&#182;</a> </div> </td> <td class="code"> <div class="highlight"><pre>/*
 * prompt.js: Simple prompt for prompting information from the command line 
 *
 * (C) 2010, Nodejitsu Inc.
 *
 */

var events = require(&#39;events&#39;),
 async = require(&#39;async&#39;),
 colors = require(&#39;colors&#39;),
 winston = require(&#39;winston&#39;),
 stdio = process.binding(&#39;stdio&#39;);</pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">&#182;</a> </div> <h3>@private function capitalize (str)</h3>

<h4>str {string} String to capitalize</h4>

Capitalizes the string supplied. </td> <td class="code"> <div class="highlight"><pre>function capitalize(str) {
 return str.charAt(0).toUpperCase() + str.slice(1);
}

var prompt = module.exports = Object.create(events.EventEmitter.prototype);

var logger = prompt.logger = new winston.Logger({
 transports: [
 new (winston.transports.Console)()
 ]
});
 
prompt.started = false;
prompt.paused = false;
prompt.allowEmpty = false;

var stdin, stdout;</pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">&#182;</a> </div> Create an empty object for the properties 
known to <code>prompt</code> </td> <td class="code"> <div class="highlight"><pre>prompt.properties = {};</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">&#182;</a> </div> Setup the default winston logger to use 
the <code>cli</code> levels and colors. </td> <td class="code"> <div class="highlight"><pre>logger.cli();</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">&#182;</a> </div> <h3>function start (options)</h3>

<h4>@options {Object} Optional Options to consume by prompt</h4>

Starts the prompt by listening to the appropriate events on <code>options.stdin</code>
and <code>options.stdout</code>. If no streams are supplied, then <code>process.stdin</code> 
and <code>process.stdout</code> are used, respectively. </td> <td class="code"> <div class="highlight"><pre>prompt.start = function (options) {
 if (prompt.started) {
 return;
 }
 
 options = options || {};
 stdin = options.stdin || process.openStdin();
 stdout = options.stdout || process.stdout;
 
 prompt.allowEmpty = options.allowEmpty || false;
 
 process.on(&#39;SIGINT&#39;, function () {
 stdout.write(&#39;\n&#39;);
 process.exit(1);
 })
 
 prompt.emit(&#39;start&#39;);
 prompt.started = true;
 return prompt;
};</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">&#182;</a> </div> <h3>function pause ()</h3>

Pauses input coming in from stdin </td> <td class="code"> <div class="highlight"><pre>prompt.pause = function () {
 if (!prompt.started || prompt.paused) {
 return;
 }
 
 stdin.pause();
 prompt.emit(&#39;pause&#39;);
 prompt.paused = true;
 return prompt;
};</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">&#182;</a> </div> <h3>function resume ()</h3>

Resumes input coming in from stdin </td> <td class="code"> <div class="highlight"><pre>prompt.resume = function () {
 if (!prompt.started || !prompt.paused) {
 return;
 }
 
 stdin.resume();
 prompt.emit(&#39;resume&#39;);
 prompt.paused = false;
 return prompt;
};</pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">&#182;</a> </div> <h3>function get (msg, [validator,] callback)</h3>

<h4>@msg {Array|Object|string} Set of variables to get input for.</h4>

<h4>@callback {function} Continuation to pass control to when complete.</h4>

Gets input from the user via stdin for the specified message(s) <code>msg</code>. </td> <td class="code"> <div class="highlight"><pre>prompt.get = function (msg, callback) {
 var vars = !Array.isArray(msg) ? [msg] : msg,
 result = {};
 
 vars = vars.map(function (v) {
 if (typeof v === &#39;string&#39;) {
 v = v.toLowerCase();
 }
 
 return prompt.properties[v] || v;
 });
 
 function get(target, next) {
 prompt.getInput(target, function (err, line) {
 if (err) {
 return next(err);
 }
 
 var name = target.name || target;
 result[name] = line;
 next();
 });
 }
 
 async.forEachSeries(vars, get, function (err) {
 return err ? callback(err) : callback(null, result);
 });
 
 return prompt;
};</pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">&#182;</a> </div> <h3>function getInput (msg, validator, callback)</h3>

<h4>@msg {Object|string} Variable to get input for.</h4>

<h4>@callback {function} Continuation to pass control to when complete.</h4>

Gets input from the user via stdin for the specified message <code>msg</code>. </td> <td class="code"> <div class="highlight"><pre>prompt.getInput = function (prop, callback) {
 var name = prop.message || prop.name || prop,
 raw = [&#39;prompt&#39;, &#39;: &#39; + name.grey, &#39;: &#39;.grey],
 read = prop.hidden ? prompt.readLineHidden : prompt.readLine,
 length, msg;
 
 if (prop.default) {
 raw.splice(2, -1, &#39; (&#39; + prop.default + &#39;)&#39;);
 }
 </pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">&#182;</a> </div> Calculate the raw length and colorize the prompt </td> <td class="code"> <div class="highlight"><pre> length = raw.join(&#39;&#39;).length;
 raw[0] = raw[0];
 msg = raw.join(&#39;&#39;);
 
 if (prop.help) {
 prop.help.forEach(function (line) {
 logger.help(line);
 });
 }
 
 stdout.write(msg); 
 prompt.emit(&#39;prompt&#39;, prop);
 
 read.call(null, function (err, line) {
 if (err) {
 return callback(err);
 }
 
 if (!line || line === &#39;&#39;) {
 line = prop.default || line;
 }
 
 if (prop.validator || prop.empty === false) {
 var valid;
 
 if (prop.validator) {
 valid = prop.validator.test 
 ? prop.validator.test(line)
 : prop.validator(line);
 }
 
 if (prop.empty === false &amp;&amp; valid) {
 valid = line.length &gt; 0;
 prop.warning = prop.warning || &#39;You must supply a value.&#39;;
 }
 
 if (!valid) {
 logger.error(&#39;Invalid input for &#39; + name.grey);
 if (prop.warning) {
 logger.error(prop.warning);
 }
 
 prompt.emit(&#39;invalid&#39;, prop, line);
 return prompt.getInput(prop, callback);
 }
 }
 
 logger.input(line.yellow);
 callback(null, line);
 });

return prompt;
};</pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">&#182;</a> </div> <h3>function addProperties (obj, properties, callback)</h3>

<h4>@obj {Object} Object to add properties to</h4>

<h4>@properties {Array} List of properties to get values for</h4>

<h4>@callback {function} Continuation to pass control to when complete.</h4>

Prompts the user for values each of the <code>properties</code> if <code>obj</code> does not already
have a value for the property. Responds with the modified object. </td> <td class="code"> <div class="highlight"><pre>prompt.addProperties = function (obj, properties, callback) {
 properties = properties.filter(function (prop) {
 return typeof obj[prop] === &#39;undefined&#39;;
 });
 
 if (properties.length === 0) {
 return callback(obj);
 }
 
 prompt.get(properties, function (err, results) {
 if (err) {
 return callback(err);
 }
 else if (!results) {
 return callback(null, obj);
 }
 
 function putNested (obj, path, value) {
 var last = obj, key; 
 
 while (path.length &gt; 1) {
 key = path.shift();
 if (!last[key]) {
 last[key] = {};
 }
 
 last = last[key];
 }
 
 last[path.shift()] = value;
 }
 
 Object.keys(results).forEach(function (key) {
 putNested(obj, key.split(&#39;.&#39;), results[key]);
 });
 
 callback(null, obj);
 });
 
 return prompt;
};</pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">&#182;</a> </div> <h3>function readLine (callback)</h3>

<h4>@callback {function} Continuation to respond to when complete</h4>

Gets a single line of input from the user. </td> <td class="code"> <div class="highlight"><pre>prompt.readLine = function (callback) {
 var value = &#39;&#39;, buffer = &#39;&#39;;
 prompt.resume();
 stdin.setEncoding(&#39;utf8&#39;);
 stdin.on(&#39;error&#39;, callback);
 stdin.on(&#39;data&#39;, function data (chunk) {
 value += buffer + chunk;
 buffer = &#39;&#39;;
 value = value.replace(/\r/g, &#39;&#39;);
 if (value.indexOf(&#39;\n&#39;) !== -1) {
 if (value !== &#39;\n&#39;) {
 value = value.replace(/^\n+/, &#39;&#39;);
 }
 
 buffer = value.substr(value.indexOf(&#39;\n&#39;));
 val = value.substr(0, value.indexOf(&#39;\n&#39;));
 prompt.pause();
 stdin.removeListener(&#39;data&#39;, data);
 stdin.removeListener(&#39;error&#39;, callback);
 value = value.trim();
 callback(null, value);
 }
 });
 
 return prompt;
};</pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">&#182;</a> </div> <h3>function readLineHidden (callback)</h3>

<h4>@callback {function} Continuation to respond to when complete</h4>

Gets a single line of hidden input (i.e. <code>rawMode = true</code>) from the user. </td> <td class="code"> <div class="highlight"><pre>prompt.readLineHidden = function (callback) {
 var value = &#39;&#39;, buffer = &#39;&#39;;
 stdio.setRawMode(true);
 prompt.resume();
 stdin.on(&#39;error&#39;, callback);
 stdin.on(&#39;data&#39;, function data (c) {
 c = &#39;&#39; + c;
 switch (c) {
 case &#39;\n&#39;: case &#39;\r&#39;: case &#39;\r\n&#39;: case &#39;\u0004&#39;:
 stdio.setRawMode(false);
 stdin.removeListener(&#39;data&#39;, data);
 stdin.removeListener(&#39;error&#39;, callback);
 value = value.trim();
 stdout.write(&#39;\n&#39;);
 stdout.flush();
 prompt.pause();
 return callback(null, value)
 case &#39;\u0003&#39;: case &#39;\0&#39;:
 stdout.write(&#39;\n&#39;);
 process.exit(1);
 break;
 default:
 value += buffer + c
 buffer = &#39;&#39;;
 break;
 }
 });
 
 return prompt;
};

</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>

Back to File Manager