grunt-sniffy v0.3.0
grunt-sniffy
Create a Sniffy Object from a directory of imgs.
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-sniffy --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-sniffy');
The "sniffy" task
Overview
In your project's Gruntfile, add a section named sniffy
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
sniffy: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
Sniffy Options
options.search
Type: object
Default value:
REQUIRED Key Value pair of (id, encoded image);
options.tag
Type: String
Default value: 'img'
The tag of what Sniffy should sniff for.
options.attribute
Type: String
Default value: 'src'
The attribute Sniffy will alter.
options.objectName
Type: String
Default value: 'sniffyObject'
Variable name the sniffy object will be binded to.
SniffyHTML Options
options.output
Type: String
Default value: 'img.js'
Destination of the fully constructed Sniffy Object
Usage Examples
Default Options
grunt.initConfig({
sniffy: {
options: {
search: {
"#bg" : "blue.jpg",
"#copyA" : "darkgrey.png",
"#copyB" : "gold.png",
"#another" : "green.png"
}
},
test: {
src: ["test/imgs"],
dest: "test/output/img.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.