Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Grunt plugin for html validation
JavaScript HTML PHP

5.0.0

latest commit a088bdd6fd
@jzaefferer authored

README.md

grunt-html

Linux Build Status Windows Build status Code Climate Dependency Status devDependency Status

Grunt plugin for html validation, using the vnu.jar markup checker.

Getting Started

Install this grunt plugin next to your project's Gruntfile.js with:

npm install grunt-html --save-dev

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

grunt.loadNpmTasks('grunt-html');

Then specify what files to validate in your config:

grunt.initConfig({
  htmllint: {
    all: ["demos/**/*.html", "tests/**/*.html"]
  }
});

For fast validation, keep that in a single group, as the validator initialization takes a few seconds.

Options

ignore

Type: Array, String, or RegExp
Default: null

Use this to specify the error message(s) to ignore. For example:

all: {
  options: {
    ignore: 'The “clear” attribute on the “br” element is obsolete. Use CSS instead.'
  },
  src: "html4.html"
}

The ignore option also supports regular expressions. For example, to ignore AngularJS directive attributes:

all: {
  options: {
    ignore: /attribute “ng-[a-z-]+” not allowed/
  },
  src: "app.html"
}

force

Type: Boolean
Default: false

Set force to true to report errors but not fail the grunt task.

reporter

Type: String
Default: null

Allows you to modify the output format. By default, this plugin will use a built-in Grunt reporter. Set the path to your own custom reporter or to one of the provided reporters: checkstyle or json.

reporterOutput

Type: String
Default: null

Specify a filepath to output the results of a reporter. If reporterOutput is specified then all output will be written to the given filepath rather than printed to stdout.

absoluteFilePathsForReporter

Type: Boolean
Default: false

Set absoluteFilePathsForReporter to true to use absolute file paths in generated reports.

License

Copyright Jörn Zaefferer.
Licensed under the MIT license.

Something went wrong with that request. Please try again.