FastApp

A html template engine design to create web apps.

 
 
 
 

Installation

npm install fastapp

Features

- Complies with the Express web rooter.
- Mark command tag using#{ code /}

Commands

The markup language is composed of tag of this form:

#{command first_Arg, second_Arg, ... /}

The available commands are:

- __set__: Assign the value of the expression(2) to the variable name(1).
- __get__: Replace this tag by the value of the expression(1).
- __get_if__: If the condition(1) is true, replace this tag by the value of the expression(2) else by the second expression(3).
- __include__: Insert the content of the file indicate by the value of the expression(1).
- __doLayout___: Insert the content of the child template.
- __extends___: Define the parent of this template (see extends).

``html
#{set title,'MyPage' /}
#{set menu,'home' /}
#{extends '/model.html' /}


#{include '/menu-' + menu + '.html' /}

Bienvenue sur #{get title/}

`

Usage

You can use this script of three different ways.
On command line:
> node lib/fastapp.js [html_file]

On your script:
`js
var fapp = require ('fastapp')
fapp.buildFile(path, null, function (err, data) {
//...
});
`

Using Express:
`js
var fapp = require('fastapp'),
express = require('express'),
app = express(),
option = { / ... / }

// What's on /dist folder is freely accessible
app.get('/dist', express.static(__dirname + '/dist'));
// For the rest, we use the engine
app.get('/views', fapp.lookAt(__dirname + '/views', option));

app.listen(80);
`




Options

- cache If true, will keep static page into memory.
- params Array of values accessible via params.name
- query Array of values accessible via params.query
- debug Output debug information
- open Open tag, defaulting to "#{
- close Closing tag, defaulting to "/}"
- directory Change of directory (default is ./views)




Extends

A real advantage about this template is to insert content of other pages.
You have two way of doing this, the extends and include commands.

The extends allow to define a parent. This is always the last executed command on the page.

Example

##### ./views/model.html
`html



...





...
#{include '/menu.html' /}


#{doLayout /}

`

##### ./views/index.html
`html
#{set title 'MyPage' /}
#{set menu, 'home' /}
#{extends '/models.html' /}


Welcome #{get_if query.user!=null, query.user, 'new visitor'}!

This is my page

`

##### ./views/menu.html
`html


• Home
  
• Portfolio
  
• About
  


`

##### RENDER (indentation corrected) /index.html?user=Fab
`html



...




...

• Home
  
• Portfolio
  
• About
  

Welcome Fab!

This is my page

``

License

This code is under the BSD 3-Clause license.

[1]: http://expressjs.com