Finish HackMyCore reshaping.

Reintroduce HackMyCore, dropping the interim submodule, and reorganize
and improve tests.

src/core/default-formats.coffee

@@ -0,0 +1,18 @@
+###
+Event code definitions.
+@module core/default-formats
+@license MIT. See LICENSE.md for details.
+###
+
+###* Supported resume formats. ###
+module.exports = [
+  { name: 'html', ext: 'html', gen: new (require('../generators/html-generator'))() },
+  { name: 'txt',  ext: 'txt', gen: new (require('../generators/text-generator'))()  },
+  { name: 'doc',  ext: 'doc',  fmt: 'xml', gen: new (require('../generators/word-generator'))() },
+  { name: 'pdf',  ext: 'pdf', fmt: 'html', is: false, gen: new (require('../generators/html-pdf-cli-generator'))() },
+  { name: 'png',  ext: 'png', fmt: 'html', is: false, gen: new (require('../generators/html-png-generator'))() },
+  { name: 'md', ext: 'md', fmt: 'txt', gen: new (require('../generators/markdown-generator'))() },
+  { name: 'json', ext: 'json', gen: new (require('../generators/json-generator'))() },
+  { name: 'yml', ext: 'yml', fmt: 'yml', gen: new (require('../generators/json-yaml-generator'))() },
+  { name: 'latex', ext: 'tex', fmt: 'latex', gen: new (require('../generators/latex-generator'))() }
+]

src/core/default-options.coffee

@@ -0,0 +1,13 @@
+###
+Event code definitions.
+@module core/default-options
+@license MIT. See LICENSE.md for details.
+###
+
+module.exports =
+  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

src/core/empty-jrs.json

@@ -0,0 +1,77 @@
+{
+  "basics": {
+    "name": "",
+    "label": "",
+    "picture": "",
+    "email": "",
+    "phone": "",
+    "degree": "",
+    "website": "",
+    "summary": "",
+    "location": {
+      "address": "",
+      "postalCode": "",
+      "city": "",
+      "countryCode": "",
+      "region": ""
+    },
+    "profiles": [{
+      "network": "",
+      "username": "",
+      "url": ""
+    }]
+  },
+
+  "work": [{
+    "company": "",
+    "position": "",
+    "website": "",
+    "startDate": "",
+    "endDate": "",
+    "summary": "",
+    "highlights": [
+      ""
+    ]
+  }],
+
+  "awards": [{
+    "title": "",
+    "date": "",
+    "awarder": "",
+    "summary": ""
+  }],
+
+  "education": [{
+    "institution": "",
+    "area": "",
+    "studyType": "",
+    "startDate": "",
+    "endDate": "",
+    "gpa": "",
+    "courses": [ "" ]
+  }],
+
+  "publications": [{
+    "name": "",
+    "publisher": "",
+    "releaseDate": "",
+    "website": "",
+    "summary": ""
+  }],
+
+  "volunteer": [{
+    "organization": "",
+    "position": "",
+    "website": "",
+    "startDate": "",
+    "endDate": "",
+    "summary": "",
+    "highlights": [ "" ]
+  }],
+
+  "skills": [{
+      "name": "",
+      "level": "",
+      "keywords": [""]
+  }]
+}

src/core/event-codes.coffee

@@ -0,0 +1,35 @@
+###
+Event code definitions.
+@module core/event-codes
+@license MIT. See LICENSE.md for details.
+###
+
+
+module.exports =
+  error:            -1
+  success:          0
+  begin:            1
+  end:              2
+  beforeRead:       3
+  afterRead:        4
+  beforeCreate:     5
+  afterCreate:      6
+  beforeTheme:      7
+  afterTheme:       8
+  beforeMerge:      9
+  afterMerge:       10
+  beforeGenerate:   11
+  afterGenerate:    12
+  beforeAnalyze:    13
+  afterAnalyze:     14
+  beforeConvert:    15
+  afterConvert:     16
+  verifyOutputs:    17
+  beforeParse:      18
+  afterParse:       19
+  beforePeek:       20
+  afterPeek:        21
+  beforeInlineConvert: 22
+  afterInlineConvert: 23
+  beforeValidate:   24
+  afterValidate:    25

src/core/fluent-date.coffee

@@ -0,0 +1,83 @@
+###*
+The HackMyResume date representation.
+@license MIT. See LICENSE.md for details.
+@module core/fluent-date
+###
+
+
+
+moment = require 'moment'
+
+###*
+Create a FluentDate from a string or Moment date object. There are a few date
+formats to be aware of here.
+1. The words "Present" and "Now", referring to the current date
+2. The default "YYYY-MM-DD" format used in JSON Resume ("2015-02-10")
+3. Year-and-month only ("2015-04")
+4. Year-only "YYYY" ("2015")
+5. The friendly HackMyResume "mmm YYYY" format ("Mar 2015" or "Dec 2008")
+6. Empty dates ("", " ")
+7. Any other date format that Moment.js can parse from
+Note: Moment can transparently parse all or most of these, without requiring us
+to specify a date format...but for maximum parsing safety and to avoid Moment
+deprecation warnings, it's recommended to either a) explicitly specify the date
+format or b) use an ISO format. For clarity, we handle these cases explicitly.
+@class FluentDate
+###
+
+class FluentDate
+
+  constructor: (dt) ->
+    @rep = this.fmt dt
+
+
+months = {}
+abbr = {}
+moment.months().forEach((m,idx) -> months[m.toLowerCase()] = idx+1 )
+moment.monthsShort().forEach((m,idx) -> abbr[m.toLowerCase()]=idx+1 )
+abbr.sept = 9
+module.exports = FluentDate
+
+FluentDate.fmt = ( dt, throws ) ->
+
+  throws = (throws == undefined || throws == null) || throws
+
+  if typeof dt == 'string' or dt instanceof String
+    dt = dt.toLowerCase().trim()
+    if /^(present|now|current)$/.test(dt) # "Present", "Now"
+      return moment()
+    else if /^\D+\s+\d{4}$/.test(dt) # "Mar 2015"
+      parts = dt.split(' ');
+      month = (months[parts[0]] || abbr[parts[0]]);
+      temp = parts[1] + '-' + (month < 10 ? '0' + month : month.toString());
+      return moment temp, 'YYYY-MM'
+    else if /^\d{4}-\d{1,2}$/.test(dt) # "2015-03", "1998-4"
+      return moment dt, 'YYYY-MM'
+    else if /^\s*\d{4}\s*$/.test(dt) # "2015"
+      return moment dt, 'YYYY'
+    else if /^\s*$/.test(dt) # "", " "
+      defTime =
+        isNull: true
+        isBefore: ( other ) ->
+          if other and !other.isNull then true else false
+        isAfter: ( other ) ->
+          if other and !other.isNull then false else false
+        unix: () -> 0
+        format: () -> ''
+        diff: () -> 0
+      return defTime
+    else
+      mt = moment dt
+      if mt.isValid()
+        return mt
+      if throws
+        throw 'Invalid date format encountered.'
+      return null
+  else
+    if !dt
+      return moment()
+    else if dt.isValid and dt.isValid()
+      return dt
+    if throws
+      throw 'Unknown date object encountered.'
+    return null

src/core/fresh-resume.coffee

