https://github.com/dotnetcarpenter/validate-json

Simple cli to validate any JSON
https://github.com/dotnetcarpenter/validate-json

Last synced: about 2 months ago
JSON representation

Simple cli to validate any JSON

• Host: GitHub
• URL: https://github.com/dotnetcarpenter/validate-json
• Owner: dotnetCarpenter
• License: mit
• Created: 2016-12-12T02:21:07.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-04-14T04:29:55.000Z (over 4 years ago)
• Last Synced: 2024-04-26T17:21:45.163Z (8 months ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/valid-json-cli
• Size: 85 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
validjson

=========

[![Build Status Linux](https://travis-ci.org/dotnetCarpenter/validate-json.svg?branch=master)](https://travis-ci.org/dotnetCarpenter/validate-json)

[![Buld Status Windows](https://ci.appveyor.com/api/projects/status/mvp3262p1qwj2hlx/branch/master?svg=true)](https://ci.appveyor.com/project/dotnetCarpenter/validate-json/)

Simpel command line JSON validator with an API. Support nodejs >=7.0.0.

Tested to work in Windows PowerShell and *nix bash terminal.

### Installation ###

```

npm i -g valid-json-cli

```

### Usage ###

```

Usage:  validjson path [options]

        cat file.json | validjson [options]

        validjson [options] < file.json

Options:

      -s, --silent     no text output - will still exit with exitcode 0 or 1

      -v, --version    display version number and exit

      -h, --help       display this help and exit

```

Currently the only option which does something is `--silent`, which supresses error hint

on error. It does not matter if you set the option before or after the path if you

supply a file as parameter. Unknown parameters are ignored.

The difference between `validjson file.json` and `validjson < file.json` is that

in the former, nodejs fs is reading the file and

in the latter, your terminal (e.i. bash etc) is reading the file and streaming it to validjson.

![displays errors in color on the command line](img/Screenshot_from_version_1.1.1.png "Graphical error hint")

_Graphical error hint_

### API ###

`validjson({String} json, {Boolean} [silent]) : {Boolean} valid`

+ json - the input you want to validate as JSON

+ silent - an optional option to silent validjson on error - defaults to false

```js

"use strict"

// API: validjson({String} json, {Boolean} [silent]) : {Boolean} valid

const validjson = require("valid-json-cli")

const http = require("http")

const request = http.request({ hostname: "jsonip.com" }, response => {

    let json = ""

    response.setEncoding("utf8");

    response.on("data", (chunk) => {

        json += chunk

    })

    response.on("end", () => {

        console.log(`JSON data is ${validjson(json, true) ? "valid" : "invalid"}`)

        console.log(json)

    })

})

request.end()

```

Live example: https://runkit.com/585114841ca9e00014bc0cb4/585114841ca9e00014bc0cb5

### Installation and usage within a project ###

```

npm i --save valid-json-cli

yarn add valid-json-cli

```

_npm and yarn example_

In your `package.json` you can add:

```json

"scripts": {

    "validjson": "validjson",

    "json": "validjson < file.json && echo Good to go!"

},

```

Now you can use it via `npm run validjson` from outside npm e.i. Make.

```make

file.js : file1.json

    npm run validjson -- --silent $<

    # do something more

```

_Make example_

### License ###

The MIT License (MIT)

Copyright © 2016 Jon Ege Ronnenberg