@techteamer/twigify

twigify

This is a fork of dane-harnett/twigify by TechTeamer.

twigify is a Browserify transform for creating modules of pre-compiled Twig.js templates.

Installation

With npm as a local development dependency:

npm install --save-dev @techteamer/twigify

Usage

In templates/test.twig:

<h1>{{ title }}</h1>

test.js:

const template = require('./templates/test.twig')
const body = template.render({
  title: 'Main Page'
})

document.body.innerHTML = body

Including sub templates:

templates/main.twig:

<h1>{{ title }}</h1>
{% include 'templates/body.twig' %}

main.js:

// need to require() this so that it is available for main.twig
const bodyTemplate = require('./templates/body.twig')
const mainTemplate = require('./templates/main.twig')

const page = mainTemplate.render({
  title: 'Main Page'
})

document.body.innerHTML = page

Include / extend / etc.

The ID of each template file is always the template file path (with extension) relative to the working directory, from which the build script was run!

Let's suppose we have the following directory structure:

/tmp/test-project/
├── build/
├── templates/
│   ├── main.twig
│   └── features/
│       ├── menu.twig
│       └── footer.twig
└── main.js

Our build is run in /tmp/test-project as follows:

user@pc:/tmp/test-project$ browserify main.js -t @techteamer/twigify > build/bundle.js

This means, that in templates/main.twig, we include templates/features/menu.twig and templates/features/footer.twig. Extend works the same way.

Another important thing is, that in order for this to work, every included / extended file must have been required at least once somewhere, otherwise browserify will not include it in the bundle.

Options

{
  "ext": "\\.(twig|html)$", // Register custom template extension
  "twigOptions": {
    // Add custom twig options here. This gets just passed on to twig.js,
    // so any valid twig.js option is also valid here.
    // The "id", "data" and "precompiled" options are always overwritten.
  }
}

Add custom options using package.json:

{
  "browserify": {
    "transform": [
      ["@techteamer/twigify", { /* Add custom options here */ }]    
    ]  
  }
}

Or using the browserify API:

browserify(file, {
  // browserify options
  transform: ['@techteamer/twigify', { /* Add custom options here */ }]
})

Transforming with the command-line

browserify test.js -t @techteamer/twigify > test-bundle.js

Run tests

npm run test