Skip to content

Commit

Permalink
first working version
Browse files Browse the repository at this point in the history
  • Loading branch information
Bartvds committed Jun 13, 2013
1 parent 4b07797 commit 22e8a25
Show file tree
Hide file tree
Showing 9 changed files with 218 additions and 3 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
node_modules
npm-debug.log
tmp

/.idea
14 changes: 14 additions & 0 deletions .jshintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"curly": true,
"eqeqeq": true,
"immed": true,
"latedef": true,
"newcap": true,
"noarg": true,
"sub": true,
"undef": true,
"boss": true,
"eqnull": true,
"node": true,
"es5": true
}
48 changes: 48 additions & 0 deletions Gruntfile.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/*
* grunt-tv4
* https://github.com/Bartvds/grunt-tv4
*
* Copyright (c) 2013 Bart van der Schoor
* Licensed under the MIT license.
*/

'use strict';

module.exports = function (grunt) {

grunt.initConfig({
jshint: {
all: [
'Gruntfile.js',
'tasks/*.js',
'<%= nodeunit.tests %>'
],
options: {
jshintrc: '.jshintrc'
}
},
tv4: {
base: {
options: {
},
files: {
'test/fixtures/object_props/schema.json': ['test/fixtures/object_props/pass.json', 'test/fixtures/object_props/fail.json']
}
}
},
// Unit tests.
nodeunit: {
tests: ['test/*_test.js']
}
});

grunt.loadTasks('tasks');

grunt.loadNpmTasks('grunt-contrib-jshint');
grunt.loadNpmTasks('grunt-contrib-nodeunit');

grunt.registerTask('test', ['tv4', 'nodeunit']);

grunt.registerTask('default', ['jshint', 'test']);

};
22 changes: 22 additions & 0 deletions LICENSE-MIT
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Copyright (c) 2013 Bart van der Schoor

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
68 changes: 65 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,66 @@
grunt-tv4
=========
# grunt-tv4

Use json-schema draft v04 to validate json values in tv4
> Use tv4 to validate files against v4 json-schema
## Getting Started
This plugin requires Grunt `~0.4.1`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-tv4 --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-tv4');
```

## The "tv4" task

### Usage Examples

#### Default Options

```js
grunt.initConfig({
tv4: {
//specify single schema's and multiple data to validate against it
files: {
'schema/map_format.json': ['data/map_*.json', 'extra/map_*.json'],
'schema/lib_format.json': ['data/lib_*.json']
}
}
})
```

#### Custom Options
In this example, custom options are used to do something else with whatever else. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result in this case would be `Testing: 1 2 3 !!!`

```js
grunt.initConfig({
tv4: {
options: {
//register extra schemes by url
schemas: {
'http://example.com/schema/v1': {
'type': 'object'
//.. schema object
}
'http://example.com/schema/v2': grunt.file.readJSON('schema/v2.json')
}
}
files: {
'schema/map_format.json': ['data/map_*.json', 'extra/map_*.json'],
'schema/lib_format.json': ['data/lib_*.json']
}
}
})
```

## Contributing
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](http://gruntjs.com/).

## Release History
_(Nothing yet)_
46 changes: 46 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"name": "grunt-tv4",
"description": "Use tv4 to validate files against v4 json-schema",
"version": "0.1.0",
"homepage": "https://github.com/Bartvds/grunt-tv4",
"author": {
"name": "Bart van der Schoor",
"email": "bartvanderschoor@gmail.com",
"url": "https://github.com/Bartvds"
},
"repository": {
"type": "git",
"url": "https://github.com/Bartvds/grunt-tv4"
},
"bugs": {
"url": "https://github.com/Bartvds/grunt-tv4/issues"
},
"licenses": [
{
"type": "MIT",
"url": "https://github.com/Bartvds/grunt-tv4/blob/master/LICENSE-MIT"
}
],
"main": "Gruntfile.js",
"engines": {
"node": ">= 0.8.0"
},
"scripts": {
"test": "grunt test"
},
"devDependencies": {
"grunt-contrib-jshint": "~0.1.1",
"grunt-contrib-clean": "~0.4.0",
"grunt-contrib-nodeunit": "~0.1.2",
"grunt": "~0.4.1"
},
"peerDependencies": {
"grunt": "~0.4.1"
},
"keywords": [
"gruntplugin"
],
"dependencies": {
"tv4": "~1.0.3"
}
}
4 changes: 4 additions & 0 deletions test/fixtures/object_props/fail.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"intKey": 3,
"stringKey": false
}
4 changes: 4 additions & 0 deletions test/fixtures/object_props/pass.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"intKey": 1,
"stringKey": "one"
}
10 changes: 10 additions & 0 deletions test/fixtures/object_props/schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"properties": {
"intKey": {
"type": "integer"
},
"stringKey": {
"type": "string"
}
}
}

0 comments on commit 22e8a25

Please sign in to comment.