karma-ng-html2js-preprocessor

A Karma plugin. Compile AngularJS templates to JavaScript on the fly.

karma-ng-html2js-preprocessor

Preprocessor for converting HTML files to AngularJS templates.

Note: If you are looking for a general preprocessor that is not tight to Angular, check out karma-html2js-preprocessor.

The easiest way is to keep karma-ng-html2js-preprocessor as a devDependency in your package.json.

{
  "devDependencies": {
    "karma": "~0.10",
    "karma-ng-html2js-preprocessor": "~0.1"
  }
}

You can simple do it by:

npm install karma-ng-html2js-preprocessor --save-dev
// karma.conf.js 
module.exports = function(config) {
  config.set({
    preprocessors: {
      '**/*.html': ['ng-html2js']
    },
 
    files: [
      '*.js',
      '*.html',
      '*.html.ext',
      // if you wanna load template files in nested directories, you must use this 
      '**/*.html'
    ],
 
    ngHtml2JsPreprocessor: {
      // strip this from the file path 
      stripPrefix: 'public/',
      stripSufix: '.ext',
      // prepend this to the 
      prependPrefix: 'served/',
 
      // or define a custom transform function 
      cacheIdFromPathfunction(filepath) {
        return cacheId;
      },
 
      // setting this option will create only a single module that contains templates 
      // from all the files, so you can load them all with module('foo') 
      moduleName: 'foo'
    }
  });
};

This preprocessor converts HTML files into JS strings and generates Angular modules. These modules, when loaded, puts these HTML files into the $templateCache and therefore Angular won't try to fetch them from the server.

For instance this template.html...

<div>something</div>

... will be served as template.html.js:

angular.module('template.html', []).config(function($templateCache) {
  $templateCache.put('template.html', '<div>something</div>');
});

See the ng-directive-testing for a complete example.


For more information on Karma see the homepage.