1
0
mirror of https://github.com/JuanCanham/HackMyResume.git synced 2025-05-15 01:57:08 +01:00

Compare commits

..

19 Commits

Author SHA1 Message Date
9dd759ffa2 Bump version to 0.3.1. 2015-10-10 23:27:20 -04:00
befa26cbb2 Merge remote-tracking branch 'refs/remotes/origin/dev' 2015-10-10 23:21:45 -04:00
31e2e12769 Bump fluentlib version. 2015-10-10 23:21:28 -04:00
f728004c4c Update README. 2015-10-10 22:36:13 -04:00
61386308a0 Merge remote-tracking branch 'refs/remotes/origin/dev' 2015-10-10 22:03:07 -04:00
2e5a68d942 Support explicit -o output parameter.
Allow output files to be explicitly specified via -o, for ex:

fluentcmd resume.json -o out/resume.html -o out/resume.pdf
2015-10-10 21:39:32 -04:00
cf15738f58 Fix explicit output file bug.
Fixes a bug that occurs when an explicit output file with an extension
other than .all is specified on the command line.
2015-10-10 21:38:06 -04:00
d4a3a08aff Add JSON format support. 2015-10-10 20:11:26 -04:00
b1d987c3b4 Bump version. 2015-10-10 20:09:09 -04:00
a2b482f60b Update README. 2015-10-10 18:34:36 -04:00
189f37b6a1 Add Markdown format support. 2015-10-10 17:49:29 -04:00
6e4263e58c Change default theme to "modern". 2015-10-10 15:39:13 -04:00
293f7e118a Merge branch 'dev' 2015-10-09 06:02:20 -04:00
961152850d Merge branch 'master' into dev 2015-10-09 06:00:27 -04:00
0724ffe7f2 Bump fluentlib version. 2015-10-09 05:56:36 -04:00
782068463c Merge branch 'dev' 2015-10-09 05:11:22 -04:00
f4dd72683b Enforce Unix line endings on JS files.
Sidestep finnicky line-ending behaviors on OS X and NPM registry.
2015-10-09 05:05:17 -04:00
9de7601a2a Peg fluentlib version and bump. 2015-10-07 09:51:08 -04:00
7ab2df6696 Improve error handling. 2015-10-07 09:29:41 -04:00
5 changed files with 82 additions and 58 deletions

5
.gitattributes vendored
View File

@ -1,8 +1,7 @@
# Auto detect text files and perform LF normalization # Auto detect text files and perform LF normalization
* text=auto * text=auto
*.js text eol=lf
# Custom for Visual Studio *.json text eol=lf
*.cs diff=csharp
# Standard to msysgit # Standard to msysgit
*.doc diff=astextplain *.doc diff=astextplain

View File

