1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
[](https://waffle.io/twigjs/twig.js)
[](https://snyk.io/test/github/twigjs/twig.js)
[](http://travis-ci.org/#!/twigjs/twig.js)
[](http://badge.fury.io/js/twig)
[](https://gitter.im/twigjs/twig.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
# About
Twig.js is a pure JavaScript implementation of the Twig PHP templating language
(<http://twig.sensiolabs.org/>)
The goal is to provide a library that is compatible with both browsers and server side JavaScript environments such as node.js.
Twig.js is currently a work in progress and supports a limited subset of the Twig templating language (with more coming).
### Docs
Documentation is available in the [twig.js wiki](https://github.com/twigjs/twig.js/wiki) on Github.
### Feature Support
For a list of supported tags/filters/functions/tests see the [Implementation Notes](https://github.com/twigjs/twig.js/wiki/Implementation-Notes) page on the wiki.
# Install
Download the latest twig.js release from github: https://github.com/twigjs/twig.js/releases or via NPM:
npm install twig --save
## Browser Usage
Include twig.js or twig.min.js in your page, then:
```js
var template = twig({
data: 'The {{ baked_good }} is a lie.'
});
console.log(
template.render({baked_good: 'cupcake'})
);
// outputs: "The cupcake is a lie."
```
## Node Usage (npm)
You can use twig in your app with
var Twig = require('twig'), // Twig module
twig = Twig.twig; // Render function
### Usage without Express
If you don't want to use Express, you can render a template with the following method:
```js
import Twig from 'twig';
Twig.renderFile('./path/to/someFile.twig', {foo:'bar'}, (err, html) => {
html; // compiled string
});
```
### Usage with Express
Twig is compatible with express 2 and 3. You can create an express app using the twig.js templating language by setting the view engine to twig.
### app.js
**Express 3**
```js
var Twig = require("twig"),
express = require('express'),
app = express();
// This section is optional and used to configure twig.
app.set("twig options", {
strict_variables: false
});
app.get('/', function(req, res){
res.render('index.twig', {
message : "Hello World"
});
});
app.listen(9999);
```
## views/index.twig
```html
Message of the moment: <b>{{ message }}</b>
```
An [Express 2 Example](https://github.com/twigjs/twig.js/wiki/Express-2) is available on the wiki.
# Contributing
If you have a change you want to make to twig.js, feel free to fork this repository and submit a pull request on Github. The source files are located in src/*.js.
twig.js is built by running `npm run build`
For more details on getting setup, see the [contributing page](https://github.com/twigjs/twig.js/wiki/Contributing) on the wiki.
## Tests
The twig.js tests are written in [Mocha][mocha] and can be invoked with `npm test`.
## License
Twig.js is available under a [BSD 2-Clause License][bsd-2], see the LICENSE file for more information.
## Acknowledgments
See the LICENSES.md file for copies of the referenced licenses.
1. The JavaScript Array fills in src/twig.fills.js are from <https://developer.mozilla.org/> and are available under the [MIT License][mit] or are [public domain][mdn-license].
2. The Date.format function in src/twig.lib.js is from <http://jpaq.org/> and used under a [MIT license][mit-jpaq].
3. The sprintf implementation in src/twig.lib.js used for the format filter is from <http://www.diveintojavascript.com/projects/javascript-sprintf> and used under a [BSD 3-Clause License][bsd-3].
4. The strip_tags implementation in src/twig.lib.js used for the striptags filter is from <http://phpjs.org/functions/strip_tags> and used under and [MIT License][mit-phpjs].
[mit-jpaq]: http://jpaq.org/license/
[mit-phpjs]: http://phpjs.org/pages/license/#MIT
[mit]: http://www.opensource.org/licenses/mit-license.php
[mdn-license]: https://developer.mozilla.org/Project:Copyrights
[bsd-2]: http://www.opensource.org/licenses/BSD-2-Clause
[bsd-3]: http://www.opensource.org/licenses/BSD-3-Clause
[cc-by-sa-2.5]: http://creativecommons.org/licenses/by-sa/2.5/ "Creative Commons Attribution-ShareAlike 2.5 License"
[mocha]: http://visionmedia.github.com/mocha/
[qunit]: http://docs.jquery.com/QUnit
|
