Skip to content

A CoffeeScript/JavaScript DSL for defining, documenting and validating JSON structures.

License

Notifications You must be signed in to change notification settings

intellinote/json-spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

For a demonstration, run:

coffee example/spec.coffee > example/spec.json

to generate a JSON representation of the example specification from the CoffeeScript-based DSL.

coffee lib/json-spec.coffee validate example/spec.json example/invalid-data.json

to validate a (invalid) JSON data file against that specification.

coffee lib/json-spec.coffee validate example/spec.json example/valid-data.json

to validate a (valid) JSON data file against that specification.

coffee lib/json-spec.coffee to-markdown example/spec.json > example/spec.md

to generate a Markdown document describing the specifcation.

coffee lib/json-spec.coffee to-markdown example/spec.json | marked > example/spec.html

to generate an HTML representation of that Markdown document.

About

A CoffeeScript/JavaScript DSL for defining, documenting and validating JSON structures.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published