# JS Template Literals Engine
a very basic, and straight to the point Template Engine using JS Template Literals
[![license][license-img]][license-url]
[![release][release-img]][release-url]
[![semantic][semantic-img]][semantic-url]
## Why
[Template Literals][] *(also known as "Template strings")* are a familiar and simple to use method to run embedded expressions and string interpolation, which are the primary functionality of a Template Engine.
This library wraps template literals with traditional techniques *(layouts, partials, helpers, etc ...)* to facilitates the usage through a structured file format (`.jstl`)
## What
Features:
- Layouts: native support for layouts
- Partials Support: include files and pass data with ease
- Fast: Templates are cached by default
- Extensible: extensible with custom helpers
## How
### Usage
###### `template.jstl`
``` text
hello ${data.name}
```
###### `index.js`
``` js
const Engine = require('@ahmadnassri/template-literals-engine')
const engine = new Engine(options)
engine.render('template', { name: 'ahmad' })
```
#### String Interpolation
since templates are parsed as standard JavaScript [Template Literals][] the same functionality is expected
Variables are accessible `data` context
Example
###### `index.js`
``` js
const Engine = require('@ahmadnassri/template-literals-engine')
const engine = new Engine()
const result = engine.render('template', { name: 'ahmad' })
console.log(result)
```
###### `template.jstl`
``` text
Hello ${data.name}
```
###### result
``` bash
$ node index.js
Hello ahmad
```
Example
###### `index.js`
``` js
const Engine = require('@ahmadnassri/template-literals-engine')
const engine = new Engine({
helpers: {
capitalize : str => string[0].toUpperCase() + string.slice(1)
}
})
const result = engine.render('template', { name: 'ahmad' })
console.log(result)
```
###### `template.jstl`
``` text
Hello ${fn.capitalize(data.name)}
```
###### result
``` bash
$ node index.js
Hello Ahmad
```
Example
###### `index.js`
``` js
const Engine = require('@ahmadnassri/template-literals-engine')
const engine = new Engine()
const actors = [
{ name: 'William Hartnell', year: '1963' },
{ name: 'Patrick Troughton', year: '1966' },
{ name: 'Jon Pertwee', year: '1970' },
{ name: 'Tom Baker', year: '1974' },
{ name: 'Peter Davison', year: '1981' },
{ name: 'Colin Baker', year: '1984' },
{ name: 'Sylvester McCoy', year: '1987' },
{ name: 'Paul McGann', year: '1996' },
{ name: 'Christopher Eccleston', year: '2005' },
{ name: 'David Tennant', year: '2005' },
{ name: 'Matt Smith', year: '2010' },
{ name: 'Peter Capaldi', year: '2013' },
{ name: 'Jodie Whittaker', year: '2017' }
]
const result = engine.render('page', { actors })
console.log(result)
```
###### `page.jstl`
``` text
${ fn.include('header') }
List of actors who have played the Doctor
${ fn.apply('doctor', data.actors) }
${ fn.include('footer') }
```
##### `doctor.jstl`
``` text
${data.name} - first appeared in ${data.year}
```
###### result
``` text
$ node index.js
List of actors who have played the Doctor
- William Hartnell - first appeared in 1963
- Patrick Troughton - first appeared in 1966
- Jon Pertwee - first appeared in 1970
- Tom Baker - first appeared in 1974
- Peter Davison - first appeared in 1981
- Colin Baker - first appeared in 1984
- Sylvester McCoy - first appeared in 1987
- Paul McGann - first appeared in 1996
- Christopher Eccleston - first appeared in 2005
- David Tennant - first appeared in 2005
- Matt Smith - first appeared in 2010
- Peter Capaldi - first appeared in 2013
- Jodie Whittaker - first appeared in 2017
```
Example
###### `index.js`
``` js
const Engine = require('@ahmadnassri/template-literals-engine')
const engine = new Engine()
const result = engine.render('template')
console.log(result)
```
###### `template.jstl`
``` text
---
name: ahmad
---
Hello ${data.name}
```
###### result
``` bash
$ node index.js
Hello ahmad
```
Example
###### `index.js`
``` js
const Engine = require('@ahmadnassri/template-literals-engine')
const engine = new Engine()
const result = engine.render('template', { name: 'ahmad' })
console.log(result)
```
###### `template.jstl`
``` text
---
layout: layouts/welcome
---
${data.name}
```
###### `layouts/welcome.jstl`
``` text
---
layout: layouts/base
---
Welcome!
${data.content}
```
###### `layouts/base.jstl`
``` text
${data.content}
```
###### result
``` text
$ node index.js
Welcome
ahmad
```