grunt-templatizer

grunt task runner for templatizer

grunt-templatizer

templatizeris a lovely little utility by Henrik Jortegthat takes a template directory structure and produces a module containing your precompiled Jade templates.

grunt-templatizeris a Gruntplugin that reimplements templatizer.

Getting Started

This plugin requires Grunt ~0.4.1

If you haven't used Gruntbefore, be sure to check out the Getting Startedguide, as it explains how to create a Gruntfileas 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-templatizer --save-dev

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

grunt.loadNpmTasks('grunt-templatizer');

The "templatizer" task

Overview

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

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

Usage Examples

Default Options

In this example, the default options are used to do something with whatever. So if the testingfile has the content Testingand the 123file had the content 1 2 3, the generated result would be Testing, 1 2 3.

grunt.initConfig({
  templatizer: {
    files: {
      'dest/default_options': ['src/testing', 'src/123'],
    },
  },
})

Differences from templatizer

templatizertakes a specified template directory path and operates on the directory structure within that directory. grunt-templatizertakes the list of template files from the mask in your Gruntfile and and induces a directory structure based on the point at which the directory tree begins to branch. For example:

/templates/foo.jade
/templates/bar.jade

and

/templates/randomdir/foo.jade
/templates/randomdir/bar.jade

will both come out as

exports.foo = function anonymous(locals) {
...
exports.bar = function anonymous(locals) {
...

in your compile template module.

Whereas

/templates/randomdir/foo.jade
/templates/bar.jade

will become

exports.randomdir.foo = function anonymous(locals) {…
exports.bar = function anonymous(locals) {…

Also note that I've rewritten a significant portion of templatizer.jsto adapt it for Grunt, so crashes and bugs are probably my fault.

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.

HomePage

https://github.com/dlmanning/grunt-templatizer

Repository

https://github.com/dlmanning/grunt-templatizer


上一篇:grunt-tmod
下一篇:yuglify

相关推荐

官方社区

扫码加入 JavaScript 社区