npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@techteamer/twigify

v0.0.4

Published

Browserify transform for pre-compiled Twig.js templates

Downloads

7

Readme

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