Templaid

Declarative filesystem based template rendering with handlebars.js.

Install

yarn add templaid

Example

Given the following template folder hierarchy:

path/to/template
└─ {{project.name}}
   ├─ {{project.name}}.md
   ├─ file001.txt
   └─ assets
      ├─ {{project.name}}.ae
      └─ {{project.name}}.psd

Will render the following hierarchy:

path/to/destination
└─ MyProjectName
   ├─ MyProjectName.md
   ├─ file001.txt
   └─ assets
      ├─ MyProjectName.ae
      └─ MyProjectName.psd

With this code:

renderTemplate({
  templatePath: 'path/to/template',
  destinationPath: 'path/to/destination',
  data: {
    project: {
      name: 'MyProjectName'
    }
  }
})

Template files

Files suffixed with .template will be treated as templates. For example, if a markdown file named {{project.name}}Readme.md.template with the following content:

### {{project.name}} : {{project.version}}

{{project.description}}

With the data:

{
  "name": "MyProjectName",
  "version": "1.0.0",
  "description": "A description of the project."
}

Will create a file named MyProjectNameReadme.md with its contents being:

### MyProject : 1.0.0

A description of the project.

Todo

• Document all features ( partials, macros )
• Cover more use cases in tests