Node.js utility for precompiling templates for use with YUI's Y.Template.
JavaScript
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
test
.gitignore
.travis.yml
LICENSE
README.md
gulpfile.js
package.json

README.md

YTemplater

Build Status Dependency Status

Node.js utility for precompiling templates for use with YUI's Y.Template.

Usage

var ytemplater = require('ytemplater');

ytemplater.precompile(files, options)

Precompiles the given files and concatenates the resulting JavaScript to a single file.

ytemplater.precompile(['my-template.handlebars', 'my-other-template.micro'], {
    out: 'build/',
    moduleName: 'my-templates'
}); // => Creates build/my-templates.js
  • files {String[]} array of paths to the templates to precompile. Template files should be named according to their template engine i.e. *.handlebars, *.micro.
  • options {Object} additional config.
    • out {String} file or directory to write the precompiled template JavaScript to. Defaults to process.cwd().
    • moduleName {String} name of the module that hosts these precompiled templates - used to determine the name of the JavaScript file to write to (unless options.out is a .js file). If not specified and options.out is omitted or a directory, ytemplater will write to a file called "templates.js".

Returns a Q promise that is resolved once the JavaScript file has been written (or rejected in the event of an error).

ytemplater.precompileShifterModule(shifterModuleDir)

Precompiles templates for a given shifter module. Parses the build.json for declared template module builds, precompiles the appropriate template files and writes the resulting JavaScript file(s) to the module's js directory (ready for shifter to build it).

ytemplater.precompileShifterModule('my-shifter-module/');
// => Parses my-shifter-module/build.json
// => Precompiles declared templates to .js files in my-shifter-module/js/
  • shifterModuleDir {String} path to a shifter module. The module's build.json should declare at least one template module build, see the build.json Reference below. Also see the Shifter Module Directory Structure section below for info on where to put the template files etc.

Returns a Q promise that is resolved once the JavaScript file(s) have been written (or rejected in the event of an error).

build.json Reference

YTemplater will look for a ytemplater section in the shifter module's build.json to determine what template modules to build. This section should contain one or more declared template modules (by module name) each containing a templateFiles array with the list of templates (paths to template files relative to the templates sub-directory of the shifter module dir) to precompile for that module.

For example:

{
  "name": "my-module",
  "builds": {
    "my-module": {
      "jsfiles": ["my-module.js"]
    },
    "my-module-templates": {
      "jsfiles": ["my-module-templates.js"]
    }
  },
  "ytemplater": {
    "my-module-templates": {
      "templateFiles": [
        "my-template-1.handlebars",
        "my-template-2.micro"
      ]
    }
  }
}

Note: ytemplater just precompiles the templates in place in the shifter module directory, you will either need to have a shifter build declared and shifter meta data for each template module or concatenate the resulting JavaScript files into an existing build (see the shifter docs for more info).

Shifter Module Directory Structure

When precompiling templates in a shifter module, YTemplater will look for templates inside the templates sub-directory and write the resulting JavaScript to the js sub-directory.

For example, the build.json Reference above expects the following directory structure in the shifter module directory:

my-module/
|-- js/
|   |-- my-module.js
|   `-- my-module-tempates.js (generated by ytemplater)
|
|-- templates/
|   |-- my-template-1.handlebars
|   `-- my-template-2.micro
|
|-- meta/
|   |-- my-module.json
|   `-- my-module-templates.json
|
`-- build.json

CLI

Install the ytemplater command:

$ npm install -g ytemplater
$ ytemplater --help

Usage:

 ytemplater [options] files...
 ytemplater --shifter dirs...


Options:
  -o, --out          File or directory to write the precompiled templates to
  -m, --module-name  Used to determine the name of the file to write to when specifying a directory for -o
  -s, --shifter      Find and precompile templates in the given shifter module directories; all other options are ignored
  -h, --help         Show this usage information

Default Mode

In this mode specify a list of files and optionally the -o or -m flag to determine where to write the precompiled JavaScript to. CLI equivalent of the precompile(files, options) API.

ytemplater templates/*.handlebars -o build/ -m "my-templates"
# => Creates build/my-templates.js

Shifter Mode

In this mode specify shifter module directories to have ytemplater build their declared templates into their js directories. In this mode other options (such as -o and -m) are ignored. CLI equivalent of the precompileShifterModule(shifterModuleDir) API.

ytemplater -s my-shifter-module/
# => Parses my-shifter-module/build.json
# => Precompiles declared templates to .js files in my-shifter-module/js/

Contributing

Building

YTemplater is built with gulp.js.

First, install the gulp CLI:

$ npm install -g gulp

Run gulp to lint, test and watch for changes:

$ gulp

Tests & Coverage

You can also run the tests and generate a test coverage report (using Istanbul) with:

$ npm test --coverage

License

Copyright (c) 2014 Orion Health MIT License (enclosed)