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

engines

v0.4.0

Published

Template engine library with fast, synchronous rendering, based on consolidate.

Downloads

1,381

Readme

engines

Template engine library with fast, synchronous rendering, based on consolidate.

Installation

$ npm install engines

Supported template engines

Engines with strikethroughs are not yet supported or need to be updated. Pull requests to update them are welcome.

NOTE: you must still install the engines you wish to use, add them to your package.json dependencies.

API

All templates supported by this library may be rendered using the signature (path[, context], callback) as shown below, which is the same signature that Assemble and express support, so any of these engines may be used within Assemble or express.

NOTE: All of the examples use engines.handlebars for the Handlebars template engine. Replace handlebars with whatever template engine you prefer. For example, use engines.hogan for hogan.js, engines.jade for jade, etc.

Run console.log(engines) for the full list of identifiers.

Examples:

var engines = require('engines');
engines.handlebars('templates/about.hbs', { title: 'About Us' }, function(err, html) {
  if (err) { throw err; }
  console.log(html);
});

Or without options / local variables:

var engines = require('engines');
engines.handlebars('templates/about.hbs', function(err, html) {
  if (err) { throw err; }
  console.log(html);
});

To dynamically pass the engine, use the subscript operator and a variable:

var engines = require('engines');
var name = 'handlebars';

engines[name]('templates/about.hbs', { title: 'About Us' }, function(err, html) {
  if (err) { throw err; }
  console.log(html);
});

Caching

To enable caching pass { cache: true }. Engines may use this option to cache things reading the file contents, like compiled Functions etc. Engines which do not support this may simply ignore it. All engines that engines implements I/O for will cache the file contents, as this is ideal for production environments.

var engines = require('engines');
engines.handlebars('templates/about.hbs', { title: 'About Us' }, function(err, html) {
  if (err) { throw err; }
  console.log(html);
});

Assemble v0.6.x example

Run npm install assemble/assemble#v0.6.0, then in your assemblefile.js, add the following:

var assemble = require('assemble');
var engines = require('..');

assemble.engine('hbs', engines.handlebars);

assemble.task('default', function() {
  assemble.src('docs/*.hbs')
    .pipe(assemble.dest('dist'));
});

Running tests

Install dev dependencies:

npm install -d && mocha

License

Copyright (c) 2014 Jon Schlinkert, contributors. Copyright (c) 2011 TJ Holowaychuk <[email protected]>

Released under the MIT license.