README.md

swig

unmaintained

This library has not received regular service in some time. Until it receives regular upkeep, it is strongly recommended to instead:

1. Use template literals & string interpolation
   1. node.js modules + ECMAScript strings provide 90% of the value that template engines once offered, sans a handy CLI for file generation
2. If you're targeting templates for the browser, consider component-driven HTML generation, e.g. React.renderToString(<MyPage data={...} />). React, Solid, Vue, & other frameworks all have string generation facilities and more powerful options.
3. For remaining use cases, consider alternative node template engines (handlebars, mustache, etc).

Swig is an awesome, Django/Jinja-like template engine for node.js.

seeking maintainers

Paul Armstrong has stepped down as the primary swig maintainer. Swig is a phenominal project and a template engine that quitely, but strongly, stands tall against the others in a domain full of template engines. If you are interested in being a collaborator, check out the issues page, and let's discuss how to proceed. Don't forget to thank Paul and previous swig collabs for their hard and excellent work!

Features

• Available for node.js and major web browsers!
• Express compatible.
• Object-Oriented template inheritance.
• Apply filters and transformations to output in your templates.
• Automatically escapes all output for safe HTML rendering.
• Lots of iteration and conditionals supported.
• Robust without the bloat.
• Extendable and customizable. See Swig-Extras for some examples.
• Great code coverage.

Need Help? Have Questions? Comments?

• Mailing List/Google Group
• StackOverflow
• Migration Guide

Installation

npm install swig-templates

Documentation

All documentation can be viewed online on the Swig Website.

Basic Example

Template code

<h1>{{ pagename|title }}</h1>
<ul>
{% for author in authors %}
    <li{% if loop.first %} class="first"{% endif %}>{{ author }}</li>
{% endfor %}
</ul>

node.js code

var swig = require("swig-templates");
var template = swig.compileFile("/absolute/path/to/template.html");
var output = template({
  pagename: "awesome people",
  authors: ["Paul", "Jim", "Jane"],
});

Output

<h1>Awesome People</h1>
<ul>
  <li class="first">Paul</li>
  <li>Jim</li>
  <li>Jane</li>
</ul>

For working example see examples/basic

How it works

Swig reads template files and translates them into cached javascript functions. When we later render a template we call the evaluated function, passing a context object as an argument.

License

Copyright (c) 2010-2013 Paul Armstrong

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.