Skip to content
Modern, super fast, and configurable JS template engine that works without template literals
Branch: master
Clone or download
nebrelbug Merge pull request #111 from ffflorian/fix/remove-log
fix: Remove yarn error log from repository
Latest commit 77e977b May 2, 2019

README.md

squirrelly

Build Status Codacy BadgeJavaScript Style Guide Join the chat at https://gitter.im/squirrellyjs/Lobby Tip me at paypal.me/bengubler

Summary

Squirrelly is a modern, configurable, and blazing fast template engine implemented in JavaScript. It works out of the box with ExpressJS and weighs only 2.6KB gzipped.

Why Squirrelly?

Features:

  • Custom helpers
  • Custom filters
  • Conditionals
  • Loops
  • Custom delimeters
  • Precompilation
  • Partials
  • Writing JavaScript inside the template
  • Comments
  • Caching
  • Just look at the performance benchmarks here

Docs

We know nobody reads through the long and boring documentation in the ReadMe anyway, so head over to the documentation website:

https://squirrelly.js.org

Examples

Simple Template

var myTemplate = "<p>My favorite kind of cake is: {{favoriteCake}}</p>"
​
Sqrl.Render(myTemplate, {favoriteCake: 'Chocolate!'})
// Returns: '<p>My favorite kind of cake is: Chocolate!</p>

Conditionals

{{if(options.somevalue === 1)}}
Display this
{{#else}}
Display this
{{/if}}

Loops

{{each(options.somearray)}}
Display this
The current array element is {{@this}}
The current index is {{@index}}
{{/each}}

Tests

The default test can be run with npm test, and it just checks that compiling and rendering a simple template results in the correct string.

Contributing

We love contributions from the community! Contributions are accepted using GitHub pull requests; for more information, see GitHub documentation - Creating a pull request.

For a good pull request, we ask you provide the following:

  1. Include a clear description of your pull request in the description with the basic "what" and "why"s for the request.
  2. The test should pass.
  3. The pull request should include tests for the change. A new feature should have tests for the new feature and bug fixes should include a test that fails without the corresponding code change and passes after they are applied.
  4. If the pull request is a new feature, please include appropriate documentation in the README.md file as well.
  5. Keep a consistent coding style.

Contributors

This project exists thanks to all the people who contribute. [Contribute].

The top 7:

License

Squirrelly is licensed under the MIT license.

You can’t perform that action at this time.