This module is used by various dependents to render
tv4 validation result objects in a compact but highly readable (and possibly colourful) format. Functionality is tuned for both CLI output as well as plain-text or pre-formatted HTML/CSS.
Note: at this point this is not a 'validator' or 'test runner', nor is it a finished application. It is a library to use as dependency in
tv4 based testers. Use plain
tv4 and pass the result(s) to one of
tv4-reporters helpers. If you are looking for a validator see one of the implementing tv4 wrappers for convenience (some linked below).
$ npm install tv4-reporter --save-dev
Still very-much in flux so possibly outdated examples.
Minimal use case (likely this is spread over the implementing application):
// assemble the componentsvar tv4 = ;var out = ;var style = ;var reporter = ;// now validatevar result = tv4;if !resultvalid || resultmissinglength > 0// get data object (might get these in bulk/async from somewhere)var res = reporter;// report errorreporter;// if you have a many results you can use bulk to print nicely with summariesreporter;// only totalsreporter;
// if you have a many results you can use bulk to print nicely with summariesreporter;// only totalsreporter;
For more API surface like (partial) reporter and various helpers see the exports in the main module. Also see the 'known dependants' for more examples.
Report output and styling done via extensible mini-api's:
Nothing much here as the code is still being extracted from the original projects.
Install development dependencies in your git checkout:
$ npm install
Build and run tests:
Gruntfile.js for additional commands.
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
Note: this is an opinionated module: please create a ticket to discuss any big ideas. Pull requests for bug fixes are of course always welcome.
Copyright (c) 2013 Bart van der Schoor
Licensed under the MIT license.