@@ -0,0 +1,425 @@
+###*
+Definition of the FRESHResume class.
+@license MIT. See LICENSE.md for details.
+@module core/fresh-resume
+###
+
+
+
+FS = require 'fs'
+extend = require 'extend'
+validator = require 'is-my-json-valid'
+_ = require 'underscore'
+__ = require 'lodash'
+PATH = require 'path'
+moment = require 'moment'
+XML = require 'xml-escape'
+MD = require 'marked'
+CONVERTER = require 'fresh-jrs-converter'
+JRSResume = require './jrs-resume'
+
+
+
+###*
+A FRESH resume or CV. FRESH resumes are backed by JSON, and each FreshResume
+object is an instantiation of that JSON decorated with utility methods.
+@constructor
+###
+class FreshResume
+
+  ###* Initialize the FreshResume from file. ###
+  open: ( file, opts ) ->
+    raw = FS.readFileSync file, 'utf8'
+    ret = this.parse raw, opts
+    @imp.file = file
+    ret
+
+  ###* Initialize the the FreshResume from JSON string data. ###
+  parse: ( stringData, opts ) ->
+    @imp = @imp ? raw: stringData
+    this.parseJSON JSON.parse( stringData ), opts
+
+
+  ###*
+  Initialize the FreshResume from JSON.
+  Open and parse the specified FRESH resume. Merge the JSON object model onto
+  this Sheet instance with extend() and convert sheet dates to a safe &
+  consistent format. Then sort each section by startDate descending.
+  @param rep {Object} The raw JSON representation.
+  @param opts {Object} Resume loading and parsing options.
+  {
+    date: Perform safe date conversion.
+    sort: Sort resume items by date.
+    compute: Prepare computed resume totals.
+  }
+  ###
+  parseJSON: ( rep, opts ) ->
+
+    # Ignore any element with the 'ignore: true' designator.
+    that = @
+    traverse = require 'traverse'
+    ignoreList = []
+    scrubbed = traverse( rep ).map ( x ) ->
+      if !@isLeaf && @node.ignore
+        if @node.ignore == true || this.node.ignore == 'true'
+          ignoreList.push this.node
+          @remove()
+
+    # Now apply the resume representation onto this object
+    extend( true, @, scrubbed );
+
+    # If the resume has already been processed, then we are being called from
+    # the .dupe method, and there's no need to do any post processing
+    if !@imp?.processed
+      # Set up metadata TODO: Clean up metadata on the object model.
+      opts = opts || { }
+      if opts.imp == undefined || opts.imp
+        @imp = @imp || { }
+        @imp.title = (opts.title || @imp.title) || @name
+        unless @imp.raw
+          @imp.raw = JSON.stringify rep
+      @imp.processed = true
+      # Parse dates, sort dates, and calculate computed values
+      (opts.date == undefined || opts.date) && _parseDates.call( this );
+      (opts.sort == undefined || opts.sort) && this.sort();
+      (opts.compute == undefined || opts.compute) && (@computed = {
+         numYears: this.duration(),
+         keywords: this.keywords()
+      });
+
+    @
+
+
+  ###* Save the sheet to disk (for environments that have disk access). ###
+  save: ( filename ) ->
+    @imp.file = filename || @imp.file
+    FS.writeFileSync @imp.file, @stringify(), 'utf8'
+    @
+
+
+
+  ###*
+  Save the sheet to disk in a specific format, either FRESH or JSON Resume.
+  ###
+  saveAs: ( filename, format ) ->
+    if format != 'JRS'
+      @imp.file = filename || @imp.file
+      FS.writeFileSync @imp.file, @stringify(), 'utf8'
+    else
+      newRep = CONVERTER.toJRS this
+      FS.writeFileSync filename, JRSResume.stringify( newRep ), 'utf8'
+    @
+
+
+
+
+  ###*
+  Duplicate this FreshResume instance.
+  This method first extend()s this object onto an empty, creating a deep copy,
+  and then passes the result into a new FreshResume instance via .parseJSON.
+  We do it this way to create a true clone of the object without re-running any
+  of the associated processing.
+  ###
+  dupe: () ->
+    jso = extend true, { }, @
+    rnew = new FreshResume()
+    rnew.parseJSON jso, { }
+    rnew
+
+
+
+  ###*
+  Convert this object to a JSON string, sanitizing meta-properties along the
+  way.
+  ###
+  stringify: () -> FreshResume.stringify @
+
+
+  ###*
+  Create a copy of this resume in which all string fields have been run through
+  a transformation function (such as a Markdown filter or XML encoder).
+  TODO: Move this out of FRESHResume.
+  ###
+  transformStrings: ( filt, transformer ) ->
+    ret = this.dupe()
+    trx = require '../utils/string-transformer'
+    trx ret, filt, transformer
+
+
+
+  ###*
+  Create a copy of this resume in which all fields have been interpreted as
+  Markdown.
+  ###
+  markdownify: () ->
+
+    MDIN = ( txt ) ->
+      return MD(txt || '' ).replace(/^\s*<p>|<\/p>\s*$/gi, '')
+
+    trx = ( key, val ) ->
+      if key == 'summary'
+        return MD val
+      MDIN(val)
+
+    return @transformStrings ['skills','url','start','end','date'], trx
+
+
+
+  ###*
+  Create a copy of this resume in which all fields have been interpreted as
+  Markdown.
+  ###
+  xmlify: () ->
+    trx = (key, val) -> XML val
+    return @transformStrings [], trx
+
+
+
+  ###* Return the resume format. ###
+  format: () -> 'FRESH'
+
+
+
+  ###*
+  Return internal metadata. Create if it doesn't exist.
+  ###
+  i: () -> this.imp = this.imp || { }
+
+
+
+  ###* Return a unique list of all keywords across all skills. ###
+  keywords: () ->
+    flatSkills = []
+    if @skills
+      if @skills.sets
+        flatSkills = @skills.sets.map((sk) -> sk.skills ).reduce( (a,b) -> a.concat(b) )
+      else if @skills.list
+        flatSkills = flatSkills.concat( this.skills.list.map (sk) -> return sk.name )
+      flatSkills = _.uniq flatSkills
+    flatSkills
+
+
+
+  ###*
+  Reset the sheet to an empty state. TODO: refactor/review
+  ###
+  clear: ( clearMeta ) ->
+    clearMeta = ((clearMeta == undefined) && true) || clearMeta
+    delete this.imp if clearMeta
+    delete this.computed # Don't use Object.keys() here
+    delete this.employment
+    delete this.service
+    delete this.education
+    delete this.recognition
+    delete this.reading
+    delete this.writing
+    delete this.interests
+    delete this.skills
+    delete this.social
+
+
+
+  ###*
+  Get a safe count of the number of things in a section.
+  ###
+  count: ( obj ) ->
+    return 0 if !obj
+    return obj.history.length if obj.history
+    return obj.sets.length if obj.sets
+    obj.length || 0;
+
+
+
+
+
+
+
+  ###* Add work experience to the sheet. ###
+  add: ( moniker ) ->
+    defSheet = FreshResume.default()
+    newObject =
+      if defSheet[moniker].history
+      then $.extend( true, {}, defSheet[ moniker ].history[0] )
+      else
+        if moniker == 'skills'
+        then $.extend( true, {}, defSheet.skills.sets[0] )
+        else $.extend( true, {}, defSheet[ moniker ][0] )
+
+    @[ moniker ] = @[ moniker ] || []
+    if @[ moniker ].history
+      @[ moniker ].history.push newObject
+    else if moniker == 'skills'
+      @skills.sets.push newObject
+    else
+      @[ moniker ].push newObject
+    newObject
+
+
+
+
+  ###*
+  Determine if the sheet includes a specific social profile (eg, GitHub).
+  ###
+  hasProfile: ( socialNetwork ) ->
+    socialNetwork = socialNetwork.trim().toLowerCase()
+    @social && _.some @social, (p) ->
+      p.network.trim().toLowerCase() == socialNetwork
+
+
+  ###* Return the specified network profile. ###
+  getProfile: ( socialNetwork ) ->
+    socialNetwork = socialNetwork.trim().toLowerCase()
+    @social && _.find @social, (sn) ->
+      sn.network.trim().toLowerCase() == socialNetwork
+
+
+  ###*
+  Return an array of profiles for the specified network, for when the user
+  has multiple eg. GitHub accounts.
+  ###
+  getProfiles: ( socialNetwork ) ->
+    socialNetwork = socialNetwork.trim().toLowerCase()
+    @social && _.filter @social, (sn) ->
+      sn.network.trim().toLowerCase() == socialNetwork
+
+
+  ###* Determine if the sheet includes a specific skill. ###
+  hasSkill: ( skill ) ->
+    skill = skill.trim().toLowerCase()
+    @skills && _.some @skills, (sk) ->
+      sk.keywords && _.some sk.keywords, (kw) ->
+        kw.trim().toLowerCase() == skill
+
+
+
+  ###* Validate the sheet against the FRESH Resume schema. ###
+  isValid: ( info ) ->
+    schemaObj = require 'fresca'
+    validator = require 'is-my-json-valid'
+    validate = validator( schemaObj, { # See Note [1].
+      formats: { date: /^\d{4}(?:-(?:0[0-9]{1}|1[0-2]{1})(?:-[0-9]{2})?)?$/ }
+    })
+    ret = validate @
+    if !ret
+      this.imp = this.imp || { };
+      this.imp.validationErrors = validate.errors;
+    ret
+
+
+
+  ###*
+  Calculate the total duration of the sheet. Assumes this.work has been sorted
+  by start date descending, perhaps via a call to Sheet.sort().
+  @returns The total duration of the sheet's work history, that is, the number
+  of years between the start date of the earliest job on the resume and the
+  *latest end date of all jobs in the work history*. This last condition is for
+  sheets that have overlapping jobs.
+  ###
+  duration: (unit) ->
+    unit = unit || 'years'
+    empHist = __.get(this, 'employment.history')
+    if empHist && empHist.length
+      firstJob = _.last( empHist )
+      careerStart = if firstJob.start then firstJob.safe.start else ''
+      if ((typeof careerStart == 'string' || careerStart instanceof String) && !careerStart.trim())
+        return 0
+      careerLast = _.max empHist, ( w ) ->
+        return if w.safe && w.safe.end then w.safe.end.unix() else moment().unix()
+      return careerLast.safe.end.diff careerStart, unit
+    0
+
+
+
+  ###*
+  Sort dated things on the sheet by start date descending. Assumes that dates
+  on the sheet have been processed with _parseDates().
+  ###
+  sort: () ->
+
+    byDateDesc = (a,b) ->
+      if ( a.safe.start.isBefore(b.safe.start) )
+      then 1
+      else ( a.safe.start.isAfter(b.safe.start) && -1 ) || 0
+
+    sortSection = ( key ) ->
+      ar = __.get this, key
+      if ar && ar.length
+        datedThings = obj.filter (o) -> o.start
+        datedThings.sort( byDateDesc );
+
+    sortSection 'employment.history'
+    sortSection 'education.history'
+    sortSection 'service.history'
+    sortSection 'projects'
+
+    # this.awards && this.awards.sort( function(a, b) {
+    #   return( a.safeDate.isBefore(b.safeDate) ) ? 1
+    #     : ( a.safeDate.isAfter(b.safeDate) && -1 ) || 0;
+    # });
+    @writing && @writing.sort (a, b) ->
+      if a.safe.date.isBefore b.safe.date
+      then 1
+      else ( a.safe.date.isAfter(b.safe.date) && -1 ) || 0
+
+
+###*
+Get the default (starter) sheet.
+###
+FreshResume.default = () ->
+  new FreshResume().parseJSON( require 'fresh-resume-starter' )
+
+
+###*
+Convert the supplied FreshResume to a JSON string, sanitizing meta-properties
+along the way.
+###
+FreshResume.stringify = ( obj ) ->
+  replacer = ( key,value ) -> # Exclude these keys from stringification
+    exKeys = ['imp', 'warnings', 'computed', 'filt', 'ctrl', 'index',
+      'safe', 'result', 'isModified', 'htmlPreview', 'display_progress_bar']
+    return if _.some( exKeys, (val) -> key.trim() == val )
+    then undefined else value
+  JSON.stringify obj, replacer, 2
+
+
+###*
+Convert human-friendly dates into formal Moment.js dates for all collections.
+We don't want to lose the raw textual date as entered by the user, so we store
+the Moment-ified date as a separate property with a prefix of .safe. For ex:
+job.startDate is the date as entered by the user. job.safeStartDate is the
+parsed Moment.js date that we actually use in processing.
+###
+_parseDates = () ->
+
+  _fmt = require('./fluent-date').fmt
+  that = @
+
+  # TODO: refactor recursion
+  replaceDatesInObject = ( obj ) ->
+
+    return if !obj
+    if Object.prototype.toString.call( obj ) == '[object Array]'
+      obj.forEach (elem) -> replaceDatesInObject( elem )
+    else if typeof obj == 'object'
+      if obj._isAMomentObject || obj.safe
+        return
+      Object.keys( obj ).forEach (key) -> replaceDatesInObject obj[key]
+      ['start','end','date'].forEach (val) ->
+        if (obj[val] != undefined) && (!obj.safe || !obj.safe[val])
+          obj.safe = obj.safe || { }
+          obj.safe[ val ] = _fmt obj[val]
+          if obj[val] && (val == 'start') && !obj.end
+            obj.safe.end = _fmt 'current'
+
+  Object.keys( this ).forEach (member) -> replaceDatesInObject(that[member])
+
+
+
+###* Export the Sheet function/ctor. ###
+module.exports = FreshResume
+
+# Note 1: Adjust default date validation to allow YYYY and YYYY-MM formats
+# in addition to YYYY-MM-DD. The original regex:
+#
+#     /^\d{4}-(?:0[0-9]{1}|1[0-2]{1})-[0-9]{2}$/
+#

