jms/twig-js

twig.js, flexible, secure, and high-performance templating engine for Javascript

1.0.4 2019-01-12 13:15 UTC

README

[Build Badge] Build Status [Scrutinizer Badge] Scrutinizer Code Quality

Twig.js is a PHP project that compiles Twig templates into executable Javascript for client-side execution. It is not to be confused with Twig.js, which is a pure Javascript implementation of the Twig templating language.

Twig Compatibility

Compatibility with vanilla PHP Twig is not yet at 100%. If you need your templates to work with both Twig.js and Twig, stick to the supported filters and functions described below.

Supported Filters

  • abs
  • batch
  • capitalize
  • default
  • e
  • escape
  • first
  • join
  • json_encode
  • keys
  • last
  • length
  • lower
  • merge
  • nl2br
  • raw
  • replace
  • reverse
  • title
  • trim
  • upper
  • url_encode

Supported Functions

  • block
  • include
  • max
  • min
  • random
  • range

Incompatibilities

The following is a list of functionality present in Twig that is not yet available in Twig.js. There are some really easy pickings in these lists for anybody hoping to make a contribution to the project.

Unsupported Filters

  • convert_encoding
  • date (See pull request #11)
  • date_modify
  • format
  • number_format
  • round
  • slice
  • sort
  • split
  • striptags

Unsupported Functions

  • attribute
  • constant
  • cycle
  • date (See pull request #11)
  • dump
  • parent
  • source
  • template_from_string

Testing

To run the tests, you'll need Composer, Node and NPM on your system.

$ make test

License

Twig.js is released under the Apache License, Version 2.0.