grunt-buddha-jameslin

jameslin's first grunt plugin

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 grunt-buddha-jameslin --save-dev

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

grunt.loadNpmTasks('grunt-buddha-jameslin');

The "buddha_jameslin" task

Overview

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

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

Options

options.who

Type: String Default value: buddha ###指定用佛祖还是神兽来保佑我们的代码永无bug

A string value that is used to do something with whatever.

options.commentSymbol

Type: String Default value: // ###文件中拼接佛祖或神兽使用的注释符 A string value that is used to do something else with whatever else.

Usage Examples

Default Options

在你指定的目录下的js文件都会加上佛祖或者神兽保佑的注释代码 grunt.initConfig({ buddha_jameslin: { options:{ who:"buddha", 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

2016-11-08   v0.0.1   init

License

Copyright (c) 2016 jameslin. Licensed under the MIT license.