grunt-buddha-mater v0.0.1
grunt-buddha-mater
Buddha\'s grace illumintes code as sunshine
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-mater --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-buddha-mater');
The "buddha_mater" task
Overview
In your project's Gruntfile, add a section named buddha_mater
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
buddha_mater: {
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
指明是否佛祖还是神兽来保护我们的代码 A string value that is used to do something with whatever.
options.punctuation
Type: String
Default value: '.'
文件中拼接复制或神兽是使用的注释符 A string value that is used to do something else with whatever else.
Usage Examples
Default Options
In this example, the default options are used to do something with whatever. So if the testing
file has the content Testing
and the 123
file had the content 1 2 3
, the generated result would be Testing, 1 2 3.
grunt.initConfig({
buddha_mater: {
options: {
'who': 'buddha',
'commentSymbol': '//'
},
dist: ['examples/*.js']
},
})
Custom Options
In this example, custom options are used to do something else with whatever else. So if the testing
file has the content Testing
and the 123
file had the content 1 2 3
, the generated result in this case would be Testing: 1 2 3 !!!
grunt.initConfig({
buddha_mater: {
options: {
separator: ': ',
punctuation: ' !!!',
},
files: {
'dest/default_options': ['src/testing', 'src/123'],
},
},
})
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-12-8 v0.0.1 &nbdp;init
License
Copyright (c) 2016 materjiang. Licensed under the MIT license.
7 years ago