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

Compare commits

...

13 Commits

Author SHA1 Message Date
aacd50cebe Update README. 2015-10-26 10:18:33 -04:00
JD
ad75cdf02a Merge pull request #6 from fluentdesk/feat/partial-formats
Feat/partial formats
2015-10-26 10:06:52 -04:00
67e4e87275 Bump Watermark version. 2015-10-26 09:17:40 -04:00
4a98e0bb25 Multiple things.
1. Load themes directly in FCMD instead of only through FluentLib.
2. Add support for silent mode (`-s` or `--silent`).
3. Silently create output folder if not present (mkdirp).
2015-10-26 08:01:01 -04:00
06294a90b5 Add YAML output format support. 2015-10-26 02:45:37 -04:00
f7c05f49b2 Merge remote-tracking branch 'refs/remotes/origin/dev' 2015-10-25 08:19:21 -04:00
e20007721e Update README for 0.4.0. 2015-10-25 08:18:49 -04:00
19b6627df7 Bump version to 0.4.0. 2015-10-25 08:03:46 -04:00
68f943745c Support "--no-prettify" option.
Add command-line support for "--no-prettify" and "-n". Use a negative
option here since pretty printing is enabled by default.
2015-10-25 03:04:51 -04:00
2a7963450e Bump fluentlib version. 2015-10-25 02:16:54 -04:00
ceaef3e1c4 Bump version to 0.4.1. 2015-10-17 11:11:10 -04:00
1b4056371b Objectify options.
Support FCV Desktop requirement.
2015-10-17 11:10:59 -04:00
9dd759ffa2 Bump version to 0.3.1. 2015-10-10 23:27:20 -04:00
5 changed files with 144 additions and 30 deletions

View File

