Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

pajv

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

pajv

A command line JSON Schema validator that supports many file formats. Fork of jessedc/ajv-cli.

  • 1.2.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

Polyglottal JSON Schema Validator (Polyglottal Ajv)

Command line interface for ajv that utilizes any-json to provide validation against many data formats. pajv can validate: CSON, Hjson, JSON, JSON5, TOML, and YAML files using JSON Schema. pajv is a fork of ajv-cli.

Build Status npm version Code Climate Coverage Status

Contents

Installation

npm install -g pajv

Help

pajv help
pajv help validate
pajv help test

Validate data

This command validates data files against JSON-schema

pajv validate -s test/schema.json -d test/valid_data.json
pajv -s test/schema.json -d test/valid_data.json

You can omit validate command name.

Parameters
-s - file name of JSON-schema

Only one schema can be passed in this parameter

-d - JSON data

Multiple data files can be passed, as in -r parameter:

pajv -s test/schema.json -d "test/valid*.json"

If some file is invalid exit code will be 1.

-r - referenced schemas

The schema in -s parameter can reference any of these schemas with $ref keyword.

Multiple schemas can be passed both by using this parameter mupltiple times and with glob patterns. Glob pattern should be quoted and extensions cannot be omitted.

-m - meta-schemas

Schemas can use any of these schemas as a meta-schema (that is the schema used in $schema keyword - it is used to validate the schema itself).

Multiple meta-schemas can be passed, as in -r parameter.

-c - custom keywords/formats definitions

You can pass module(s) that define custom keywords/formats. The modules should export a function that accepts Ajv instance as a parameter. The file name should start with ".", it will be resolved relative to the current folder. The package name can also be passed - it will be used in require as is.

For example, you can use -c ajv-keywords to add all keywords from ajv-keywords package or -c ajv-keywords/keywords/typeof to add only typeof keyword.

Options
  • --errors=: error reporting format. Possible values:

    • js (default): JavaScript object
    • json: JSON with indentation and line-breaks
    • line: JSON without indentaion/line-breaks (for easy parsing)
    • text: human readable error messages with data paths
  • --changes=: detect changes in data after validation.
    Data can be modifyed with Ajv options --remove-additional, --use-defaults and --coerce-types).
    The changes are reported in JSON-patch format (RFC6902).
    Possible values are js (default), json and line (see --errors option).

Test validation result

This command asserts that the result of the validation is as expected.

pajv test -s test/schema.json -d test/valid_data.json --valid
pajv test -s test/schema.json -d test/invalid_data.json --invalid

If the option --valid (--invalid) is used for the test to pass (exit code 0) the data file(s) should be valid (invalid).

This command supports the same options and parameters as validate with the exception of --changes.

Ajv options

You can pass the following Ajv options:

OptionDescription
--datause $data references
--all-errorscollect all errors
--unknown-formats=handling of unknown formats
--verboseinclude schema and data in errors
--json-pointersreport data paths in errors using JSON-pointers
--unique-items=falsedo not validate uniqueItems keyword
--unicode=falsecount unicode pairs as 2 characters
--format=fullformat mode
--schema-id=keyword(s) to use as schema ID
--extend-refs=validation of other keywords when $ref is present in the schema
--missing-refs=handle missing referenced schemas (true/ignore/fail)
--inline-refs=referenced schemas compilation mode (true/false/<number>)
--remove-additionalremove additional properties (true/all/failing)
--use-defaultsreplace missing properties/items with the values from default keyword
--coerce-typeschange type of data to match type keyword
--multiple-of-precisionprecision of multipleOf, pass integer number
--error-data-path=propertydata path in errors
--messages=falsedo not include text messages in errors

Options can be passed in either dash-case and camelCase.

See Ajv Options for more information.

Version History

See https://github.com/json-schema-everywhere/pajv/releases

Licence

MIT

Keywords

FAQs

Package last updated on 18 Aug 2017

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
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc