c9-core/node_modules/nak/lib/options.js

146 wiersze
6.1 KiB
JavaScript

// from https://gist.github.com/982499/e3c124da72796694a3bc08ed6e22d51b447d2575#file_options.js
/** Command-line options parser (http://valeriu.palos.ro/1026/).
Copyright 2011 Valeriu Paloş (valeriu@palos.ro). All rights reserved.
Released as Public Domain.
Expects the "schema" array with options definitions and produces the
"options" object and the "arguments" array, which will contain all
non-option arguments encountered (including the script name and such).
Syntax:
[«short», «long», «attributes», «brief», «callback»]
Attributes:
! - option is mandatory;
: - option expects a parameter;
+ - option may be specified multiple times (repeatable).
Notes:
- Parser is case-sensitive.
- The '-h|--help' option is provided implicitly.
- Parsed options are placed as fields in the "options" object.
- Non-option arguments are placed in the "arguments" array.
- Options and their parameters must be separated by space.
- Either one of «short» or «long» must always be provided.
- The «callback» function is optional.
- Cumulated short options are supported (i.e. '-tv').
- If an error occurs, the process is halted and the help is shown.
- Repeatable options will be cumulated into arrays.
- The parser does *not* test for duplicate option definitions.
// TODO
- this breaks on empty string not allowing to pass "" as a replacement
- replacement with "-" is recognized as an option
*/
var path = require("path");
var parser = {};
module.exports = parser;
var simplefunc = require('simplefunc'),
// Option definitions.
schema = [
['l', 'list', '', ' list files encountered'],
['H', 'hidden', '', ' search hidden files and directories (default off)'],
['c', 'color', '', ' adds color to results (default off)'],
['a', 'pathToNakignore', ':', ' path to an additional nakignore file'],
['q', 'literal', '', ' do not parse PATTERN as a regular expression; match it literally'],
['w', 'wordRegexp', '', ' only match whole words'],
['i', 'ignoreCase', '', ' match case insensitively'],
['G', 'pathInclude', ':', ' comma-separated list of wildcard files and paths to only search on'],
['d', 'ignore', ':', ' comma-separated list of wildcard files to additionally ignore'],
['f', 'follow', '', ' follow symlinks (default off)'],
['U', 'addVCSIgnores', '', ' include VCS ignore files (.gitignore); still uses .nakignore'],
['', 'ackmate', '', ' output results in a format parseable by AckMate'],
['', 'onFilepathSearchFn', ':', 'while searching, executes this function on a matching filepath']
],
parseArgs = parser.parseArgs = function(passedArgs) {
if (!passedArgs.length) {
help();
}
var type,
tokens = [],
options = {};
options.args = [];
for (var i = 0, item = process.argv[0], argsLength = process.argv.length; i < argsLength; i++, item = process.argv[i]) {
if (item.charAt(0) == '-') {
if (item.charAt(1) == '-') {
tokens.push('--', item.slice(2));
} else {
tokens = tokens.concat(item.split('').join('-').split('').slice(1));
}
} else {
tokens.push(item);
}
}
while ((type = tokens.shift())) {
if (type == '-' || type == '--') {
var name = tokens.shift();
if (name == 'help' || name == 'h') {
help();
}
var option = null;
for (i = 0, item = schema[0]; i < schema.length; i++, item = schema[i]) {
if (item[type.length - 1] == name) {
option = item;
break;
}
}
var value = true;
if ((option[2].indexOf(':') != -1) && !(value = tokens.shift())) {
console.error("Option '" + type + name + "' expects a parameter!");
help();
}
var index = option[1] || option[0];
if (option[2].indexOf('+') != -1) {
options[index] = options[index] instanceof Array ? options[index] : [];
options[index].push(value);
} else {
options[index] = value;
}
if (typeof(option[4]) == 'function') {
option[4](value);
}
option[2] = option[2].replace('!', '');
} else {
options.args.push(type);
continue;
}
}
// gets rid of the starting "node" and script name
if (passedArgs === undefined) options.args.splice(0, 2);
// turn string functions into real functions
if (process.env.nak_onFilepathSearchFn) {
options.onFilepathSearchFn = simplefunc.fromJson(process.env.nak_onFilepathSearchFn);
}
else if (options.onFilepathSearchFn) {
options.onFilepathSearchFn = new Function("filepath", options.onFilepathSearchFn);
}
return options;
};
function help() {
var fs = require('fs'),
json = JSON.parse(fs.readFileSync(path.resolve(__dirname, '..', 'package.json'), 'utf8')),
version = json.version;
console.log("Version " + version);
console.log("Usage: options ['PATTERN'] ['REPLACEMENT'] 'PATH' \n");
console.log("Options:");
for (var i = 0, item = schema[0]; i < schema.length; i++, item = schema[i]) {
var names = (item[0] ? '-' + item[0] + (item[1] ? '|' : ''): ' ') +
(item[1] ? '--' + item[1] : '');
var syntax = names + (item[2].indexOf(':') != -1 ? ' «value»' : '');
syntax += syntax.length < 20 ? new Array(20 - syntax.length).join(' ') : '';
console.log("\t" + (item[2].indexOf('!') != -1 ? '*' : ' ')
+ (item[2].indexOf('+') != -1 ? '+' : ' ')
+ syntax + "\t" + item[3]);
}
process.exit(0);
}