@ -26,53 +26,73 @@ FluentCMD requires a recent version of [Node.js][4] and [NPM][5]. Then:
1. (Optional, for PDF support) Install the latest official [wkhtmltopdf][3] binary for your platform. 1. (Optional, for PDF support) Install the latest official [wkhtmltopdf][3] binary for your platform.
2. Install **fluentcmd** by running `npm install fluentcmd -g`. 2. Install **fluentcmd** by running `npm install fluentcmd -g`.
3. You're ready to go! 3. You're ready to go.
## Use ## Use
Assuming you've got a JSON-formatted resume handy, generating resumes in different formats and combinations easy. Just run: Assuming you've got a JSON-formatted resume handy, generating resumes in different formats and combinations easy. Just run:
`fluentcmd [inputs] [outputs] [-t theme]`. ```bash
fluentcmd [inputs] [outputs] [-t theme].
```
Where `[inputs]` is one or more .json resume files, `[outputs]` is one or more destination resumes, and `[theme]` is the desired theme. For example: Where `[inputs]` is one or more .json resume files, separated by spaces; `[outputs]` is one or more destination resumes, each prefaced with the `-o` option; and `[theme]` is the desired theme. For example:
```bash ```bash
# Generate all resume formats (HTML, PDF, DOC, TXT) # Generate all resume formats (HTML, PDF, DOC, TXT)
fluentcmd resume.json resume.all -t informatic fluentcmd resume.json -o out/resume.all -t modern
# Generate a specific resume format # Generate a specific resume format
fluentcmd resume.json resume.html -t informatic fluentcmd resume.json -o out/resume.html
fluentcmd resume.json resume.txt -t informatic fluentcmd resume.json -o out/resume.pdf
fluentcmd resume.json resume.pdf -t informatic fluentcmd resume.json -o out/resume.md
fluentcmd resume.json resume.doc -t informatic fluentcmd resume.json -o out/resume.doc
fluentcmd resume.json -o out/resume.json
fluentcmd resume.json -o out/resume.txt
# Specify 2 inputs and 3 outputs
fluentcmd in1.json in2.json -o out.html -o out.doc -o out.pdf
``` ```
You should see something to the effect of: You should see something to the effect of:
``` ```
*** FluentCMD v0.1.0 *** *** FluentCMD v0.3.1 ***
Reading JSON resume: foo/resume.json Reading JSON resume: foo/resume.json
Generating HTML resume: out/resume.html Generating HTML resume: out/resume.html
Generating TXT resume: out/resume.txt Generating TXT resume: out/resume.txt
Generating DOC resume: out/resume.doc Generating DOC resume: out/resume.doc
Generating PDF resume: out/resume.pdf Generating PDF resume: out/resume.pdf
Generating JSON resume: out/resume.json
Generating MARKDOWN resume: out/resume.md
``` ```
## Advanced ## Advanced
### Applying a theme
You can specify a predefined or custom theme via the optional `-t` parameter. For a predefined theme, include the theme name. For a custom theme, include the path to the custom theme's folder.
```bash
fluentcmd resume.json -t modern
fluentcmd resume.json -t ~/foo/bar/my-custom-theme/
```
As of v0.3.1, available predefined themes are `modern`, `minimist`, `informatic`, and `hello-world`.
### Merging resumes ### Merging resumes
You can **merge multiple resumes together** by specifying them in order from most generic to most specific: You can **merge multiple resumes together** by specifying them in order from most generic to most specific:
```bash ```bash
# Merge specific.json onto base.json and generate all formats # Merge specific.json onto base.json and generate all formats
fluentcmd base.json specific.json resume.all fluentcmd base.json specific.json -o resume.all
``` ```
This can be useful for overriding a base (generic) resume with information from a specific (targeted) resume. For example, you might override your generic catch-all "software developer" resume with specific details from your targeted "game developer" resume, or combine two partial resumes into a "complete" resume. Merging follows conventional [extend()][9]-style behavior and there's no arbitrary limit to how many resumes you can merge: This can be useful for overriding a base (generic) resume with information from a specific (targeted) resume. For example, you might override your generic catch-all "software developer" resume with specific details from your targeted "game developer" resume, or combine two partial resumes into a "complete" resume. Merging follows conventional [extend()][9]-style behavior and there's no arbitrary limit to how many resumes you can merge:
```bash ```bash
fluentcmd in1.json in2.json in3.json in4.json out.html out.doc fluentcmd in1.json in2.json in3.json in4.json -o out.html -o out.doc
Reading JSON resume: in1.json Reading JSON resume: in1.json
Reading JSON resume: in2.json Reading JSON resume: in2.json
Reading JSON resume: in3.json Reading JSON resume: in3.json
@ -88,13 +108,13 @@ You can specify **multiple output targets** and FluentCMD will build them:
```bash ```bash
# Generate out1.doc, out1.pdf, and foo.txt from me.json. # Generate out1.doc, out1.pdf, and foo.txt from me.json.
fluentcmd me.json out1.doc out1.pdf foo.txt fluentcmd me.json -o out1.doc -o out1.pdf -o foo.txt
``` ```
You can also omit the output file(s) and/or theme completely: You can also omit the output file(s) and/or theme completely:
```bash ```bash
# Equivalent to "fluentcmd resume.json resume.all -t informatic" # Equivalent to "fluentcmd resume.json resume.all -t modern"
fluentcmd resume.json fluentcmd resume.json
``` ```
@ -104,15 +124,10 @@ The special `.all` extension tells FluentCMD to generate all supported output fo
```bash ```bash
# Generate all resume formats (HTML, PDF, DOC, TXT, etc.) # Generate all resume formats (HTML, PDF, DOC, TXT, etc.)
fluentcmd input.json output.all fluentcmd me.json -o out/resume.all
``` ```
..tells FluentCV to read `input.json` and generate `output.doc`, `output.html`, `output.txt`, `output.pdf`. That's more or less equivalent to: ..tells FluentCV to read `me.json` and generate `out/resume.md`, `out/resume.doc`, `out/resume.html`, `out/resume.txt`, `out/resume.pdf`, and `out/resume.json`.
```bash
# Generate all resume formats (HTML, PDF, DOC, TXT)
fluentcmd input.json output.doc output.html output.txt output.pdf
```
## License ## License

View File

