grunt-link-checker

grunt-link-checker

Run node-simple-crawler to discover broken links on your website.

Getting Started

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, install this plugin with this command:

npm install grunt-link-checker --save-dev

Then add this line to your project's Gruntfile.js gruntfile:

grunt.loadNpmTasks('grunt-link-checker');

Documentation

grunt-link-checker will by default find any broken internal links on the given site and will also find broken fragment identifiers by using cheerio to ensure that an element exists with the given identifier. You can figure more options that are available via node-simplecrawler.

Minimal Usage

The minimal usage of grunt-link-checker runs with a site specified:

'link-checker': {
  dev: {
    site: 'example.com'
  }
}

Custom options

noFragment

Type: Boolean Default: false

Set this to true to speed up your test by not verfiying fragment identifiers.

simple-crawler options

Every option specified in the node-simplecrawler is available:

https://github.com/cgiffard/node-simplecrawler#configuring-the-crawler

Changelog

0.0.3 - Fixed repo link in package.json and fixed error reporting for a failed initial URL.

0.0.2 - Added noFragment flag.

0.0.1 - Check to make sure # URLs resolve to content with a corresponding id.

0.0.0 - Initial release