grunt-emberjs-handlebars-sanity

Sanity tests for Handlebars templates within an EmberJS project.

Getting Started

This plugin requires Grunt ~0.4.2

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-emberjs-handlebars-sanity --save-dev

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

grunt.loadNpmTasks('grunt-emberjs-handlebars-sanity');

What does it test?

Right now it's just a framework for adding more tests. Currently it checks all templates (as specified in src) for instances of the following:

• <div class="small-icon" {{bind-attr class="modeIconClass"}}></div> - Two identical attribute bindings. One of these bindings will be ignored. The correct approach is <div {{bind-attr class=":small-icon modeIconClass"}}></div>.
• <!-- {{binding}} --> - Binding within an HTML comment. The binding will be created but will not exist in the DOM, causing errors. The correct approach is {{!-- {{binding}} --}}.

Because a running EmberJS application uses compiled templates rather than source, these tests have to occur on the source files themselves.

The "emberjs_handlebars_sanity" task

Overview

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

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

Options

• ignoreFailure: if true, then sanity checks will not cause the task to fail (false by default)

Usage Examples

grunt.initConfig({
  emberjs_handlebars_sanity: {
    test: {
      src: [
        '<%= yeoman.app %>/templates/{,*/}*.hbs'
      ]
    },
  },
});

and then later:

grunt.registerTask('test', [
  'emberjs_handlebars_sanity:test',
  'clean:server',
  // ...
]);

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 by grunt test - modify Gruntfile.js, test/*.js, test/fixtures/*and test/expected/* as necessary.

Release History

(Nothing yet)