src/core/fresh-theme.coffee

@@ -0,0 +1,277 @@
+###*
+Definition of the FRESHTheme class.
+@module core/fresh-theme
+@license MIT. See LICENSE.md for details.
+###
+
+
+
+FS = require 'fs'
+validator = require 'is-my-json-valid'
+_ = require 'underscore'
+PATH = require 'path'
+parsePath = require 'parse-filepath'
+pathExists = require('path-exists').sync
+EXTEND = require 'extend'
+HMSTATUS = require './status-codes'
+moment = require 'moment'
+loadSafeJson = require '../utils/safe-json-loader'
+READFILES = require 'recursive-readdir-sync'
+
+
+
+###
+The FRESHTheme class is a representation of a FRESH theme
+asset. See also: JRSTheme.
+@class FRESHTheme
+###
+class FRESHTheme
+
+
+
+
+  ###
+  Open and parse the specified theme.
+  ###
+  open: ( themeFolder ) ->
+
+    this.folder = themeFolder;
+
+    # Open the [theme-name].json file; should have the same name as folder
+    pathInfo = parsePath( themeFolder )
+
+    # Set up a formats hash for the theme
+    formatsHash = { }
+
+    # Load the theme
+    themeFile = PATH.join( themeFolder, 'theme.json' )
+    themeInfo = loadSafeJson( themeFile )
+    if themeInfo.ex
+      throw
+        fluenterror:
+          if themeInfo.ex.operation == 'parse'
+          then HMSTATUS.parseError
+          else HMSTATUS.readError
+      inner: themeInfo.ex.inner
+
+    that = this
+
+    # Move properties from the theme JSON file to the theme object
+    EXTEND true, @, themeInfo.json
+
+    # Check for an "inherits" entry in the theme JSON.
+    if @inherits
+      cached = { }
+      _.each @inherits, (th, key) ->
+        themesFolder = require.resolve 'fresh-themes'
+        d = parsePath( themeFolder ).dirname
+        themePath = PATH.join d, th
+        cached[ th ] = cached[th] || new FRESHTheme().open( themePath )
+        formatsHash[ key ] = cached[ th ].getFormat( key )
+
+    # Check for an explicit "formats" entry in the theme JSON. If it has one,
+    # then this theme declares its files explicitly.
+    if !!@formats
+      formatsHash = loadExplicit.call this, formatsHash
+      @explicit = true;
+    else
+      formatsHash = loadImplicit.call this, formatsHash
+
+    # Cache
+    @formats = formatsHash
+
+    # Set the official theme name
+    @name = parsePath( @folder ).name
+    @
+
+  ### Determine if the theme supports the specified output format. ###
+  hasFormat: ( fmt ) -> _.has @formats, fmt
+
+  ### Determine if the theme supports the specified output format. ###
+  getFormat: ( fmt ) -> @formats[ fmt ]
+
+
+### Load the theme implicitly, by scanning the theme folder for files. TODO:
+Refactor duplicated code with loadExplicit. ###
+loadImplicit = (formatsHash) ->
+
+  # Set up a hash of formats supported by this theme.
+  that = @
+  major = false
+
+  # Establish the base theme folder
+  tplFolder = PATH.join @folder, 'src'
+
+  # Iterate over all files in the theme folder, producing an array, fmts,
+  # containing info for each file. While we're doing that, also build up
+  # the formatsHash object.
+  fmts = READFILES(tplFolder).map (absPath) ->
+
+    # If this file lives in a specific format folder within the theme,
+    # such as "/latex" or "/html", then that format is the output format
+    # for all files within the folder.
+    pathInfo = parsePath absPath
+    outFmt = ''
+    isMajor = false
+    portion = pathInfo.dirname.replace tplFolder,''
+    if portion && portion.trim()
+      return if portion[1] == '_'
+      reg = /^(?:\/|\\)(html|latex|doc|pdf|png|partials)(?:\/|\\)?/ig
+      res = reg.exec( portion )
+      if res
+        if res[1] != 'partials'
+          outFmt = res[1]
+        else
+          that.partials = that.partials || []
+          that.partials.push( { name: pathInfo.name, path: absPath } )
+          return null
+
+
+
+    # Otherwise, the output format is inferred from the filename, as in
+    # compact-[outputformat].[extension], for ex, compact-pdf.html.
+    if !outFmt
+      idx = pathInfo.name.lastIndexOf '-'
+      outFmt = if idx == -1 then pathInfo.name else pathInfo.name.substr( idx + 1 )
+      isMajor = true
+
+    # We should have a valid output format now.
+    formatsHash[ outFmt ] = formatsHash[outFmt] || {
+      outFormat: outFmt,
+      files: []
+    }
+
+    # Create the file representation object.
+    obj =
+      action: 'transform'
+      path: absPath
+      major: isMajor
+      orgPath: PATH.relative(tplFolder, absPath)
+      ext: pathInfo.extname.slice(1)
+      title: friendlyName( outFmt )
+      pre: outFmt
+      # outFormat: outFmt || pathInfo.name,
+      data: FS.readFileSync( absPath, 'utf8' )
+      css: null
+
+    # Add this file to the list of files for this format type.
+    formatsHash[ outFmt ].files.push( obj )
+    obj
+
+  # Now, get all the CSS files...
+  @cssFiles = fmts.filter (fmt) -> fmt and (fmt.ext == 'css')
+
+  # For each CSS file, get its corresponding HTML file. It's possible that
+  # a theme can have a CSS file but *no* HTML file, as when a theme author
+  # creates a pure CSS override of an existing theme.
+  @cssFiles.forEach (cssf) ->
+    idx = _.findIndex fmts, ( fmt ) ->
+      fmt && fmt.pre == cssf.pre && fmt.ext == 'html'
+    cssf.major = false
+    if idx > -1
+      fmts[ idx ].css = cssf.data
+      fmts[ idx ].cssPath = cssf.path
+    else
+      if that.inherits
+        # Found a CSS file without an HTML file in a theme that inherits
+        # from another theme. This is the override CSS file.
+        that.overrides = { file: cssf.path, data: cssf.data }
+  formatsHash
+
+
+
+###
+Load the theme explicitly, by following the 'formats' hash
+in the theme's JSON settings file.
+###
+loadExplicit = (formatsHash) ->
+
+  # Housekeeping
+  tplFolder = PATH.join this.folder, 'src'
+  act = null
+  that = this
+
+  # Iterate over all files in the theme folder, producing an array, fmts,
+  # containing info for each file. While we're doing that, also build up
+  # the formatsHash object.
+  fmts = READFILES( tplFolder ).map (absPath) ->
+
+    act = null
+    # If this file is mentioned in the theme's JSON file under "transforms"
+    pathInfo = parsePath(absPath)
+    absPathSafe = absPath.trim().toLowerCase()
+    outFmt = _.find Object.keys( that.formats ), ( fmtKey ) ->
+        fmtVal = that.formats[ fmtKey ]
+        _.some fmtVal.transform, (fpath) ->
+          absPathB = PATH.join( that.folder, fpath ).trim().toLowerCase()
+          absPathB == absPathSafe
+
+    act = 'transform' if outFmt
+
+    # If this file lives in a specific format folder within the theme,
+    # such as "/latex" or "/html", then that format is the output format
+    # for all files within the folder.
+    if !outFmt
+      portion = pathInfo.dirname.replace tplFolder,''
+      if portion && portion.trim()
+        reg = /^(?:\/|\\)(html|latex|doc|pdf)(?:\/|\\)?/ig
+        res = reg.exec portion
+        res && (outFmt = res[1])
+
+    # Otherwise, the output format is inferred from the filename, as in
+    # compact-[outputformat].[extension], for ex, compact-pdf.html.
+    if !outFmt
+      idx = pathInfo.name.lastIndexOf '-'
+      outFmt = if (idx == -1) then pathInfo.name else pathInfo.name.substr(idx + 1)
+
+    # We should have a valid output format now.
+    formatsHash[ outFmt ] =
+      formatsHash[ outFmt ] || {
+        outFormat: outFmt,
+        files: [],
+        symLinks: that.formats[ outFmt ].symLinks
+      };
+
+    # Create the file representation object.
+    obj =
+      action: act
+      orgPath: PATH.relative(that.folder, absPath)
+      path: absPath
+      ext: pathInfo.extname.slice(1)
+      title: friendlyName( outFmt )
+      pre: outFmt
+      # outFormat: outFmt || pathInfo.name,
+      data: FS.readFileSync( absPath, 'utf8' )
+      css: null
+
+    # Add this file to the list of files for this format type.
+    formatsHash[ outFmt ].files.push( obj )
+    obj
+
+  # Now, get all the CSS files...
+  @cssFiles = fmts.filter ( fmt ) -> fmt.ext == 'css'
+
+  # For each CSS file, get its corresponding HTML file
+  @cssFiles.forEach ( cssf ) ->
+    # For each CSS file, get its corresponding HTML file
+    idx = _.findIndex fmts, ( fmt ) ->
+      fmt.pre == cssf.pre && fmt.ext == 'html'
+    fmts[ idx ].css = cssf.data;
+    fmts[ idx ].cssPath = cssf.path;
+  # Remove CSS files from the formats array
+  fmts = fmts.filter ( fmt) -> fmt.ext != 'css'
+  formatsHash
+
+
+
+###
+Return a more friendly name for certain formats.
+TODO: Refactor
+###
+friendlyName = ( val ) ->
+  val = val.trim().toLowerCase()
+  friendly = { yml: 'yaml', md: 'markdown', txt: 'text' }
+  friendly[val] || val
+
+
+module.exports = FRESHTheme

