Skip to content
A lint tool for validating Siren (http://sirenspec.org).
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
example
test
.gitignore
.npmignore
.travis.yml
LICENSE
README.md
errors.js
package.json
validate.js
warnings.js

README.md

sirenlint

A lint tool for validating Siren (http://sirenspec.org).

Build Status

Usage

CLI

$ sirenlint <siren-file>

or

$ cat <siren-file> | sirenlint

Example

$ echo '{ "links": [ { "rel": ["edit"] } ] }' | sirenlint
{ "links": [ { "rel": ["edit"] } ] }


sirenlint: 2 problems were found

error: ["links",0], Link is missing `href` attribute
warning: ["links"], The main entity is missing a link with a `self` relation

Output

The sirenlint command will output the original input followed by a summary of errors and/or warnings.
The summary includes a stringified JSON array defining the JSON path of the associated error or warning and a readable description of the problem.

Library

var fs = require('fs');
var path = require('path');
var validate = require('sirenlint');

var FILENAME = path.join(__dirname, '..', 'example', 'test.json');

var subject = fs.readFileSync(FILENAME);

var results = validate(subject);

results.forEach(function(r) {
  if (r instanceof validate.ValidationWarning) {
    console.log('WARNING:', r);
  } else if (r instanceof validate.ValidationError) {
    console.log('ERROR:', r);
  }
});

Install

npm install sirenlint -g

License

MIT

You can’t perform that action at this time.