@ -4,7 +4,20 @@ fluentcmd
FluentCMD is a **hackable, data-driven, dev-friendly resume authoring tool** with support for HTML, Markdown, Word, PDF, plain text, smoke signal, carrier pigeon, and other arbitrary-format resumes and CVs.
[![](assets/office_space.jpg)][8]
```bash
>fluentcmd resume.json -o out/resume.all -t modern
*** FluentCMD v0.5.0 ***
Reading JSON resume: foo/resume.json
Applying MODERN Theme (7 formats)
Generating HTML resume: out/resume.html
Generating TXT resume: out/resume.txt
Generating DOC resume: out/resume.doc
Generating PDF resume: out/resume.pdf
Generating JSON resume: out/resume.json
Generating MARKDOWN resume: out/resume.md
Generating YAML resume: out/resume.yml
```
Looking for a desktop GUI version with pretty timelines and graphs? Check out [FluentCV Desktop][7].
@ -13,7 +26,7 @@ Looking for a desktop GUI version with pretty timelines and graphs? Check out [F
- Runs on OS X, Linux, and Windows.
- Store your resume data as a durable, versionable JSON, YML, or XML document.
- Generate multiple targeted resumes in multiple formats, based on your needs.
- Output to HTML, PDF, Markdown, Word, JSON, XML, or other arbitrary formats.
- Output to HTML, PDF, Markdown, Word, JSON, YAML, XML, or a custom format.
- Never update one piece of information in four different resumes again.
- Compatible with the [JSON Resume standard][6] and [authoring tools][7].
- Free and open-source through the MIT license.
@ -39,7 +52,7 @@ fluentcmd [inputs] [outputs] [-t theme].
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
# Generate all resume formats (HTML, PDF, DOC, TXT)
# Generate all resume formats (HTML, PDF, DOC, TXT, YML, etc.)
fluentcmd resume.json -o out/resume.all -t modern
# Generate a specific resume format
@ -49,6 +62,7 @@ fluentcmd resume.json -o out/resume.md
fluentcmd resume.json -o out/resume.doc
fluentcmd resume.json -o out/resume.json
fluentcmd resume.json -o out/resume.txt
fluentcmd resume.json -o out/resume.yml
# Specify 2 inputs and 3 outputs
fluentcmd in1.json in2.json -o out.html -o out.doc -o out.pdf
@ -57,14 +71,16 @@ fluentcmd in1.json in2.json -o out.html -o out.doc -o out.pdf
You should see something to the effect of:
```
*** FluentCMD v0.3.0 ***
*** FluentCMD v0.5.0 ***
Reading JSON resume: foo/resume.json
Applying MODERN Theme (7 formats)
Generating HTML resume: out/resume.html
Generating TXT resume: out/resume.txt
Generating DOC resume: out/resume.doc
Generating PDF resume: out/resume.pdf
Generating JSON resume: out/resume.json
Generating MARKDOWN resume: out/resume.md
Generating YAML resume: out/resume.yml
```
## Advanced
@ -78,7 +94,7 @@ fluentcmd resume.json -t modern
fluentcmd resume.json -t ~/foo/bar/my-custom-theme/
```
As of v0.3.0, available predefined themes are `modern`, `minimist`, `informatic`, and `hello-world`.
As of v0.5.0, available predefined themes are `modern`, `minimist`, and `hello-world`.
### Merging resumes
@ -129,6 +145,23 @@ fluentcmd me.json -o out/resume.all
..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`.
### Prettifying
FluentCMD applies [js-beautify][10]-style HTML prettification by default to HTML-formatted resumes. To disable prettification, the `--nopretty` or `-n` flag can be used:
```bash
fluentcmd resume.json out.all --nopretty
```
### Silent Mode
Use `-s` or `--silent` to run in silent mode:
```bash
fluentcmd resume.json -o someFile.all -s
fluentcmd resume.json -o someFile.all --silent
```
## License
MIT. Go crazy. See [LICENSE.md][1] for details.
@ -142,3 +175,4 @@ MIT. Go crazy. See [LICENSE.md][1] for details.
[7]: http://fluentcv.com
[8]: https://youtu.be/N9wsjroVlu8
[9]: https://api.jquery.com/jquery.extend/
[10]: https://github.com/beautify-web/js-beautify

View File

@ -1,6 +1,6 @@
{
"name": "fluentcmd",
"version": "0.3.0",
"version": "0.5.0",
"description": "Generate beautiful, targeted resumes from your command line or shell.",
"repository": {
"type": "git",
@ -24,8 +24,10 @@
},
"homepage": "https://github.com/fluentdesk/fluentcmd",
"dependencies": {
"fluentlib": "fluentdesk/fluentlib#v0.2.0",
"fluentlib": "fluentdesk/fluentlib#v0.4.0",
"minimist": "^1.2.0",
"underscore": "^1.8.3"
"mkdirp": "^0.5.1",
"underscore": "^1.8.3",
"watermark": "fluentdesk/watermark#v0.3.1-alpha"
}
}

View File

@ -12,6 +12,8 @@ module.exports = function () {
, fs = require('fs')
, _ = require('underscore')
, FLUENT = require('fluentlib')
, PATH = require('path')
, MKDIRP = require('mkdirp')
, rez, _log, _err;
/**
@ -22,11 +24,14 @@ module.exports = function () {
@param theme Friendly name of the resume theme. Defaults to "modern".
@param logger Optional logging override.
*/
function gen( src, dst, theme, logger, errHandler ) {
function gen( src, dst, opts, logger, errHandler ) {
_log = logger || console.log;
_err = errHandler || error;
_opts.theme = (theme && theme.toLowerCase().trim()) || 'modern';
//_opts = extend( true, _opts, opts );
_opts.theme = (opts.theme && opts.theme.toLowerCase().trim()) || 'modern';
_opts.prettify = opts.prettify === true ? _opts.prettify : false;
// Load input resumes...
if(!src || !src.length) { throw { fluenterror: 3 }; }
@ -44,17 +49,32 @@ module.exports = function () {
});
msg && _log(msg);
// Load the active theme
// Verify the specified theme name/path
var tFolder = PATH.resolve( __dirname, '../node_modules/watermark/themes', _opts.theme );
var exists = require('./utils/file-exists');
if (!exists( tFolder )) {
tFolder = PATH.resolve( _opts.theme );
if (!exists( tFolder )) {
throw { fluenterror: 1, data: _opts.theme };
}
}
var theTheme = new FLUENT.Theme().open( tFolder );
_opts.themeObj = theTheme;
_log( 'Applying ' + theTheme.name.toUpperCase() + ' theme (' + Object.keys(theTheme.formats).length + ' formats)' );
// Expand output resumes... (can't use map() here)
var targets = [];
var that = this;
( (dst && dst.length && dst) || ['resume.all'] ).forEach( function(t) {
var to = path.resolve(t), pa = path.parse(to), fmat = pa.ext || '.all';
targets.push.apply(targets, fmat === '.all' ?
_fmts.map(function(z){ return { file: to.replace(/all$/g,z.ext), fmt: z } })
: [{ file: to, fmt: _.findWhere( _fmts, { ext: fmat.substring(1) }) }]);
Object.keys( theTheme.formats ).map(function(k){ var z = theTheme.formats[k]; return { file: to.replace(/all$/g,z.pre), fmt: z } })
: [{ file: to, fmt: theTheme.getFormat( fmat.slice(1) ) }]);
});
// Run the transformation!
var finished = targets.map( single );
var finished = targets.map( function(t) { return single(t, theTheme); } );
// Don't send the client back empty-handed
return { sheet: rez, targets: targets, processed: finished };
@ -65,13 +85,17 @@ module.exports = function () {
@param f Full path to the destination resume to generate, for example,
"/foo/bar/resume.pdf" or "c:\foo\bar\resume.txt".
*/
function single( fi ) {
function single( fi, theme ) {
try {
var f = fi.file, fType = fi.fmt.ext, fName = path.basename( f, '.' + fType );
var fObj = _fmts.filter( function(_f) { return _f.ext === fType; } )[0];
var fOut = path.join( f.substring( 0, f.lastIndexOf('.') + 1 ) + fObj.ext );
_log( 'Generating ' + fi.fmt.name.toUpperCase() + ' resume: ' + path.relative(process.cwd(), f ) );
return fObj.gen.generate( rez, fOut, _opts.theme );
var fObj = _.property( fi.fmt.pre )( theme.formats );
var fOut = path.join( f.substring( 0, f.lastIndexOf('.') + 1 ) + fObj.pre );
_log( 'Generating ' + fi.fmt.title.toUpperCase() + ' resume: ' + path.relative(process.cwd(), f ) );
var theFormat = _fmts.filter( function( fmt ) {
return fmt.name === fi.fmt.pre;
})[0];
MKDIRP( path.dirname(fOut) ); // Ensure dest folder exists; don't bug user
theFormat.gen.generate( rez, fOut, _opts );
}
catch( ex ) {
_err( ex );
@ -93,16 +117,23 @@ module.exports = function () {
{ name: 'txt', ext: 'txt', gen: new FLUENT.TextGenerator() },
{ name: 'doc', ext: 'doc', fmt: 'xml', gen: new FLUENT.WordGenerator() },
{ 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() }
{ name: 'md', ext: 'md', fmt: 'txt', gen: new FLUENT.MarkdownGenerator() },
{ name: 'json', ext: 'json', gen: new FLUENT.JsonGenerator() },
{ name: 'yml', ext: 'yml', fmt: 'yml', gen: new FLUENT.JsonYamlGenerator() }
];
/**
Default options.
Default FluentCMD options.
*/
var _opts = {
theme: 'modern',
}
prettify: { // ← See https://github.com/beautify-web/js-beautify#options
indent_size: 2,
unformatted: ['em','strong'],
max_char: 80, // ← See lib/html.js in above-linked repo
//wrap_line_length: 120, ← Don't use this
}
};
/**
Internal module interface. Used by FCV Desktop and HMR.

View File

@ -10,17 +10,46 @@ var ARGS = require( 'minimist' )
, PKG = require('../package.json');
try {
console.log( '*** FluentCMD v' + PKG.version + ' ***' );
if( process.argv.length <= 2 ) { throw { fluenterror: 3 }; }
var args = ARGS( process.argv.slice(2) );
var src = args._ || [];
var dst = (args.o && ((typeof args.o === 'string' && [ args.o ]) || args.o)) || [];
dst = (dst === true) ? [] : dst; // handle -o with missing output file
FCMD.generate( src, dst, args.t || 'modern' );
process.platform !== 'win32' && console.log('\n');
var opts = { };
main();
}
catch( ex ) {
handleError( ex );
}
function main() {
// Setup.
if( process.argv.length <= 2 ) { throw { fluenterror: 3 }; }
var args = ARGS( process.argv.slice(2) );
opts = getOpts( args );
logMsg( '*** FluentCMD v' + PKG.version + ' ***' );
// Convert arguments to source files, target files, options
var src = args._ || [];
var dst = (args.o && ((typeof args.o === 'string' && [ args.o ]) || args.o)) || [];
dst = (dst === true) ? [] : dst; // Handle -o with missing output file
// Generate!
FCMD.generate( src, dst, opts, logMsg );
process.platform !== 'win32' && console.log('\n');
}
function logMsg( msg ) {
opts.silent || console.log( msg );
}
function getOpts( args ) {
var noPretty = args['nopretty'] || args.n;
noPretty = noPretty && (noPretty === true || noPretty === 'true');
return {
theme: args.t || 'modern',
prettify: !noPretty,
silent: args.s || args.silent
};
}
function handleError( ex ) {
var msg = '';
if( ex.fluenterror ){
switch( ex.fluenterror ) { // TODO: Remove magic numbers

18
src/utils/file-exists.js Normal file
View File

@ -0,0 +1,18 @@
/**
File-exists checker for Node.js.
@license Copyright (c) 2015 | James M. Devlin
*/
var FS = require('fs');
// Yup, this is now the recommended way to check for file existence on Node.
// fs.exists is deprecated and the recommended fs.statSync/lstatSync throws
// exceptions on non-existent paths :)
module.exports = function (path) {
try {
FS.statSync( path );
return true;
} catch( err ) {
return !(err && err.code === 'ENOENT');
}
};