src/core/jrs-resume.coffee

@@ -0,0 +1,360 @@
+###*
+Definition of the JRSResume class.
+@license MIT. See LICENSE.md for details.
+@module core/jrs-resume
+###
+
+
+
+FS = require('fs')
+extend = require('extend')
+validator = require('is-my-json-valid')
+_ = require('underscore')
+PATH = require('path')
+MD = require('marked')
+CONVERTER = require('fresh-jrs-converter')
+moment = require('moment')
+
+
+
+###*
+A JRS resume or CV. JRS resumes are backed by JSON, and each JRSResume object
+is an instantiation of that JSON decorated with utility methods.
+@class JRSResume
+###
+class JRSResume
+
+
+
+  ###* Initialize the JSResume from file. ###
+  open: ( file, opts ) ->
+    raw = FS.readFileSync file, 'utf8'
+    ret = this.parse raw, opts
+    @imp.file = file
+    ret
+
+
+  ###* Initialize the the JSResume from string. ###
+  parse: ( stringData, opts ) ->
+    @imp = @imp ? raw: stringData
+    this.parseJSON JSON.parse( stringData ), opts
+
+
+
+  ###*
+  Initialize the JRSResume object from JSON.
+  Open and parse the specified JRS resume. Merge the JSON object model onto
+  this Sheet instance with extend() and convert sheet dates to a safe &
+  consistent format. Then sort each section by startDate descending.
+  @param rep {Object} The raw JSON representation.
+  @param opts {Object} Resume loading and parsing options.
+  {
+    date: Perform safe date conversion.
+    sort: Sort resume items by date.
+    compute: Prepare computed resume totals.
+  }
+  ###
+  parseJSON: ( rep, opts ) ->
+    opts = opts || { };
+
+    # Ignore any element with the 'ignore: true' designator.
+    that = this
+    traverse = require 'traverse'
+    ignoreList = []
+    scrubbed = traverse( rep ).map ( x ) ->
+      if !@isLeaf && @node.ignore
+        if  @node.ignore == true || this.node.ignore == 'true'
+          ignoreList.push @node
+          @remove()
+
+    # Extend resume properties onto ourself.
+    extend true, this, scrubbed
+
+    # Set up metadata
+    if !@imp?.processed
+      # Set up metadata TODO: Clean up metadata on the object model.
+      opts = opts || { }
+      if opts.imp == undefined || opts.imp
+        @imp = @imp || { }
+        @imp.title = (opts.title || @imp.title) || @basics.name
+        unless @imp.raw
+          @imp.raw = JSON.stringify rep
+      @imp.processed = true
+    # Parse dates, sort dates, and calculate computed values
+    (opts.date == undefined || opts.date) && _parseDates.call( this )
+    (opts.sort == undefined || opts.sort) && this.sort()
+    if opts.compute == undefined || opts.compute
+      @basics.computed =
+        numYears: this.duration()
+        keywords: this.keywords()
+    @
+
+
+
+  ###* Save the sheet to disk (for environments that have disk access). ###
+  save: ( filename ) ->
+    @imp.file = filename || @imp.file
+    FS.writeFileSync @imp.file, @stringify( this ), 'utf8'
+    @
+
+
+
+  ###* Save the sheet to disk in a specific format, either FRESH or JRS. ###
+  saveAs: ( filename, format ) ->
+    if format == 'JRS'
+      @imp.file = filename || @imp.file;
+      FS.writeFileSync( @imp.file, @stringify(), 'utf8' );
+    else
+      newRep = CONVERTER.toFRESH @
+      stringRep = CONVERTER.toSTRING newRep
+      FS.writeFileSync filename, stringRep, 'utf8'
+    @
+
+
+
+  ###* Return the resume format. ###
+  format = () -> 'JRS'
+
+
+
+
+  stringify: () -> JRSResume.stringify( @ )
+
+
+
+  ###* Return a unique list of all keywords across all skills. ###
+  keywords: () ->
+    flatSkills = []
+    if @skills && this.skills.length
+      @skills.forEach ( s ) -> flatSkills = _.union flatSkills, s.keywords
+    flatSkills
+
+
+
+  ###*
+  Return internal metadata. Create if it doesn't exist.
+  JSON Resume v0.0.0 doesn't allow additional properties at the root level,
+  so tuck this into the .basic sub-object.
+  ###
+  i: () ->
+    @imp = @imp ? { }
+
+
+
+  ###* Reset the sheet to an empty state. ###
+  clear = ( clearMeta ) ->
+    clearMeta = ((clearMeta == undefined) && true) || clearMeta;
+    delete this.imp if clearMeta
+    delete this.basics.computed # Don't use Object.keys() here
+    delete this.work
+    delete this.volunteer
+    delete this.education
+    delete this.awards
+    delete this.publications
+    delete this.interests
+    delete this.skills
+    delete this.basics.profiles
+
+
+
+
+  ###* Add work experience to the sheet. ###
+  add: ( moniker ) ->
+    defSheet = JRSResume.default()
+    newObject = $.extend( true, {}, defSheet[ moniker ][0] )
+    this[ moniker ] = this[ moniker ] || []
+    this[ moniker ].push( newObject )
+    newObject
+
+
+
+  ###* Determine if the sheet includes a specific social profile (eg, GitHub). ###
+  hasProfile: ( socialNetwork ) ->
+    socialNetwork = socialNetwork.trim().toLowerCase()
+    return @basics.profiles && _.some @basics.profiles, (p) ->
+      return p.network.trim().toLowerCase() == socialNetwork
+
+
+
+  ###* Determine if the sheet includes a specific skill. ###
+  hasSkill: ( skill ) ->
+    skill = skill.trim().toLowerCase()
+    return this.skills && _.some this.skills, (sk) ->
+      return sk.keywords && _.some sk.keywords, (kw) ->
+        kw.trim().toLowerCase() == skill
+
+
+
+  ###* Validate the sheet against the JSON Resume schema. ###
+  isValid: ( ) -> # TODO: ↓ fix this path ↓
+    schema = FS.readFileSync PATH.join( __dirname, 'resume.json' ), 'utf8'
+    schemaObj = JSON.parse schema
+    validator = require 'is-my-json-valid'
+    validate = validator( schemaObj, { # Note [1]
+      formats: { date: /^\d{4}(?:-(?:0[0-9]{1}|1[0-2]{1})(?:-[0-9]{2})?)?$/ }
+    });
+    temp = @imp
+    delete @imp
+    ret = validate @
+    @imp = temp
+    if !ret
+      @imp = @imp || { };
+      @imp.validationErrors = validate.errors;
+    ret
+
+
+
+  ###*
+  Calculate the total duration of the sheet. Assumes this.work has been sorted
+  by start date descending, perhaps via a call to Sheet.sort().
+  @returns The total duration of the sheet's work history, that is, the number
+  of years between the start date of the earliest job on the resume and the
+  *latest end date of all jobs in the work history*. This last condition is for
+  sheets that have overlapping jobs.
+  ###
+  duration: ( unit ) ->
+    unit = unit || 'years';
+    if this.work && this.work.length
+      careerStart = this.work[ this.work.length - 1].safeStartDate
+      if (typeof careerStart == 'string' || careerStart instanceof String) && !careerStart.trim()
+        return 0
+      careerLast = _.max( this.work, ( w ) -> w.safeEndDate.unix() ).safeEndDate;
+      return careerLast.diff careerStart, unit
+    0
+
+
+
+  ###*
+  Sort dated things on the sheet by start date descending. Assumes that dates
+  on the sheet have been processed with _parseDates().
+  ###
+  sort: ( ) ->
+
+    byDateDesc = (a,b) ->
+      if a.safeStartDate.isBefore(b.safeStartDate)
+      then 1
+      else ( a.safeStartDate.isAfter(b.safeStartDate) && -1 ) || 0
+
+    @work && @work.sort byDateDesc
+    @education && @education.sort byDateDesc
+    @volunteer && @volunteer.sort byDateDesc
+
+    @awards && @awards.sort (a, b) ->
+      if a.safeDate.isBefore b.safeDate
+      then 1
+      else (a.safeDate.isAfter(b.safeDate) && -1 ) || 0;
+
+    @publications && @publications.sort (a, b) ->
+      if ( a.safeReleaseDate.isBefore(b.safeReleaseDate) )
+      then 1
+      else ( a.safeReleaseDate.isAfter(b.safeReleaseDate) && -1 ) || 0
+
+
+  dupe: () ->
+    rnew = new JRSResume()
+    rnew.parse this.stringify(), { }
+    rnew
+
+
+
+  ###*
+  Create a copy of this resume in which all fields have been interpreted as
+  Markdown.
+  ###
+  harden: () ->
+
+    that = @
+    ret = @dupe()
+
+    HD = (txt) -> '@@@@~' + txt + '~@@@@'
+
+    HDIN = (txt) ->
+      #return MD(txt || '' ).replace(/^\s*<p>|<\/p>\s*$/gi, '');
+      return HD txt
+
+    # TODO: refactor recursion
+    hardenStringsInObject = ( obj, inline ) ->
+
+      return if !obj
+      inline = inline == undefined || inline
+
+      if Object.prototype.toString.call( obj ) == '[object Array]'
+        obj.forEach (elem, idx, ar) ->
+          if typeof elem == 'string' || elem instanceof String
+            ar[idx] = if inline then HDIN(elem) else HD( elem )
+          else
+            hardenStringsInObject elem
+      else if typeof obj == 'object'
+        Object.keys( obj ).forEach (key) ->
+          sub = obj[key]
+          if typeof sub == 'string' || sub instanceof String
+            if _.contains(['skills','url','website','startDate','endDate',
+              'releaseDate','date','phone','email','address','postalCode',
+              'city','country','region'], key)
+              return
+            if key == 'summary'
+              obj[key] = HD( obj[key] )
+            else
+              obj[key] = if inline then HDIN( obj[key] ) else HD( obj[key] )
+          else
+            hardenStringsInObject sub
+
+
+    Object.keys( ret ).forEach (member) ->
+      hardenStringsInObject ret[ member ]
+
+    ret
+
+
+
+###* Get the default (empty) sheet. ###
+JRSResume.default = () ->
+  new JRSResume().open PATH.join( __dirname, 'empty-jrs.json'), 'Empty'
+
+
+
+###*
+Convert this object to a JSON string, sanitizing meta-properties along the
+way. Don't override .toString().
+###
+JRSResume.stringify = ( obj ) ->
+  replacer = ( key,value ) -> # Exclude these keys from stringification
+    temp = _.some ['imp', 'warnings', 'computed', 'filt', 'ctrl', 'index',
+      'safeStartDate', 'safeEndDate', 'safeDate', 'safeReleaseDate', 'result',
+      'isModified', 'htmlPreview', 'display_progress_bar'],
+      ( val ) -> return key.trim() == val
+    return if temp then undefined else value
+  JSON.stringify obj, replacer, 2
+
+
+###*
+Convert human-friendly dates into formal Moment.js dates for all collections.
+We don't want to lose the raw textual date as entered by the user, so we store
+the Moment-ified date as a separate property with a prefix of .safe. For ex:
+job.startDate is the date as entered by the user. job.safeStartDate is the
+parsed Moment.js date that we actually use in processing.
+###
+_parseDates = () ->
+
+  _fmt = require('./fluent-date').fmt
+
+  @work && @work.forEach (job) ->
+    job.safeStartDate = _fmt( job.startDate )
+    job.safeEndDate = _fmt( job.endDate )
+  @education && @education.forEach (edu) ->
+    edu.safeStartDate = _fmt( edu.startDate )
+    edu.safeEndDate = _fmt( edu.endDate )
+  @volunteer && @volunteer.forEach (vol) ->
+    vol.safeStartDate = _fmt( vol.startDate )
+    vol.safeEndDate = _fmt( vol.endDate )
+  @awards && @awards.forEach (awd) ->
+    awd.safeDate = _fmt( awd.date )
+  @publications && @publications.forEach (pub) ->
+    pub.safeReleaseDate = _fmt( pub.releaseDate )
+
+
+
+###*
+Export the JRSResume function/ctor.
+###
+module.exports = JRSResume

