grunt-z-schema
Grunt plugin for z-schema, a JSON Schema validator.
Getting Started
This plugin requires Grunt.
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-z-schema --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "zschema" task
Overview
In your project's Gruntfile, add a section named zschema
to the data object passed into grunt.initConfig()
.
grunt
Options
Options for strict validation. Any option defined here will be passed over to ZSchema instance.
Example:
zschema: options: noTypeless: true
Usage Examples
In this example, post1.json
and post2.json
are two JSON files that will be validated against the post-schema.json
schema. All JSON files in the comments
will be validated against the comment schema. All validations will also report unknown keywords.
grunt
If you don't have any actual JSON files but still need to validate the schema itself for syntactic and other errors:
grunt
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
Tests
npm test
The test will print out validation errors for the tasks designed to fail. That is expected behaviour. Unfortunately, Grunt does not really provide a good way to test that a task failed. If you come across a better solution please let me know.
Release History
See CHANGELOG.md
License
Copyright (c) 2014 Petr Bela. Licensed under the MIT license.