gha

gulp-html-angular-validate

html-angular-validate linter plugin for Gulp

Showing:

Popularity

Downloads/wk

144

GitHub Stars

2

Maintenance

Last Commit

5yrs ago

Contributors

3

Package

Dependencies

3

Size (min+gzip)

295.0KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

gulp-html-angular-validate

html-angular-validate linter plugin for Gulp.

Thanks to Nik Estep for html-angular-validate and creating the initial Gulp recipe

Installation

npm install --save-dev gulp-html-angular-validate 

Options

Uses all the default html-angular-validate options, but one has been added here to allow for custom log output if desired.

Custom Gulp Options

Name: emitError Type: boolean Default: false Description: Set this to true if you want the gulp task to emit an error when validation failure occur.

Name: errorInCallback Type: boolean Default: false Description: Set this to true if you want the gulp task's callback to return a message saying there were validation failures.

Name: reportFn Type: function Default: null Description: An optional function that takes an array of file failure objects. See below for usage. An example array of file failure objects might look like this:

[
    {
        "msg": "Start tag seen without seeing a doctype first. Expected e.g. '<!DOCTYPE html>'.",
        "line": 1,
        "col": 5
    },{
        "msg": "Element 'head' is missing a required instance of child element 'title'.",
        "line": 2,
        "col": 9
    }, {
        "msg": "Unclosed element 'div'.",
        "line": 53,
        "col": 12
    }
]

Usage

var gulp = require('gulp');
var validate = require('gulp-html-angular-validate');
var gutil = require('gulp-util');

gulp.task('html-lint', function () {
  var options = {
    customattrs: ['*'],
    customtags: ['*'],
    emitError: true,
    reportFn:function(fileFailures){
        for (var i = 0; i < fileFailures.length; i++) {
            var fileResult = fileFailures[i];
            gutil.log(fileResult.filepath);
            for (var j = 0; j < fileResult.errors.length; j++) {
                var err = fileResult.errors[j];
                if (err.line !== undefined) {
                    gutil.log('[line' +err.line +', col: ' + err.col +'] ' +err.msg);
                } else {
                    gutil.log(err.msg);
                }
            }
        }
    }
  };
  gulp.src('htmlGlob')
    .pipe(validate(options));
})

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial