https://github.com/cpselvis/stouts

A Javascript template engine.
https://github.com/cpselvis/stouts

Last synced: 25 days ago
JSON representation

A Javascript template engine.

• Host: GitHub
• URL: https://github.com/cpselvis/stouts
• Owner: cpselvis
• License: mit
• Created: 2016-05-15T03:00:00.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-07-11T12:52:09.000Z (over 8 years ago)
• Last Synced: 2024-09-14T01:24:20.790Z (about 2 months ago)
• Language: JavaScript
• Size: 24.4 KB
• Stars: 4
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Stouts

*A Javascript template engine by [@Elvis](//github.com/cpselvis)*

[![NPM version](https://img.shields.io/npm/v/stouts.svg?style=flat-square)](https://www.npmjs.com/package/stouts)

[![Build Status](https://travis-ci.org/cpselvis/stout.svg?branch=master)](https://travis-ci.org/cpselvis/stout)

[![Coverage Status](https://coveralls.io/repos/github/cpselvis/stouts/badge.svg?branch=master)](https://coveralls.io/github/cpselvis/stouts?branch=master)

Why I want to create this wheel? I get inspiration from peg.js which is a generator for parser.

But it seems complex to use because it's grammar isn't easy to understand, so I try to write a

parser use pure javascript code.

And I named it stouts, it's just a kind of beer. I love it's strong flavour and dark color.

## Install

You can get Stouts via npm.

```bash

$ npm install stouts --save

```

## Quick Example

Below is a quick example how to use stouts:

```js

var view = {

  names: [{

    name: 'Elvis'

  }, {

    name: 'Joe'

  }, {

    name: 'Tank'

  }], 

  age: 24

};

var output = Stout.render("Name are: {{#names}}{{name}},{{/names}} age is {{age}}", view);

```

## API

- Stouts.render(template, view)

- Stouts.parse(template);

## Syntax rules

- {{variable}}                 -> Raw value                 

- {{{variable}}}               -> Escape value              

- {{#names}}{{name}}{{/names}} -> Loop                      

## Testing

Install dependencies.

```bash

$ npm install

```

Then run the tests.

```bash

$ npm install stouts --save

```

## ES6 Project && Webpack Config

  Follow http://jamesknelson.com/using-es6-in-the-browser-with-babel-6-and-webpack/

  

## Mocha Test Case

  Follow http://jamesknelson.com/testing-in-es6-with-mocha-and-babel-6/

## Naming && Javascript ES6 Style

  Follow https://github.com/trwalker/javascript-es6-styleguide

  

  **File naming**: One Class per File, Only one class should be declared per file and the file name should match the class name. If the class is named "Car" then the file should be named "car.js".