mirror of
https://github.com/JuanCanham/HackMyResume.git
synced 2025-04-19 14:20:25 +01:00
331 lines
10 KiB
JavaScript
331 lines
10 KiB
JavaScript
/**
|
|
Definition of the `main` function.
|
|
@module cli/main
|
|
@license MIT. See LICENSE.md for details.
|
|
*/
|
|
|
|
|
|
|
|
(function(){
|
|
|
|
|
|
|
|
var HMR = require( '../hackmyapi')
|
|
, PKG = require('../../package.json')
|
|
, FS = require('fs')
|
|
, EXTEND = require('extend')
|
|
, chalk = require('chalk')
|
|
, PATH = require('path')
|
|
, HMSTATUS = require('../core/status-codes')
|
|
, HME = require('../core/event-codes')
|
|
, safeLoadJSON = require('../utils/safe-json-loader')
|
|
, StringUtils = require('../utils/string.js')
|
|
, _ = require('underscore')
|
|
, OUTPUT = require('./out')
|
|
, PAD = require('string-padding')
|
|
, Command = require('commander').Command;
|
|
|
|
var _opts = { };
|
|
var _title = chalk.white.bold('\n*** HackMyResume v' +PKG.version+ ' ***');
|
|
var _out = new OUTPUT( _opts );
|
|
|
|
|
|
|
|
/**
|
|
A callable implementation of the HackMyResume CLI. Encapsulates the command
|
|
line interface as a single method accepting a parameter array.
|
|
@alias module:cli/main.main
|
|
@param rawArgs {Array} An array of command-line parameters. Will either be
|
|
process.argv (in production) or custom parameters (in test).
|
|
*/
|
|
var main = module.exports = function( rawArgs ) {
|
|
|
|
var initInfo = initialize( rawArgs );
|
|
var args = initInfo.args;
|
|
|
|
// Create the top-level (application) command...
|
|
var program = new Command('hackmyresume')
|
|
.version(PKG.version)
|
|
.description(chalk.yellow.bold('*** HackMyResume ***'))
|
|
.option('-s --silent', 'Run in silent mode')
|
|
.option('--no-color', 'Disable colors')
|
|
.option('--color', 'Enable colors')
|
|
.option('-d --debug', 'Enable diagnostics', false)
|
|
.option('-a --assert', 'Treat warnings as errors', false)
|
|
.option('-v --version', 'Show the version')
|
|
.allowUnknownOption();
|
|
program.jsonArgs = initInfo.options;
|
|
|
|
// Create the NEW command
|
|
program
|
|
.command('new')
|
|
.arguments('<sources...>')
|
|
.option('-f --format <fmt>', 'FRESH or JRS format', 'FRESH')
|
|
.alias('create')
|
|
.description('Create resume(s) in FRESH or JSON RESUME format.')
|
|
.action(function( sources ) {
|
|
execute.call( this, sources, [], this.opts(), logMsg);
|
|
});
|
|
|
|
// Create the VALIDATE command
|
|
program
|
|
.command('validate')
|
|
.arguments('<sources...>')
|
|
.description('Validate a resume in FRESH or JSON RESUME format.')
|
|
.action(function(sources) {
|
|
execute.call( this, sources, [], this.opts(), logMsg);
|
|
});
|
|
|
|
// Create the CONVERT command
|
|
program
|
|
.command('convert')
|
|
.description('Convert a resume to/from FRESH or JSON RESUME format.')
|
|
.action(function() {
|
|
var x = splitSrcDest.call( this );
|
|
execute.call( this, x.src, x.dst, this.opts(), logMsg);
|
|
});
|
|
|
|
// Create the ANALYZE command
|
|
program
|
|
.command('analyze')
|
|
.arguments('<sources...>')
|
|
.description('Analyze one or more resumes.')
|
|
.action(function( sources ) {
|
|
execute.call( this, sources, [], this.opts(), logMsg);
|
|
});
|
|
|
|
// Create the PEEK command
|
|
program
|
|
.command('peek')
|
|
.arguments('<sources...>')
|
|
.description('Peek at a resume field or section')
|
|
.action(function( sources, sectionOrField ) {
|
|
var dst = (sources && sources.length > 1) ? [sources.pop()] : [];
|
|
execute.call( this, sources, dst, this.opts(), logMsg);
|
|
});
|
|
|
|
// Create the BUILD command
|
|
program
|
|
.command('build')
|
|
.alias('generate')
|
|
.option('-t --theme <theme>', 'Theme name or path')
|
|
.option('-n --no-prettify', 'Disable HTML prettification', true)
|
|
.option('-c --css <option>', 'CSS linking / embedding')
|
|
.option('-p --pdf <engine>', 'PDF generation engine')
|
|
.option('--no-sort', 'Sort resume sections by date', false)
|
|
.option('--no-tips', 'Disable theme tips and warnings.', false)
|
|
.description('Generate resume to multiple formats')
|
|
.action(function( sources, targets, options ) {
|
|
var x = splitSrcDest.call( this );
|
|
execute.call( this, x.src, x.dst, this.opts(), logMsg);
|
|
});
|
|
|
|
program.parse( args );
|
|
|
|
if (!program.args.length) { throw { fluenterror: 4 }; }
|
|
|
|
};
|
|
|
|
|
|
|
|
/** Massage command-line args and setup Commander.js. */
|
|
function initialize( ar ) {
|
|
|
|
var o = initOptions( ar );
|
|
|
|
o.silent || logMsg( _title );
|
|
|
|
// Emit debug prelude if --debug was specified
|
|
if( o.debug ) {
|
|
_out.log(chalk.cyan('The -d or --debug switch was specified. DEBUG mode engaged.'));
|
|
_out.log('');
|
|
_out.log(chalk.cyan(PAD(' Platform:',25, null, PAD.RIGHT)) + chalk.cyan.bold( process.platform === 'win32' ? 'windows' : process.platform ));
|
|
_out.log(chalk.cyan(PAD(' Node.js:',25, null, PAD.RIGHT)) + chalk.cyan.bold( process.version ));
|
|
_out.log(chalk.cyan(PAD(' HackMyResume:',25, null, PAD.RIGHT)) + chalk.cyan.bold('v' + PKG.version ));
|
|
_out.log(chalk.cyan(PAD(' FRESCA:',25, null, PAD.RIGHT)) + chalk.cyan.bold( PKG.dependencies.fresca ));
|
|
_out.log(chalk.cyan(PAD(' fresh-themes:',25, null, PAD.RIGHT)) + chalk.cyan.bold( PKG.dependencies['fresh-themes'] ));
|
|
_out.log(chalk.cyan(PAD(' fresh-jrs-converter:',25, null, PAD.RIGHT)) + chalk.cyan.bold( PKG.dependencies['fresh-jrs-converter'] ));
|
|
_out.log('');
|
|
}
|
|
|
|
// Handle invalid verbs here (a bit easier here than in commander.js)...
|
|
if( o.verb && !HMR.verbs[ o.verb ] && !HMR.alias[ o.verb ] ) {
|
|
throw { fluenterror: HMSTATUS.invalidCommand, quit: true,
|
|
attempted: o.orgVerb };
|
|
}
|
|
|
|
// Override the .missingArgument behavior
|
|
Command.prototype.missingArgument = function(name) {
|
|
if( this.name() !== 'new' ) {
|
|
throw { fluenterror: HMSTATUS.resumeNotFound, quit: true };
|
|
}
|
|
};
|
|
|
|
// Override the .helpInformation behavior
|
|
Command.prototype.helpInformation = function() {
|
|
var manPage = FS.readFileSync(
|
|
PATH.join(__dirname, 'use.txt'), 'utf8' );
|
|
return chalk.green.bold(manPage);
|
|
};
|
|
|
|
return {
|
|
args: o.args,
|
|
options: o.json
|
|
};
|
|
}
|
|
|
|
|
|
|
|
/** Init options prior to setting up command infrastructure. */
|
|
function initOptions( ar ) {
|
|
var oVerb, verb = '', args = ar.slice(), cleanArgs = args.slice(2), oJSON;
|
|
if( cleanArgs.length ) {
|
|
|
|
// Support case-insensitive sub-commands (build, generate, validate, etc)
|
|
var vidx = _.findIndex( cleanArgs, function(v){ return v[0] !== '-'; });
|
|
if( vidx !== -1 ) {
|
|
oVerb = cleanArgs[ vidx ];
|
|
verb = args[ vidx + 2 ] = oVerb.trim().toLowerCase();
|
|
}
|
|
|
|
// Remove --options --opts -o and process separately
|
|
var optsIdx = _.findIndex( cleanArgs, function(v){
|
|
return v === '-o' || v === '--options' || v === '--opts';
|
|
});
|
|
if(optsIdx !== -1) {
|
|
var optStr = cleanArgs[ optsIdx + 1];
|
|
args.splice( optsIdx + 2, 2 );
|
|
if( optStr && (optStr = optStr.trim()) ) {
|
|
//var myJSON = JSON.parse(optStr);
|
|
if( optStr[0] === '{')
|
|
oJSON = eval('(' + optStr + ')'); // jshint ignore:line
|
|
else {
|
|
var inf = safeLoadJSON( optStr );
|
|
if( !inf.ex )
|
|
oJSON = inf.json;
|
|
// TODO: Error handling
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Grab the --debug flag
|
|
var isDebug = _.some( args, function(v) {
|
|
return v === '-d' || v === '--debug';
|
|
});
|
|
|
|
// Grab the --silent flag
|
|
var isSilent = _.some( args, function(v) {
|
|
return v === '-s' || v === '--silent';
|
|
});
|
|
|
|
return {
|
|
debug: isDebug,
|
|
silent: isSilent,
|
|
orgVerb: oVerb,
|
|
verb: verb,
|
|
json: oJSON,
|
|
args: args
|
|
};
|
|
}
|
|
|
|
|
|
|
|
/** Invoke a HackMyResume verb. */
|
|
function execute( src, dst, opts, log ) {
|
|
|
|
loadOptions.call( this, opts, this.parent.jsonArgs );
|
|
var hand = require( './error' );
|
|
hand.init( _opts.debug, _opts.assert, _opts.silent );
|
|
var v = new HMR.verbs[ this.name() ]();
|
|
_out.init( _opts );
|
|
v.on( 'hmr:status', function() { _out.do.apply( _out, arguments ); });
|
|
v.on( 'hmr:error', function() {
|
|
hand.err.apply( hand, arguments );
|
|
});
|
|
v.invoke.call( v, src, dst, _opts, log );
|
|
if( v.errorCode )
|
|
process.exit(v.errorCode);
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
Initialize HackMyResume options.
|
|
TODO: Options loading is a little hacky, for two reasons:
|
|
- Commander.js idiosyncracies
|
|
- Need to accept JSON inputs from the command line.
|
|
*/
|
|
function loadOptions( o, cmdO ) {
|
|
|
|
// o and this.opts() seem to be the same (command-specific options)
|
|
|
|
// Load the specified options file (if any) and apply options
|
|
if( cmdO )
|
|
o = EXTEND(true, o, cmdO);
|
|
|
|
// Merge in command-line options
|
|
o = EXTEND( true, o, this.opts() );
|
|
|
|
// Kludge parent-level options until piping issue is resolved
|
|
if( this.parent.silent !== undefined && this.parent.silent !== null)
|
|
o.silent = this.parent.silent;
|
|
if( this.parent.debug !== undefined && this.parent.debug !== null)
|
|
o.debug = this.parent.debug;
|
|
if( this.parent.assert !== undefined && this.parent.assert !== null)
|
|
o.assert = this.parent.assert;
|
|
|
|
if( o.debug ) {
|
|
logMsg(chalk.cyan('OPTIONS:') + '\n');
|
|
_.each(o, function(val, key) {
|
|
logMsg(chalk.cyan(' %s') + chalk.cyan.bold(' %s'),
|
|
PAD(key,22,null,PAD.RIGHT), val);
|
|
});
|
|
logMsg('');
|
|
}
|
|
|
|
// Cache
|
|
EXTEND(true, _opts, o);
|
|
}
|
|
|
|
|
|
|
|
/** Split multiple command-line filenames by the 'TO' keyword */
|
|
function splitSrcDest() {
|
|
|
|
var params = this.parent.args.filter(function(j) { return String.is(j); });
|
|
if( params.length === 0 )
|
|
throw { fluenterror: HMSTATUS.resumeNotFound, quit: true };
|
|
|
|
// Find the TO keyword, if any
|
|
var splitAt = _.findIndex( params, function(p) {
|
|
return p.toLowerCase() === 'to';
|
|
});
|
|
|
|
// TO can't be the last keyword
|
|
if( splitAt === params.length - 1 && splitAt !== -1 ) {
|
|
logMsg(chalk.yellow('Please ') +
|
|
chalk.yellow.bold('specify an output file') +
|
|
chalk.yellow(' for this operation or ') +
|
|
chalk.yellow.bold('omit the TO keyword') +
|
|
chalk.yellow('.') );
|
|
return;
|
|
}
|
|
|
|
return {
|
|
src: params.slice(0, splitAt === -1 ? undefined : splitAt ),
|
|
dst: splitAt === -1 ? [] : params.slice( splitAt + 1 )
|
|
};
|
|
}
|
|
|
|
|
|
|
|
/** Simple logging placeholder. */
|
|
function logMsg() {
|
|
_opts.silent || console.log.apply( console.log, arguments );
|
|
}
|
|
|
|
|
|
|
|
}());
|