Generator.md

Generator specification

• Required properties:

  • template | templates -> Handlebars templates, {key: template} the key it's used to generate the file name.

• Optional properties:

  • parser(data) -> It transform the canonical data, it returns the context for handlebars templates, the return could be object or array.
  • helpers -> Handlebars helpers.
  • partials -> Handlebars partials.

##Simple definition:

var gen = {
  template: {'readme.md' : '{{title}}'}
}

##Multiple templates:

var gen = {
  templates: [{'readme.md' : '{{title}}'}, {'Main.java' : '{{title}}'}]
}

##Interpolating name: The key is also a handlebars template it will use the context to generate the final name.

var gen = {
  template: {'readme{{title}}.md' : '{{title}}'}
}

##Defining a parser: A parser could be used to modify or adapt the data, generally is used to reduce logic in the template.

var gen = {
  template: {'readme{{title}}.md' : '{{title}}'},
  parser: function(data){}
}

A parse could return and array, each element of the array will be passed to the template, this is useful to generate multiple files.

##Multiple templates using the same parser:

var gen = {
  templates: [{'readme{{title}}.md' : '{{title}}', {'{{className}}Resource.java' : '{{title}}'],
  parser: function(data){}
}

##Multiple templates each one using different parser:

var gen = {
   templates: [
      {
        '{{name}}Resource.java': {
          tmpl: 'hola {{title}}',
          parser: function () {
            return [{title: 'parse1', name: 'test'}]
          }
        }
      },
      {
        '{{name}}.md': {
          tmpl: 'readme {{title}}',
          parser: function () {
            return [{title: 'parse2', name: 'readme'}]
          }
        }
      }
    ]
}