json-schema-umbrella v0.1.0-beta.4

Introduction

Analysis json-schema v4 and triggers warnings in the following case:

• unemployed required property
• required property without default.

![video][video-image] [video-image]: https://raw.githubusercontent.com/aminassian/json-schema-umbrella/master/img/module.gif

Installation

This package is available on npm as: json-schema-umbrella

$ npm install json-schema-umbrella -g
$ npm install json-schema-umbrella --save

Cli

$ json-schema-umbrella --help
$ json-schema-umbrella --version
$ json-schema-umbrella --schema path/to/your.schema.json
$ json-schema-umbrella --schema path/to/your.schema.json > result.json
$ json-schema-umbrella --pretty --schema path/to/your.schema.json
$ json-schema-umbrella --pretty --schema path/to/your.schema.json > result.json

Usage

readme.usage.schema

var umbrella = require('json-schema-umbrella');
var yourSchema = { //
    "properties": {
        "a" : {
            "type" : "string",
        }
    },
    "required" : [
        "b", // <=== "b" property not exist
        "a" // <=== "a" property exist but without 'default' property
    ]
}
var cautions = umbrella.analyse({"schema": yourSchema});

readme.usage.schema

{
    "analyse": [
        {
            "code": "UNEMPLOYED_REQUIRED",
            "message": "unemployed 'b' required",
            "path": "/required"
        },
        {
            "code": "MISSING_REQUIRED_DEFAULT",
            "message": "'a' required as no default",
            "path": "/required"
        }
    ],
    "licence": "GPL-3.0",
    "donate": [
        "https://pledgie.com/campaigns/27813",
        "https://gratipay.com/aminassian"
    ]
}

Test

To run the test suite, download the source code, install the dependencies and run npm test.

$ git clone https://github.com/aminassian/json-schema-umbrella.git
$ cd json-schema-umbrella
$ npm install
$ npm test

Coverage : http://aminassian.github.io/json-schema-umbrella/coverage/index.html

Made by

The original author of json-schema-umbrella is Alban Minassian.

If you like json-schema-umbrella and would like to support it, you are welcome to make a donation. It will surely be appreciated! Thanks!

License

GPL-3.0

Logo : umbrella from Font-Awesome (licence SIL OFL 1.1)

External libraries :

• underscore.js (licence)
• js-traverse (licence)
• Commander.js (licence)

Links

• www : http://aminassian.github.io/json-schema-umbrella
• www [fr] : http://aminassian.github.io/json-schema-umbrella/index.fr.html
• coverage : http://aminassian.github.io/json-schema-umbrella/coverage/index.html
• doc api : http://aminassian.github.io/json-schema-umbrella/api/index.html
• github : https://github.com/aminassian/json-schema-umbrella
• issues : https://github.com/aminassian/json-schema-umbrella/issues
• npm : https://www.npmjs.com/package/json-schema-umbrella
• pledgie : https://pledgie.com/campaigns/27813 [donate]
• gratipay : https://gratipay.com/aminassian [donate]

Release Notes

• 0.1.0-beta.4 (2015/01/11):
  • init This is the first beta public of json-schema-umbrella

Copyright © 2015 - Proudly Made In Nantes [![nantestech][nantestech-image]][nantestech-url] [nantestech-image]: https://raw.githubusercontent.com/aminassian/json-schema-umbrella/master/img/NANTES-TECH-LOGO-NOIR-HOR.png [nantestech-url]: http://www.nantestech.com