The grunt task for html-snapshots
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-html-snapshots --save-dev
The "html_snapshots" task
This is a simple grunt task that uses the html-snapshots library. In your project's Gruntfile, add a section named
html_snapshots to the data object passed into
A boolean value that is used to force the Gruntfile to continue, even if this task fails.
For details of task and target specific options, read the options section of html-snapshots
Default Options and Targets
In this example, the default options are used to specify that the output directory should always be cleaned prior to taking snapshots, that a local robots.txt file should be used, and the html should be served from localhost. On all pages except the home page, when the selector "#dynamic-content" appears in the output, the page is ready for a snapshot. On the home page, we only take the snapshot when the selector "#home-content" is visible in the output.
Many more options are available. For details and examples of using the html-snapshots options, visit html-snapshots.
In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.