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-dotpl

v0.2.2

Published

This is a grunt plugin of [dotpl-js](https://github.com/zzzhan/dotpl-js), which is a lite javacript template engine. Using this tool, you can combine template and json files to generate different views.

Downloads

11

Readme

grunt-dotpl

This is a grunt plugin of dotpl-js, which is a lite javacript template engine. Using this tool, you can combine template and json files to generate different views.One advanage is using it as your pages localization tool.

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-dotpl --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-dotpl');

The "dotpl" task

Overview

In your project's Gruntfile, add a section named dotpl to the data object passed into grunt.initConfig().

grunt.initConfig({
  dotpl: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.tpl

Type: String

A string value that is the path of the template file.

options.renderer

Type: Function

A function that is used to custom the data for generating view.It is optional.

Usage Example

In this example, the options are used to localize the home page to two language, english and chinese.Its will be generated in "tmp" folder. On the chinese options, there are two json files, the first "en-us.json" is using as default if the key unfound on the second "zh-cn.json".And there is a custom function "renderer", which will replace the key "foo" on template file with the custom string. You may run the example with this command:

grunt test
grunt.initConfig({
  dotpl: {
      options: {
        tpl:'test/tpl/index.tpl'
      },
      default_lang: {
        files: {
          'tmp/index.html': ['test/lang/en-us.json']
        }
      },
      zh_cn: {
        options:{
          renderer:function(k,v) {
            if(k==='foo') {
              v = 'This is replaced by custom option.';
            }
            return v;
          }
        },
        files: {
          'tmp/zh-cn/index.html': ['test/lang/en-us.json', 'test/lang/zh-cn.json']
        }
      }
    },
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)