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

requirejs-mustache-loader

v1.0.5

Published

Load Mustache templates dynamically, compile during build and auto resolve partials

Downloads

121

Readme

requirejs-mustache-loader

Load Mustache templates dynamically, compile during build and auto resolve partials

The biggest itch while working with Mustache (and many other front-end template engines) is the need to statically declare partials when rendering a template. Adding a partial in some template requires that you also import it to your JavaScript module and declare it as a partial.

With this plugin for RequireJS none of that is necessary, instead, this is possible:

{{! index.mustache }}
Hello {{> ./name.mustache }}!
{{! name.mustache }}
<strong>{{ name }}</strong>
// app.js
define(['template!index.mustache'], template => {
  template({ name: 'brave new world' }); // -> "Hello <strong>brave new world</strong>!"
});

Installation

The package can be installed via npm and Bower.

$ npm install --save requirejs-mustache-loader
$ bower install requirejs-mustache-loader

Resolving file names

For resolving file paths, a method called resolve, can be supplied using require.config. The resolve method is called when transforming partial names as defined in templates to a file path.

require.config({
  packages: [{
    name: 'template',
    location: 'node_modules/requirejs-mustache-loader',
    main: 'index'
  }, {
    name: 'mustache',
    location: 'node_modules/mustache',
    main: 'mustache'
  }, {
    name: 'text',
    location: 'node_modules/text',
    main: 'text'
  }],

  paths: {
    templates: 'path/to/templates'
  },

  mustache: {
    resolve: function (name) {
      return 'templates/' + name + '.mustache';
    }
  }
});

Member properties

Apart from just the render method, also the bare template string and all partials are exposed to the template function.

require(['template!index.mustache'], function (template) {
  template.text; // Hello {{> ./name.mustache }}!
  template.partials; // { './name.mustache': '<strong>{{ name }}</strong>' }
  template({ name: 'world' }); // Hello world!
});

Regarding peer dependencies

This plugin depends on the RequireJS text plugin available under the text namespace and mustache available under the mustache namespace. I.e. this should resolve just fine:

require(['text', 'mustache']);

License

MIT