Grunt-js2html NPM

grunt-js2html

Grunt Plugin for Convert Angular JS Templates to HTML Source.

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:

Install using npm

npm install grunt-js2html --save-dev

Install using yarn

yarn add grunt-js2html

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

grunt.loadNpmTasks('grunt-js2html');

The "js2html" task

Overview

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

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

Options

options.angularModule

Type: Boolean Default value: false

A boolean value that is used to remove angular.module from tpl.js.

options.beautify

Type: Boolean Default value: true

A boolean value that is used to beautify HTML source file.

Usage Examples

Default Options

In this example, the default options are used to convert JS Templates files into source HTML without removing angular.module from tpl.js.

grunt.initConfig({
  js2html: {
    options: {},
    files: {
      src: 'test-files/*.js'
    },
  },
});

This simplest configuration will create HTML folder in your src path, and write the HTML source for the all tpl.js to test-files/html/*.html:

Custom Options

In this example, custom options are used to convert JS Templates files into source HTML which remove angular.module and html source will be formatted.

grunt.initConfig({
  js2html: {
    options: {
      angularModule: true,
      beautify: true,
    },
    files: {
      src: 'test-files/*.js'
    },
  },
});

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.