grunt-html-2
v5.0.0
Published
Grunt plugin for html validation, using vnu.jar for the actual validation
Downloads
5
Readme
grunt-html
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-devThen 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.
wrapPath
Type: String
Default: null
Provide a path to wrap html partials for validation.
all: {
options: {
wrapPath: 'config/htmlValidationWrapper.html',
ignore: /(attribute|element)\s+“[a-z-]+-[a-z-]+”\s+not\s+allowed/i
},
src: "app.html"
}It will replace this tag specifically "". Here is an example of what you template should be like.
<!DOCTYPE html>
<html>
<head>
<title>Wrapper</title>
</head>
<body>
<!-- CONTENT -->
</body>
</html>License
Copyright Jörn Zaefferer.
Licensed under the MIT license.