y-html-2-js v0.3.0

YReadHtmlToJs

read the html block to js string variable

Getting Started

This plugin requires Grunt ~0.4.1

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 YReadHtmlToJs --save-dev

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

grunt.loadNpmTasks('y-html-2-js');

The "YReadHtmlToJs" task

Overview

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

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

Options

options.url

Type: String Default value: ''

set the template HTML base location

options.separator

Type: String Default value: ;\n

Usage Examples

In javascrpt:

var HTML_TEMPLATE = '<%= YHTJ:/template/item.html:note %>'

In /template/item.html file:

when run y-html-2-js task , will find the block <%= YHTJ:xxxx:xx %> of javascript file, then will find the note block of /template/item.html file.

so will build like this:

var HTML_TEMPLATE = '<div class="note"><div class="title">{title}</div></div>'

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.

Release History

(Nothing yet)