src/core/jrs-theme.coffee

@@ -0,0 +1,87 @@
+###*
+Definition of the JRSTheme class.
+@module core/jrs-theme
+@license MIT. See LICENSE.MD for details.
+###
+
+
+
+_ = require 'underscore'
+PATH = require 'path'
+parsePath = require 'parse-filepath'
+pathExists = require('path-exists').sync
+
+
+
+###*
+The JRSTheme class is a representation of a JSON Resume theme asset.
+@class JRSTheme
+###
+class JRSTheme
+
+
+###*
+Open and parse the specified theme.
+@method open
+###
+open: ( thFolder ) ->
+
+  @folder = thFolder
+
+  # Open the [theme-name].json file; should have the same
+  # name as folder
+  pathInfo = parsePath thFolder
+
+  # Open and parse the theme's package.json file.
+  pkgJsonPath = PATH.join thFolder, 'package.json'
+  if pathExists pkgJsonPath
+    thApi = require thFolder
+    thPkg = require pkgJsonPath
+    this.name = thPkg.name
+    this.render = (thApi && thApi.render) || undefined
+    this.engine = 'jrs'
+
+    # Create theme formats (HTML and PDF). Just add the bare minimum mix of
+    # properties necessary to allow JSON Resume themes to share a rendering
+    # path with FRESH themes.
+    this.formats =
+      html:
+        outFormat: 'html'
+        files: [{
+          action: 'transform',
+          render: this.render,
+          major: true,
+          ext: 'html',
+          css: null
+        }]
+      pdf:
+        outFormat: 'pdf'
+        files: [{
+          action: 'transform',
+          render: this.render,
+          major: true,
+          ext: 'pdf',
+          css: null
+        }]
+  else
+    throw { fluenterror: HACKMYSTATUS.missingPackageJSON };
+  @
+
+
+
+###*
+Determine if the theme supports the output format.
+@method hasFormat
+###
+hasFormat: ( fmt ) ->  _.has this.formats, fmt
+
+
+
+###*
+Return the requested output format.
+@method getFormat
+###
+getFormat = ( fmt ) -> @formats[ fmt ]
+
+
+module.exports = JRSTheme;

