Grunt plugin for dom-prof. I mainly created this to do some profiling reports to stuff into Jenkins. That's why the CSV is so sparse. Feel free to contribute any other ideas on how to deal with the output.
This plugin requires Grunt ~0.4.4
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-dom-prof --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-dom-prof');
In your project's Gruntfile, add a section named dom_prof
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
dom_prof: {
options: {
// Task-specific options go here.
}
},
});
Type: String
The url of the site to profile.
Type: String
The report destination relative to the project root. If this is empty, then it will dump the results to the console.
Type: Boolean
Default value: false
Dump the results as the JSON object.
By default the file gets rendered out as a CSV.
grunt.initConfig({
dom_prof: {
options: {
url: 'http://www.google.com',
dest: 'reports/report.csv'
}
},
});
If you want the JSON, specify the raw: true
key/value pair.
grunt.initConfig({
dom_prof: {
options: {
url: 'http://www.google.com',
dest: 'reports/report.json',
raw: true
}
},
});
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.
(Nothing yet)