node package manager
It’s your turn. Help us improve JavaScript. Take the 2017 JavaScript Ecosystem Survey »

gulp-htmlhint

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)

See all rules here: https://github.com/yaniswang/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'))

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