@ -1,6 +1,6 @@
{ {
"name": "fluentcmd", "name": "fluentcmd",
"version": "0.1.0", "version": "0.3.1",
"description": "Generate beautiful, targeted resumes from your command line or shell.", "description": "Generate beautiful, targeted resumes from your command line or shell.",
"repository": { "repository": {
"type": "git", "type": "git",
@ -24,7 +24,7 @@
}, },
"homepage": "https://github.com/fluentdesk/fluentcmd", "homepage": "https://github.com/fluentdesk/fluentcmd",
"dependencies": { "dependencies": {
"fluentlib": "fluentdesk/fluentlib", "fluentlib": "fluentdesk/fluentlib#v0.2.0",
"minimist": "^1.2.0", "minimist": "^1.2.0",
"underscore": "^1.8.3" "underscore": "^1.8.3"
} }

View File

@ -9,31 +9,34 @@ module.exports = function () {
var path = require( 'path' ) var path = require( 'path' )
, extend = require( './utils/extend' ) , extend = require( './utils/extend' )
, unused = require('./utils/string') , unused = require('./utils/string')
, FLUENT = require('fluentlib') , fs = require('fs')
, _ = require('underscore') , _ = require('underscore')
, rez, _log; , FLUENT = require('fluentlib')
, rez, _log, _err;
/** /**
Given a source JSON resume, a destination resume path, and a theme file, Given a source JSON resume, a destination resume path, and a theme file,
generate 0..N resumes in the desired formats. generate 0..N resumes in the desired formats.
@param src Path to the source JSON resume file: "rez/resume.json". @param src Path to the source JSON resume file: "rez/resume.json".
@param dst An array of paths to the target resume file(s). @param dst An array of paths to the target resume file(s).
@param theme Friendly name of the resume theme. Defaults to "informatic". @param theme Friendly name of the resume theme. Defaults to "modern".
@param logger Optional logging override. @param logger Optional logging override.
*/ */
function gen( src, dst, theme, logger ) { function gen( src, dst, theme, logger, errHandler ) {
_log = logger || console.log; _log = logger || console.log;
_opts.theme = theme; _err = errHandler || error;
var msg = ''; _opts.theme = (theme && theme.toLowerCase().trim()) || 'modern';
// Load input resumes... // Load input resumes...
if(!src || !src.length) { throw { fluenterror: 3 }; }
var sheets = src.map( function( res ) { var sheets = src.map( function( res ) {
_log( 'Reading JSON resume: ' + res ); _log( 'Reading JSON resume: ' + res );
return (new FLUENT.Sheet()).open( res ); return (new FLUENT.Sheet()).open( res );
}); });
// Merge input resumes... // Merge input resumes...
var msg = '';
rez = _.reduceRight( sheets, function( a, b, idx ) { rez = _.reduceRight( sheets, function( a, b, idx ) {
msg += ((idx == sheets.length - 2) ? 'Merging ' + a.meta.fileName : '') msg += ((idx == sheets.length - 2) ? 'Merging ' + a.meta.fileName : '')
+ ' onto ' + b.meta.fileName; + ' onto ' + b.meta.fileName;
@ -46,7 +49,8 @@ module.exports = function () {
( (dst && dst.length && dst) || ['resume.all'] ).forEach( function(t) { ( (dst && dst.length && dst) || ['resume.all'] ).forEach( function(t) {
var to = path.resolve(t), pa = path.parse(to), fmat = pa.ext || '.all'; var to = path.resolve(t), pa = path.parse(to), fmat = pa.ext || '.all';
targets.push.apply(targets, fmat === '.all' ? targets.push.apply(targets, fmat === '.all' ?
_fmts.map(function(z){ return to.replace(/all$/g,z.name); }) : [to]); _fmts.map(function(z){ return { file: to.replace(/all$/g,z.ext), fmt: z } })
: [{ file: to, fmt: _.findWhere( _fmts, { ext: fmat.substring(1) }) }]);
}); });
// Run the transformation! // Run the transformation!
@ -61,34 +65,24 @@ module.exports = function () {
@param f Full path to the destination resume to generate, for example, @param f Full path to the destination resume to generate, for example,
"/foo/bar/resume.pdf" or "c:\foo\bar\resume.txt". "/foo/bar/resume.pdf" or "c:\foo\bar\resume.txt".
*/ */
function single( f ) { function single( fi ) {
try { try {
// Get the output file type (pdf, html, txt, etc) var f = fi.file, fType = fi.fmt.ext, fName = path.basename( f, '.' + fType );
var fType = path.extname( f ).trim().toLowerCase().substr(1); var fObj = _fmts.filter( function(_f) { return _f.ext === fType; } )[0];
var fName = path.basename( f, '.' + fType );
// Get the format object (if any) corresponding to that type, and assemble
// the final output file path for the generated resume.
var fObj = _fmts.filter( function(_f) { return _f.name === fType; } )[0];
var fOut = path.join( f.substring( 0, f.lastIndexOf('.') + 1 ) + fObj.ext ); var fOut = path.join( f.substring( 0, f.lastIndexOf('.') + 1 ) + fObj.ext );
_log( 'Generating ' + fi.fmt.name.toUpperCase() + ' resume: ' + path.relative(process.cwd(), f ) );
// Generate!
_log( 'Generating ' + fType.toUpperCase() + ' resume: ' + path.relative(process.cwd(), f) );
return fObj.gen.generate( rez, fOut, _opts.theme ); return fObj.gen.generate( rez, fOut, _opts.theme );
} }
catch( ex ) { catch( ex ) {
err( ex ); _err( ex );
} }
} }
/** /**
Handle an exception. Handle an exception.
*/ */
function err( ex ) { function error( ex ) {
var msg = ex.toString(); throw ex;
var idx = msg.indexOf('Error: ');
var trimmed = idx === -1 ? msg : msg.substring( idx + 7 );
_log( 'ERROR: ' + trimmed.toString() );
} }
/** /**
@ -98,14 +92,16 @@ module.exports = function () {
{ name: 'html', ext: 'html', gen: new FLUENT.HtmlGenerator() }, { name: 'html', ext: 'html', gen: new FLUENT.HtmlGenerator() },
{ name: 'txt', ext: 'txt', gen: new FLUENT.TextGenerator() }, { name: 'txt', ext: 'txt', gen: new FLUENT.TextGenerator() },
{ name: 'doc', ext: 'doc', fmt: 'xml', gen: new FLUENT.WordGenerator() }, { name: 'doc', ext: 'doc', fmt: 'xml', gen: new FLUENT.WordGenerator() },
{ name: 'pdf', ext: 'pdf', fmt: 'html', is: false, gen: new FLUENT.HtmlPdfGenerator() } { name: 'pdf', ext: 'pdf', fmt: 'html', is: false, gen: new FLUENT.HtmlPdfGenerator() },
{ name: 'markdown', ext: 'md', fmt: 'txt', gen: new FLUENT.MarkdownGenerator() },
{ name: 'json', ext: 'json', gen: new FLUENT.JsonGenerator() }
]; ];
/** /**
Default options. Default options.
*/ */
var _opts = { var _opts = {
theme: 'informatic', theme: 'modern',
} }
/** /**

View File

@ -6,19 +6,33 @@ Command-line interface (CLI) for FluentCMD via Node.js.
*/ */
var ARGS = require( 'minimist' ) var ARGS = require( 'minimist' )
, FCMD = require( './fluentcmd'); , FCMD = require( './fluentcmd')
, PKG = require('../package.json');
try { try {
console.log( '*** FluentCMD v0.1.0 ***' ); console.log( '*** FluentCMD v' + PKG.version + ' ***' );
if( process.argv.length <= 2 ) { throw 'Please specify a JSON resume file.'; } if( process.argv.length <= 2 ) { throw { fluenterror: 3 }; }
var args = ARGS( process.argv.slice(2) ); var args = ARGS( process.argv.slice(2) );
var src = args._.filter( function( a ) { return a.endsWith('.json'); }); var src = args._ || [];
var dst = args._.filter( function( a ) { return !a.endsWith('.json'); }); var dst = (args.o && ((typeof args.o === 'string' && [ args.o ]) || args.o)) || [];
FCMD.generate( src, dst, args.t || 'informatic' ); dst = (dst === true) ? [] : dst; // handle -o with missing output file
FCMD.generate( src, dst, args.t || 'modern' );
process.platform !== 'win32' && console.log('\n'); process.platform !== 'win32' && console.log('\n');
} }
catch( ex ) { catch( ex ) {
var msg = ex.toString();
var msg = '';
if( ex.fluenterror ){
switch( ex.fluenterror ) { // TODO: Remove magic numbers
case 1: msg = "The specified theme couldn't be found: " + ex.data; break;
case 2: msg = "Couldn't copy CSS file to destination folder"; break;
case 3: msg = "Please specify a valid JSON resume file."; break;
};
}
else {
msg = ex.toString();
}
var idx = msg.indexOf('Error: '); var idx = msg.indexOf('Error: ');
var trimmed = idx === -1 ? msg : msg.substring( idx + 7 ); var trimmed = idx === -1 ? msg : msg.substring( idx + 7 );
console.log( 'ERROR: ' + trimmed.toString() ); console.log( 'ERROR: ' + trimmed.toString() );