| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206 | 1
1
3
3
3
3
1
3
2
3
3
1
1
3
6
6
3
6
3
1
3
1
2
1
1
1
1
4
3
1
4
3
1
4
4
2
1
2
1
1
2
4
2
2
2
2
2
2
1
3
3
2
2
1
1
1
1
1
1
| var _ = require('underscore'),
async = require('async'),
child = require('child_process'),
commander = require('commander'),
fs = require('fs'),
p = require('path');
/**
* Parse command line arguments and execute actions based on the specified commands.
* Uses commander.js to provide -V / --version to display version number,
* and -h / --help to display help info.
*
* @param {String} base: base directory where the client module is located,
* used as a base directory to read command file and package.json file,
* ideally the value would be the client's __dirname
* @param {Object} actions: action function for each command in format: { command: { action: function () {} }},
* the command name in actions object is then mapped to the command name specified in commandFile
* @param {Object} opts: optional
* - commandFile: relative path to command file from base directory, defaults to 'conf/commands.json'
*/
function command(base, actions, opts) {
actions = actions || {};
opts = opts || {};
var commands = JSON.parse(fs.readFileSync(p.join(base, opts.commandFile || '../conf/commands.json'))),
pkg = JSON.parse(fs.readFileSync(p.join(base, '../package.json')));
if (actions.commands && commands.commands) {
_.each(actions.commands, function (command, name) {
if (commands.commands[name]) {
commands.commands[name].action = command.action;
}
});
}
commander.version(pkg.version);
if (commands.options) {
_.each(commands.options, function (option) {
commander.option(option.arg, option.desc, option.action);
});
}
_.each(commands.commands, function (command, name) {
var program = commander
.command(name)
.description(command.desc);
_.each(command.options, function (option) {
program.option(option.arg, option.desc, option.action);
});
program.action(command.action);
});
commander.parse(process.argv);
}
/**
* Execute a one-liner command.
* Both stderr and stdout will be logged via console.error/log accordingly.
* Fallthrough is handy in situation where there are multiple execs running in sequence/parallel,
* and they all have to be executed regardless of success/error on either one of them.
*
* @param {String} command: command to execute
* @param {Boolean} fallthrough: allow error to be camouflaged as a non-error
* @param {Function} cb: standard cb(err, result) callback
*/
function exec(command, fallthrough, cb) {
child.exec(command, function (err, stdout, stderr) {
if (err) {
console.error('Error: ' + stderr);
if (fallthrough) {
// camouflage error to allow other execs to keep running
cb(null, err);
} else {
cb(err);
}
} else {
console.log(stdout);
cb();
}
});
}
/**
* Handle process exit based on the existence of error.
* This is handy for command-line tools to use as the final callback.
* Exit status code 1 indicates an error, exit status code 0 indicates a success.
* Error message will be logged to the console. Result object is only used for convenient debugging.
*
* @param {Error} err: error object existence indicates the occurence of an error
* @param {Object} result: result object
*/
function exit(err, result) {
if (err) {
console.error(err.message);
process.exit(1);
} else {
process.exit(0);
}
}
/**
* A higher order function that returns a process exit callback,
* with error and success callbacks to handle error and result accordingly.
* Exit status code 1 indicates an error, exit status code 0 indicates a success.
*
* @param {Function} errorCb: error callback accepts error argument, defaults to logging to console error
* @param {Function} successCb: success callback accepts result argument, defaults to logging to console log
*/
function exitCb(errorCb, successCb) {
if (!errorCb) {
errorCb = function (err) {
console.error(err.message);
};
}
if (!successCb) {
successCb = function (result) {
console.log(result);
};
}
return function (err, result) {
if (err) {
errorCb(err);
process.exit(1);
} else {
successCb(result);
process.exit(0);
}
};
}
/**
* Synchronously read file based on these rules:
* - if path is absolute, then check file at absolute path first
* - if path is relative, then check file at current working directory
* - if none of the above exists, check file at user home directory
* - if none exists, throw an error
* This allows simple file lookup which allows various locations.
*
* @param {String} file: the file name to read
* @return {String} content of the file
*/
function lookupFile(file) {
var data,
baseDir = file.match(/^\//) ? p.dirname(file) : process.cwd(),
homeDir = process.env[(process.platform === 'win32') ? 'USERPROFILE' : 'HOME'],
files = _.map([ baseDir, homeDir ], function (dir) {
return p.join(dir, file.match(/^\//) ? p.basename(file) : file);
});
for (var i = 0, ln = files.length; i < ln; i += 1) {
try {
data = fs.readFileSync(files[i]);
break;
} catch (err) {
}
}
Eif (data) {
return data;
} else {
throw new Error('Unable to lookup file in ' + files.join(', '));
}
}
/**
* Execute a command with an array of arguments.
* E.g. command: make, arguments: -f somemakefile target1 target2 target3
* will be executed as: make -f somemakefile target1 target2 target3
* NOTE: process.stdout.write and process.stderr.write are used because console.log adds a newline
*
* @param {String} command: command to execute
* @param {Array} args: command arguments
* @param {Function} cb: standard cb(err, result) callback
*/
function spawn(command, args, cb) {
var _spawn = child.spawn(command, args);
_spawn.stdout.on('data', function (data) {
process.stdout.write(data);
});
_spawn.stderr.on('data', function (data) {
process.stderr.write(data);
});
_spawn.on('exit', function (code) {
cb((code !== 0) ? new Error(code) : undefined, code);
});
}
exports.command = command;
exports.exec = exec;
exports.exit = exit;
exports.exitCb = exitCb;
exports.lookupFile = lookupFile;
exports.spawn = spawn;
|