A tool to spider a website and check for any broken links resources load errors or script errors
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-spider --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-spider');
In your project's Gruntfile, add a section named spider
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
spider: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
Type: String
Default value: 'http://localhost'
A url on which to start the spider.
Type: String
Default value: ''
A string that will be used to create a regex for excluding urls from being spidered.
Type: Boolean
Default value: true
Check for script errors
Type: Boolean
Default value: true
Check for resource load errors
Type: Boolean
Default value: true
Check for dead links
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({
spider: {
options: {},
files: {
'dest/default_options': ['src/testing', 'src/123'],
},
},
});
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({
spider: {
options: {
separator: ': ',
punctuation: ' !!!',
},
files: {
'dest/default_options': ['src/testing', 'src/123'],
},
},
});
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)