gulp-tv4
Use Gulp and Tiny Validator (tv4) to validate files against json-schema draft v4.
Usage
Install Gulp globally and locally (read an explanation of why we need to do both here):
$ npm install gulp -g$ npm install gulp --save-dev
Install the plugin as follows:
$ npm install gulp-tv4 --save-dev
The plugin can then be enabled inside your Gulpfile:
var gulp = tv4 = ;
And can be used as follows:
gulp ;
Parameters
The plugin expects to be called with either the name of a file containing the schema against which all input files should be validated, or with an object containing the schema definition.
In other words, either of the following will work:
Pass the name of the schema file
gulp ;
Pass the schema definition as an object
var schema = "title": "User Schema" "type": "object" "properties": "username": "type": "string" "minLength": 10 "password": "type": "string" "minLength": 8 "maxLength": 12 "required": "username" "password" ;gulp ;
Reporting
Validation results are added onto each file object under the tv4 key, and contain the following elements:
- valid - Boolean
- error - object containing error details (if any)
- missing - array of missing schema(s) (if any)
So a more thorough example which checks the validation results might look like:
gulp ;
History
- 0.1.0 - First release
Todo
- Report validation errors in a clean and consistent manner.