src/core/resume-factory.coffee

@@ -0,0 +1,115 @@
+###*
+Definition of the ResumeFactory class.
+@license MIT. See LICENSE.md for details.
+@module core/resume-factory
+###
+
+
+
+FS              = require('fs')
+HACKMYSTATUS    = require('./status-codes')
+HME             = require('./event-codes')
+ResumeConverter = require('fresh-jrs-converter')
+chalk           = require('chalk')
+SyntaxErrorEx   = require('../utils/syntax-error-ex')
+_               = require('underscore')
+require('string.prototype.startswith')
+
+
+
+###*
+A simple factory class for FRESH and JSON Resumes.
+@class ResumeFactory
+###
+
+ResumeFactory = module.exports =
+
+
+
+  ###*
+  Load one or more resumes from disk.
+
+  @param {Object} opts An options object with settings for the factory as well
+  as passthrough settings for FRESHResume or JRSResume. Structure:
+
+      {
+        format: 'FRESH',    // Format to open as. ('FRESH', 'JRS', null)
+        objectify: true,    // FRESH/JRSResume or raw JSON?
+        inner: {            // Passthru options for FRESH/JRSResume
+          sort: false
+        }
+      }
+
+  ###
+  load: ( sources, opts, emitter ) ->
+    sources.map( (src) ->
+      @loadOne( src, opts, emitter )
+    , @)
+
+
+  ###* Load a single resume from disk.  ###
+  loadOne: ( src, opts, emitter ) ->
+
+    toFormat = opts.format     # Can be null
+    objectify = opts.objectify
+
+    # Get the destination format. Can be 'fresh', 'jrs', or null/undefined.
+    toFormat && (toFormat = toFormat.toLowerCase().trim())
+
+    # Load and parse the resume JSON
+    info = _parse src, opts, emitter
+    return info if info.fluenterror
+
+    # Determine the resume format: FRESH or JRS
+    json = info.json
+    isFRESH = json.meta && json.meta.format && json.meta.format.startsWith('FRESH@');
+    orgFormat = if isFRESH then 'fresh' else 'jrs'
+
+    # Convert between formats if necessary
+    if toFormat and ( orgFormat != toFormat )
+      json = ResumeConverter[ 'to' + toFormat.toUpperCase() ]( json )
+
+    # Objectify the resume, that is, convert it from JSON to a FRESHResume
+    # or JRSResume object.
+    rez = null
+    if objectify
+      ResumeClass = require('../core/' + (toFormat || orgFormat) + '-resume');
+      rez = new ResumeClass().parseJSON( json, opts.inner );
+      rez.i().file = src;
+
+    file: src
+    json: info.json
+    rez: rez
+
+
+_parse = ( fileName, opts, eve ) ->
+
+  rawData = null
+  try
+
+    # Read the file
+    eve && eve.stat( HME.beforeRead, { file: fileName });
+    rawData = FS.readFileSync( fileName, 'utf8' );
+    eve && eve.stat( HME.afterRead, { file: fileName, data: rawData });
+
+    # Parse the file
+    eve && eve.stat HME.beforeParse, { data: rawData }
+    ret = { json: JSON.parse( rawData ) }
+    orgFormat =
+      if ret.json.meta && ret.json.meta.format && ret.json.meta.format.startsWith('FRESH@')
+      then 'fresh' else 'jrs'
+
+    eve && eve.stat HME.afterParse, { file: fileName, data: ret.json, fmt: orgFormat }
+    return ret
+  catch
+    # Can be ENOENT, EACCES, SyntaxError, etc.
+    ex =
+      fluenterror: if rawData then HACKMYSTATUS.parseError else HACKMYSTATUS.readError
+      inner: _error
+      raw: rawData
+      file: fileName
+      shouldExit: false
+    opts.quit && (ex.quit = true)
+    eve && eve.err ex.fluenterror, ex
+    throw ex if opts.throw
+    ex

