learninggruntplugin

learning to set up grunt plugin with video

Getting Started

This plugin requires Grunt.

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

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

grunt.loadNpmTasks('learninggruntplugin');

The "learninggruntplugin" task

Overview

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

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

Options

options.who

Type: String Default value: rabbit

A string value that is used to determine which we use to add as the header for js files.

options.commentSymbol

Type: String Default value: //

A string value that is used to determine which symbol is added between string picture.

Usage Examples

Default Options

grunt.initConfig({
  learninggruntplugin: {
    options: {
      'who': 'rabbit',
      'commentSymbol': '//' 
    },
    dist: ['examples/*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

2015-2-3     v0.0.1   init

License

Copyright (c) 2015 Sophia Yin. Licensed under the MIT license.