grunt-tpcheck

template check plugin

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:

npm install grunt-tpcheck --save-dev

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

grunt.loadNpmTasks('grunt-tpcheck');

The "tpcheck" task

Overview

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

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

Options

tpcheckinclude

Check the include path exists

1. rootPath Type: String Default value: ''
2. regular Type: String Default value: ''

tpcheckencoding

Check the file encoding

1. rules Type: Array Default value: ['utf-8']

tpchecknote

1. typeNote Type: string Default value: @type

Usage Examples

see Gruntfile.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.

Release History

(Nothing yet)