No description or website provided.
Clone or download
Latest commit 6f32fa4 Oct 3, 2018

README.md

gulp-htmlhint NPM version Build Status Dependency Status

htmlhint wrapper for gulp to validate your HTML

Usage

First, install gulp-htmlhint as a development dependency:

npm install --save-dev gulp-htmlhint

Then, add it to your gulpfile.js:

var htmlhint = require("gulp-htmlhint");

gulp.src("./src/*.html")
	.pipe(htmlhint())

API

htmlhint([options [, customRules]])

options

See all rules here: https://github.com/HTMLHint/HTMLHint/wiki/Rules

If options is empty, task use standard options.

options.htmlhintrc

Type: String Default value: null

If this filename is specified, options and globals defined there will be used. Task and target options override the options within the htmlhintrc file. The htmlhintrc file must be valid JSON and looks something like this:

{
  "tag-pair": true,
}
var htmlhint = require("gulp-htmlhint");

gulp.src("./src/*.html")
	.pipe(htmlhint('.htmlhintrc'))

customRules

Type: Array Optional Default value: null

Array that contains all user defined custom rules. Adding a custom rule with this param doesn't require to add it's id in the htmlhintrc file. All defined custom rules inside this array should be a valid object and looks like this:

{
		id: 'my-custom-rule',
		description: 'Custom rule definition',
		init: function(parser, reporter){
				//Code goes here
		}
}

Here is an example:

var htmlhint = require("gulp-htmlhint");

var customRules = [];
customRules.push({
		id: 'my-custom-rule',
		description: 'Custom rule definition',
		init: function(parser, reporter){
				//Code goes here
		}
});

gulp.src("./src/*.html")
	.pipe(htmlhint('.htmlhintrc', customRules))

Note: You can call htmlhint function with 4 ways:

  • Without params (task use standard options).
  • With options param alone.
  • With customRules param alone (task will only use custom rules options).
  • With options and customRules params defined.

Reporters

Default reporter

var htmlhint = require("gulp-htmlhint");

gulp.src("./src/*.html")
	.pipe(htmlhint())
	.pipe(htmlhint.reporter())

Fail reporter

failOnError

Use this reporter if you want your task to fail in case of a HTMLHint Error (fails on first file). It also prints a summary of all errors in the first bad file.

var htmlhint = require("gulp-htmlhint");

gulp.src("./src/*.html")
	.pipe(htmlhint())
	.pipe(htmlhint.failOnError())

failAfterError

Use this reporter if you want your task to fail in case of a HTMLHint Error (collects statistics from all files and then fails). It also prints a summary of all errors in the first bad file.

var htmlhint = require("gulp-htmlhint");

gulp.src("./src/*.html")
	.pipe(htmlhint())
	.pipe(htmlhint.failAfterError())

Optionally, you can pass the a config object (works for both fail reporters)

Plugin options:

  • suppress

    When set to true, it does not display file errors on failure. Use in conjunction with the default and/or custom reporter(s). Prevents duplication of error messages when used along with another reporter.

    var htmlhint = require("gulp-htmlhint");
    
    gulp.src("./src/*.html")
        .pipe(htmlhint())
        .pipe(htmlhint.reporter("htmlhint-stylish"))
        .pipe(htmlhint.failOnError({ suppress: true }))

Third party reporter

gulp-reporter used in team project, it fails only when error belongs to the current author of git.

License

MIT License