src/core/resume.json

@@ -0,0 +1,380 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Resume Schema",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "basics": {
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string",
+          "description": "e.g. Web Developer"
+        },
+        "picture": {
+          "type": "string",
+          "description": "URL (as per RFC 3986) to a picture in JPEG or PNG format"
+        },
+        "email": {
+          "type": "string",
+          "description": "e.g. thomas@gmail.com",
+          "format": "email"
+        },
+        "phone": {
+          "type": "string",
+          "description": "Phone numbers are stored as strings so use any format you like, e.g. 712-117-2923"
+        },
+        "website": {
+          "type": "string",
+          "description": "URL (as per RFC 3986) to your website, e.g. personal homepage",
+          "format": "uri"
+        },
+        "summary": {
+          "type": "string",
+          "description": "Write a short 2-3 sentence biography about yourself"
+        },
+        "location": {
+          "type": "object",
+          "additionalProperties": true,
+          "properties": {
+            "address": {
+              "type": "string",
+              "description": "To add multiple address lines, use \n. For example, 1234 Glücklichkeit Straße\nHinterhaus 5. Etage li."
+            },
+            "postalCode": {
+              "type": "string"
+            },
+            "city": {
+              "type": "string"
+            },
+            "countryCode": {
+              "type": "string",
+              "description": "code as per ISO-3166-1 ALPHA-2, e.g. US, AU, IN"
+            },
+            "region": {
+              "type": "string",
+              "description": "The general region where you live. Can be a US state, or a province, for instance."
+            }
+          }
+        },
+        "profiles": {
+          "type": "array",
+          "description": "Specify any number of social networks that you participate in",
+          "additionalItems": false,
+          "items": {
+            "type": "object",
+            "additionalProperties": true,
+            "properties": {
+              "network": {
+                "type": "string",
+                "description": "e.g. Facebook or Twitter"
+              },
+              "username": {
+                "type": "string",
+                "description": "e.g. neutralthoughts"
+              },
+              "url": {
+                "type": "string",
+                "description": "e.g. http://twitter.com/neutralthoughts"
+              }
+            }
+          }
+        }
+      }
+    },
+    "work": {
+      "type": "array",
+      "additionalItems": false,
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+      "properties": {
+          "company": {
+            "type": "string",
+            "description": "e.g. Facebook"
+          },
+          "position": {
+            "type": "string",
+            "description": "e.g. Software Engineer"
+          },
+          "website": {
+            "type": "string",
+            "description": "e.g. http://facebook.com",
+            "format": "uri"
+          },
+          "startDate": {
+            "type": "string",
+            "description": "resume.json uses the ISO 8601 date standard e.g. 2014-06-29",
+            "format": "date"
+          },
+          "endDate": {
+            "type": "string",
+            "description": "e.g. 2012-06-29",
+            "format": "date"
+          },
+          "summary": {
+            "type": "string",
+            "description": "Give an overview of your responsibilities at the company"
+          },
+          "highlights": {
+            "type": "array",
+            "description": "Specify multiple accomplishments",
+            "additionalItems": false,
+            "items": {
+              "type": "string",
+              "description": "e.g. Increased profits by 20% from 2011-2012 through viral advertising"
+            }
+          }
+        }
+
+      }
+    },
+    "volunteer": {
+      "type": "array",
+      "additionalItems": false,
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+      "properties": {
+          "organization": {
+            "type": "string",
+            "description": "e.g. Facebook"
+          },
+          "position": {
+            "type": "string",
+            "description": "e.g. Software Engineer"
+          },
+          "website": {
+            "type": "string",
+            "description": "e.g. http://facebook.com",
+            "format": "uri"
+          },
+          "startDate": {
+            "type": "string",
+            "description": "resume.json uses the ISO 8601 date standard e.g. 2014-06-29",
+            "format": "date"
+          },
+          "endDate": {
+            "type": "string",
+            "description": "e.g. 2012-06-29",
+            "format": "date"
+          },
+          "summary": {
+            "type": "string",
+            "description": "Give an overview of your responsibilities at the company"
+          },
+          "highlights": {
+            "type": "array",
+            "description": "Specify multiple accomplishments",
+            "additionalItems": false,
+            "items": {
+              "type": "string",
+              "description": "e.g. Increased profits by 20% from 2011-2012 through viral advertising"
+            }
+          }
+        }
+
+      }
+    },
+    "education": {
+      "type": "array",
+      "additionalItems": false,
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+      "properties": {
+            "institution": {
+              "type": "string",
+              "description": "e.g. Massachusetts Institute of Technology"
+            },
+            "area": {
+              "type": "string",
+              "description": "e.g. Arts"
+            },
+            "studyType": {
+              "type": "string",
+              "description": "e.g. Bachelor"
+            },
+            "startDate": {
+              "type": "string",
+              "description": "e.g. 2014-06-29",
+              "format": "date"
+            },
+            "endDate": {
+              "type": "string",
+              "description": "e.g. 2012-06-29",
+              "format": "date"
+            },
+            "gpa": {
+              "type": "string",
+              "description": "grade point average, e.g. 3.67/4.0"
+            },
+            "courses": {
+              "type": "array",
+              "description": "List notable courses/subjects",
+              "additionalItems": false,
+              "items": {
+                "type": "string",
+                "description": "e.g. H1302 - Introduction to American history"
+              }
+            }
+          }
+
+
+      }
+    },
+    "awards": {
+      "type": "array",
+      "description": "Specify any awards you have received throughout your professional career",
+      "additionalItems": false,
+      "items": {
+          "type": "object",
+          "additionalProperties": true,
+        "properties": {
+            "title": {
+              "type": "string",
+              "description": "e.g. One of the 100 greatest minds of the century"
+            },
+            "date": {
+              "type": "string",
+              "description": "e.g. 1989-06-12",
+              "format": "date"
+            },
+            "awarder": {
+              "type": "string",
+              "description": "e.g. Time Magazine"
+            },
+            "summary": {
+              "type": "string",
+              "description": "e.g. Received for my work with Quantum Physics"
+            }
+        }
+      }
+    },
+    "publications": {
+      "type": "array",
+      "description": "Specify your publications through your career",
+      "additionalItems": false,
+      "items": {
+          "type": "object",
+          "additionalProperties": true,
+        "properties": {
+            "name": {
+              "type": "string",
+              "description": "e.g. The World Wide Web"
+            },
+            "publisher": {
+              "type": "string",
+              "description": "e.g. IEEE, Computer Magazine"
+            },
+            "releaseDate": {
+              "type": "string",
+              "description": "e.g. 1990-08-01"
+            },
+            "website": {
+              "type": "string",
+              "description": "e.g. http://www.computer.org/csdl/mags/co/1996/10/rx069-abs.html"
+            },
+            "summary": {
+              "type": "string",
+              "description": "Short summary of publication. e.g. Discussion of the World Wide Web, HTTP, HTML."
+            }
+          }
+      }
+    },
+    "skills": {
+      "type": "array",
+      "description": "List out your professional skill-set",
+      "additionalItems": false,
+      "items": {
+          "type": "object",
+          "additionalProperties": true,
+        "properties": {
+            "name": {
+              "type": "string",
+              "description": "e.g. Web Development"
+            },
+            "level": {
+              "type": "string",
+              "description": "e.g. Master"
+            },
+            "keywords": {
+              "type": "array",
+              "description": "List some keywords pertaining to this skill",
+              "additionalItems": false,
+              "items": {
+                "type": "string",
+                "description": "e.g. HTML"
+              }
+            }
+        }
+      }
+    },
+    "languages": {
+      "type": "array",
+      "description": "List any other languages you speak",
+      "additionalItems": false,
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "language": {
+            "type": "string",
+            "description": "e.g. English, Spanish"
+          },
+          "fluency": {
+            "type": "string",
+            "description": "e.g. Fluent, Beginner"
+          }
+        }
+      }
+    },
+    "interests": {
+      "type": "array",
+      "additionalItems": false,
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+      "properties": {
+          "name": {
+            "type": "string",
+            "description": "e.g. Philosophy"
+          },
+          "keywords": {
+            "type": "array",
+            "additionalItems": false,
+            "items": {
+              "type": "string",
+              "description": "e.g. Friedrich Nietzsche"
+            }
+          }
+        }
+
+      }
+    },
+    "references": {
+      "type": "array",
+      "description": "List references you have received",
+      "additionalItems": false,
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+      "properties": {
+          "name": {
+            "type": "string",
+            "description": "e.g. Timothy Cook"
+          },
+          "reference": {
+            "type": "string",
+            "description": "e.g. Joe blogs was a great employee, who turned up to work at least once a week. He exceeded my expectations when it came to doing nothing."
+          }
+        }
+
+      }
+    }
+  }
+}

src/core/status-codes.coffee

@@ -0,0 +1,33 @@
+###*
+Status codes for HackMyResume.
+@module core/status-codes
+@license MIT. See LICENSE.MD for details.
+###
+
+
+module.exports =
+  success: 0
+  themeNotFound: 1
+  copyCss: 2
+  resumeNotFound: 3
+  missingCommand: 4
+  invalidCommand: 5
+  resumeNotFoundAlt: 6
+  inputOutputParity: 7
+  createNameMissing: 8
+  pdfgeneration: 9
+  missingPackageJSON: 10
+  invalid: 11
+  invalidFormat: 12
+  notOnPath: 13
+  readError: 14
+  parseError: 15
+  fileSaveError: 16
+  generateError: 17
+  invalidHelperUse: 18
+  mixedMerge: 19
+  invokeTemplate: 20
+  compileTemplate: 21
+  themeLoad: 22
+  invalidParamCount: 23
+  missingParam: 24