Socket
Socket
Sign inDemoInstall

sirenlint

Package Overview
Dependencies
1
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

sirenlint


Version published
Weekly downloads
246
decreased by-21.15%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

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

Keywords

FAQs

Last updated on 08 Feb 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc