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

engine-munger

v1.1.2

Published

A replacement Express view class that provides asynchronous resolution, internationalization and specialization support

Downloads

2,171

Readme

engine-munger

A replacement Express view class that provides asynchronous resolution, allows engines to use the lookup method to locate partials, and extends the lookup method to be configurable based on i18n locale and a template specialization rule map.

This is a backport of work for Express 5

Lead Maintainer: Aria Stewart

Build Status

What does i18n mean?

i18n means "internationalization". Given a locale property in the render options, engine-munger will look for content in a locale-specific directory (or in a fallback locale if that is not a match) for templates and partials. This is particularly useful with template engines that pre-localize their compiled forms, such as with localizr and dustjs-linkedin together.

What does specialization mean?

Ability to switch a specific template with another based on a rule set specified in the app config. The actual rule parsing is done using the module karka.

All engine-munger does is includes a specialization map with the list of key value pairs using the karka module.

{
    specialization : {
        'jekyll': [
            {
                is: 'hyde',
                when: {
                    'whoAmI': 'badGuy'
                }
            }
        ]
    }
}

The above will switch the template from jekyll to hyde if the render options contain "whoAmI": "badGuy". Rules can be as complex as you need for your application and are particularly good for running A/B tests.

Using engine-munger in an application

This example uses the adaro template engine, which wraps dust up as an express view engine, and uses engine-munger's more sophisticated lookup method to find partials, allowing them to be localized and specialized based on the render options.

var munger = require('engine-munger');
var adaro = require('adaro');
var app = require('express')();

var specialization = {
    'jekyll': [
        {
            is: 'hyde',
            when: {
                'whoAmI': 'badGuy'
            }
        }
    ]
};
app.set("view", munger({
    "dust": {
        specialization: specialization
    },
    "js": {
        specialization: specialization,
        i18n: {
            fallback: 'en-US',
            contentPath: 'locales'
        }
    }
});

var engineConfig = {}; // Configuration for your view engine

app.engine('dust', adaro.dust(engineConfig));
app.engine('js', adaro.js(engineConfig));

Running Tests:

npm test

To run coverage:

npm run cover