prompt.js | |
|---|---|
/*
- * prompt.js: Simple prompt for prompting information from the command line
- *
- * (C) 2010, Nodejitsu Inc.
- *
- */
-
-var events = require('events'),
- async = require('async'),
- colors = require('colors'),
- winston = require('winston'),
- stdio = process.binding('stdio'); | |
@private function capitalize (str)- -str {string} String to capitalize- -Capitalizes the string supplied. | 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; |
| Create an empty object for the properties
-known to | prompt.properties = {}; |
| Setup the default winston logger to use
-the | logger.cli(); |
function start (options)- -@options {Object} Optional Options to consume by prompt- -Starts the prompt by listening to the appropriate events on | 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('SIGINT', function () {
- stdout.write('\n');
- process.exit(1);
- })
-
- prompt.emit('start');
- prompt.started = true;
- return prompt;
-}; |
function pause ()- -Pauses input coming in from stdin | prompt.pause = function () {
- if (!prompt.started || prompt.paused) {
- return;
- }
-
- stdin.pause();
- prompt.emit('pause');
- prompt.paused = true;
- return prompt;
-}; |
function resume ()- -Resumes input coming in from stdin | prompt.resume = function () {
- if (!prompt.started || !prompt.paused) {
- return;
- }
-
- stdin.resume();
- prompt.emit('resume');
- prompt.paused = false;
- return prompt;
-}; |
function get (msg, [validator,] callback)- -@msg {Array|Object|string} Set of variables to get input for.- -@callback {function} Continuation to pass control to when complete.- -Gets input from the user via stdin for the specified message(s) | prompt.get = function (msg, callback) {
- var vars = !Array.isArray(msg) ? [msg] : msg,
- result = {};
-
- vars = vars.map(function (v) {
- if (typeof v === 'string') {
- 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;
-}; |
function getInput (msg, validator, callback)- -@msg {Object|string} Variable to get input for.- -@callback {function} Continuation to pass control to when complete.- -Gets input from the user via stdin for the specified message | prompt.getInput = function (prop, callback) {
- var name = prop.message || prop.name || prop,
- raw = ['prompt', ': ' + name.grey, ': '.grey],
- read = prop.hidden ? prompt.readLineHidden : prompt.readLine,
- length, msg;
-
- if (prop.default) {
- raw.splice(2, -1, ' (' + prop.default + ')');
- }
- |
| Calculate the raw length and colorize the prompt | length = raw.join('').length;
- raw[0] = raw[0];
- msg = raw.join('');
-
- if (prop.help) {
- prop.help.forEach(function (line) {
- logger.help(line);
- });
- }
-
- stdout.write(msg);
- prompt.emit('prompt', prop);
-
- read.call(null, function (err, line) {
- if (err) {
- return callback(err);
- }
-
- if (!line || line === '') {
- 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 && valid) {
- valid = line.length > 0;
- prop.warning = prop.warning || 'You must supply a value.';
- }
-
- if (!valid) {
- logger.error('Invalid input for ' + name.grey);
- if (prop.warning) {
- logger.error(prop.warning);
- }
-
- prompt.emit('invalid', prop, line);
- return prompt.getInput(prop, callback);
- }
- }
-
- logger.input(line.yellow);
- callback(null, line);
- });
-
- return prompt;
-}; |
function addProperties (obj, properties, callback)- -@obj {Object} Object to add properties to- -@properties {Array} List of properties to get values for- -@callback {function} Continuation to pass control to when complete.- -Prompts the user for values each of the | prompt.addProperties = function (obj, properties, callback) {
- properties = properties.filter(function (prop) {
- return typeof obj[prop] === 'undefined';
- });
-
- 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 > 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('.'), results[key]);
- });
-
- callback(null, obj);
- });
-
- return prompt;
-}; |
function readLine (callback)- -@callback {function} Continuation to respond to when complete- -Gets a single line of input from the user. | prompt.readLine = function (callback) {
- var value = '', buffer = '';
- prompt.resume();
- stdin.setEncoding('utf8');
- stdin.on('error', callback);
- stdin.on('data', function data (chunk) {
- value += buffer + chunk;
- buffer = '';
- value = value.replace(/\r/g, '');
- if (value.indexOf('\n') !== -1) {
- if (value !== '\n') {
- value = value.replace(/^\n+/, '');
- }
-
- buffer = value.substr(value.indexOf('\n'));
- val = value.substr(0, value.indexOf('\n'));
- prompt.pause();
- stdin.removeListener('data', data);
- stdin.removeListener('error', callback);
- value = value.trim();
- callback(null, value);
- }
- });
-
- return prompt;
-}; |
function readLineHidden (callback)- -@callback {function} Continuation to respond to when complete- -Gets a single line of hidden input (i.e. | prompt.readLineHidden = function (callback) {
- var value = '', buffer = '';
- stdio.setRawMode(true);
- prompt.resume();
- stdin.on('error', callback);
- stdin.on('data', function data (c) {
- c = '' + c;
- switch (c) {
- case '\n': case '\r': case '\r\n': case '\u0004':
- stdio.setRawMode(false);
- stdin.removeListener('data', data);
- stdin.removeListener('error', callback);
- value = value.trim();
- stdout.write('\n');
- stdout.flush();
- prompt.pause();
- return callback(null, value)
- case '\u0003': case '\0':
- stdout.write('\n');
- process.exit(1);
- break;
- default:
- value += buffer + c
- buffer = '';
- break;
- }
- });
-
- return prompt;
-};
-
- |
pkginfo.js | |
|---|---|
/*
- * pkginfo.js: Top-level include for the pkginfo module
- *
- * (C) 2011, Charlie Robbins
- *
- */
-
-var fs = require('fs'),
- path = require('path'); | |
function pkginfo ([options, 'property', 'property' ..])- -@pmodule {Module} Parent module to read from.- -@options {Object|Array|string} Optional Options used when exposing properties.- -@arguments {string...} Optional Specified properties to expose.- -Exposes properties from the package.json file for the parent module on -it's exports. Valid usage: - -
| var pkginfo = module.exports = function (pmodule, options) {
- var args = [].slice.call(arguments, 2).filter(function (arg) {
- return typeof arg === 'string';
- });
- |
| Parse variable arguments | if (Array.isArray(options)) { |
| If the options passed in is an Array assume that -it is the Array of properties to expose from the -on the package.json file on the parent module. | options = { include: options };
- }
- else if (typeof options === 'string') { |
| Otherwise if the first argument is a string, then -assume that it is the first property to expose from -the package.json file on the parent module. | options = { include: [options] };
- }
- |
| Setup default options | options = options || { include: [] };
-
- if (args.length > 0) { |
| If additional string arguments have been passed in -then add them to the properties to expose on the -parent module. | options.include = options.include.concat(args);
- }
-
- var pkg = pkginfo.read(pmodule, options.dir).package;
- Object.keys(pkg).forEach(function (key) {
- if (options.include.length > 0 && !~options.include.indexOf(key)) {
- return;
- }
-
- if (!pmodule.exports[key]) {
- pmodule.exports[key] = pkg[key];
- }
- });
-
- return pkginfo;
-}; |
function find (dir)- -@pmodule {Module} Parent module to read from.- -@dir {string} Optional Directory to start search from.- -Searches up the directory tree from | pkginfo.find = function (pmodule, dir) {
- dir = dir || pmodule.filename;
- dir = path.dirname(dir);
-
- var files = fs.readdirSync(dir);
-
- if (~files.indexOf('package.json')) {
- return path.join(dir, 'package.json');
- }
-
- if (dir === '/') {
- throw new Error('Could not find package.json up from: ' + dir);
- }
-
- return pkginfo.find(dir);
-}; |
function read (pmodule, dir)- -@pmodule {Module} Parent module to read from.- -@dir {string} Optional Directory to start search from.- -Searches up the directory tree from | pkginfo.read = function (pmodule, dir) {
- dir = pkginfo.find(pmodule, dir);
-
- var data = fs.readFileSync(dir).toString();
-
- return {
- dir: dir,
- package: JSON.parse(data)
- };
-}; |
| Call | pkginfo(module, {
- dir: __dirname,
- include: ['version'],
- target: pkginfo
-});
-
- |
object against a JSON Schema.
- // If object is self-describing (i.e. has a
- // $schema property), it will also be validated
- // against the referenced schema. [TODO]: This behaviour bay be
- // suppressed by setting the {@link #validate.options.???}
- // option to ???.[/TODO]
- //
- // If schema is not specified, and object
- // is not self-describing, validation always passes.
- //
- // Note: in order to pass options but no schema,
- // schema must be specified in the call to
- // validate(); otherwise, options will
- // be interpreted as the schema. schema may be passed
- // as null, undefinded, or the empty object
- // ({}) in this case.
- //
- function validate(object, schema, options) {
- options = mixin({}, options, validate.defaults);
- var errors = [];
-
- validateObject(object, schema, options, errors);
-
- //
- // TODO: self-described validation
- // if (! options.selfDescribing) { ... }
- //
-
- return {
- valid: !(errors.length),
- errors: errors
- };
- };
-
- /**
- * Default validation options. Defaults can be overridden by
- * passing an 'options' hash to {@link #validate}. They can
- * also be set globally be changing the values in
- * validate.defaults directly.
- */
- validate.defaults = {
- /**
- * - * Enforce 'format' constraints. - *
- * Default: true
- *
- * When {@link #validateFormats} is true,
- * treat unrecognized formats as validation errors.
- *
- * Default: false
- *
- * When {@link #validateFormats} is true,
- * also validate formats defined in {@link #validate.formatExtensions}.
- *
- * Default: true
- *