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

grunt-mustache-combine

v0.1.0

Published

Combine Mustache templates.

Downloads

102

Readme

grunt-mustache-combine Build Status

Combine Mustache templates into one file.

Getting Started

This plugin will combine all your Mustache templates into one file (object) and use the path of the file as the key. It won't pre-parse the file, because Mustache will do that on the first render.

Install

$ npm install --save-dev grunt-mustache-combine

Usage

require('load-grunt-tasks')(grunt); // npm install --save-dev load-grunt-tasks

grunt.initConfig({
  mustache_combine: {
    all: {
      files: 'js/templates.js': ['templates/**/*.mustache']
    }
  }
});

grunt.registerTask('default', ['mustache_combine']);

Examples

Custom config and rules

grunt.initConfig({
  mustache_combine: {
    options: {
      format: 'amd',
      extension: '.html',
      removeFromKey: 'path/to/'
    },
    all: {
      files: 'dist/templates.js': ['path/to/templates/**/*.html']
    }
  }
});

Options

options.format

Type: String
Default: 'es6'
Other possible values: 'commonjs', 'amd', 'es5'

The format to output.

options.extension

Type: String
Default: '.mustache'

The extension to remove from the key.

options.removeFromKey

Type: String
Default: ''

Part of the file path to remove from the key.

options.useLowerCaseKey

Type: Boolean
Default: true

Generate lower case keys. Set to false to ignore casing.

options.formatKey

Type: Function
Default: null

Function to generate a custom key. It overrules the removeFromKey and useLowerCaseKey options and receives the file path as a parameter.

grunt.initConfig({
  mustache_combine: {
    options: {
      formatKey: function(filepath) {
        return filepath
          .replace('path/to/templates/', 'tpl-')
          .toUpperCase();
      }
    },
    all: {
      files: 'js/template.js': ['path/to/templates/**/*.mustache']
    }
  }
});

Output example and usage

// Contents of the generated templates file (default ES6 format)
export default {"my/template": "<h1>hello {{name}}</h1>"};

// In your module.js
import Mustache from 'mustache';
import templates from './templates';

const tpl = templates['my/template'];

Mustache.render(tpl, {name: 'World'});

License

MIT © VI Company