Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #510. Remove jake dev dependency and embed arg parser. #645

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions bin/cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,8 @@
*
*/


let program = require('jake').program;
delete global.jake; // NO NOT WANT
program.setTaskNames = function (n) { this.taskNames = n; };

let ejs = require('../lib/ejs');
let { hyphenToCamel } = require('../lib/utils');
let { hyphenToCamel, parseArgs } = require('../lib/utils');
let fs = require('fs');
let args = process.argv.slice(2);
let usage = fs.readFileSync(`${__dirname}/../usage.txt`).toString();
Expand Down Expand Up @@ -99,13 +94,22 @@ const CLI_OPTS = [
},
];

function die(msg) {
console.log(msg);
process.stdout.write('', function () {
process.stderr.write('', function () {
process.exit();
});
});
}

let preempts = {
version: function () {
program.die(ejs.VERSION);
die(ejs.VERSION);
},
help: function () {
program.die(usage);
}
die(usage);
},
};

let stdin = '';
Expand All @@ -118,10 +122,7 @@ process.stdin.on('readable', () => {
});

function run() {

program.availableOpts = CLI_OPTS;
program.parseArgs(args);

let program = parseArgs(CLI_OPTS, args);
let templatePath = program.taskNames[0];
let pVals = program.envVars;
let pOpts = {};
Expand Down
101 changes: 101 additions & 0 deletions lib/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -208,4 +208,105 @@ exports.createNullProtoObjWherePossible = (function () {
};
})();

// Embedded argument parser from https://github.com/jakejs/jake/blob/master/lib/parseargs.js
// See original source for doc.
// Fixes #510 and allows removing `jake` as a prod dependency.
exports.parseArgs = function parseArgs(programOpts, programArgs) {
let isOpt = function (arg) {
return arg.indexOf('-') === 0;
};
let removeOptPrefix = function (opt) {
return opt.replace(/^--/, '').replace(/^-/, '');

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may not matter, but you could just use one replace call by using the regex of /^--?/ as that means that the second hyphen is optional.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It also sorta sounds like this was just copy/pasted from jake, so I also understand this wasn't technically the op's code.

};

const Parser = function (opts) {
this.opts = {};
this.taskNames = null;
this.envVars = null;
this.reg = opts;
this.shortOpts = {};
this.longOpts = {};

let self = this;
[].forEach.call(opts, function (item) {
self.shortOpts[item.abbr] = item;
self.longOpts[item.full] = item;
});
};

Parser.prototype = new (function () {
let _trueOrNextVal = function (argParts, args) {
if (argParts[1]) {
return argParts[1];
} else {
return !args[0] || isOpt(args[0]) ? true : args.shift();
}
};

this.parse = function (args) {
let cmds = [];
let cmd;
let envVars = {};
let opts = {};
let arg;
let argItem;
let argParts;
let cmdItems;
let taskNames = [];
let preempt;

while (args.length) {
arg = args.shift();

if (isOpt(arg)) {
arg = removeOptPrefix(arg);
argParts = arg.split('=');
argItem = this.longOpts[argParts[0]] || this.shortOpts[argParts[0]];
if (argItem) {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this condition does not meet, I. E. this is an unrecognized option, do we want to throw an error?

See #690

// First-encountered preemptive opt takes precedence -- no further opts
// or possibility of ambiguity, so just look for a value, or set to
// true and then bail
if (argItem.preempts) {
opts[argItem.full] = _trueOrNextVal(argParts, args);
preempt = true;
break;
}
// If the opt requires a value, see if we can get a value from the
// next arg, or infer true from no-arg -- if it's followed by another
// opt, throw an error
if (argItem.expectValue || argItem.allowValue) {
opts[argItem.full] = _trueOrNextVal(argParts, args);
if (argItem.expectValue && !opts[argItem.full]) {
throw new Error(argItem.full + ' option expects a value.');
}
} else {
opts[argItem.full] = true;
}
}
} else {
cmds.unshift(arg);
}
}

if (!preempt) {
// Parse out any env-vars and task-name
while ((cmd = cmds.pop())) {
cmdItems = cmd.split('=');
if (cmdItems.length > 1) {
envVars[cmdItems[0]] = cmdItems[1];
} else {
taskNames.push(cmd);
}
}
}

return {
opts: opts,
envVars: envVars,
taskNames: taskNames,
};
};
})();

return new Parser(programOpts).parse(programArgs);
};
26 changes: 20 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,12 @@
},
"bugs": "https://github.com/mde/ejs/issues",
"homepage": "https://github.com/mde/ejs",
"dependencies": {
"jake": "^10.6.1"
},
"dependencies": {},
"devDependencies": {
"browserify": "^16.5.1",
"eslint": "^6.8.0",
"git-directory-deploy": "^1.5.1",
"jake": "^10.6.1",
"jsdoc": "^3.6.7",
"lru-cache": "^4.0.1",
"mocha": "^7.1.1",
Expand Down