https://github.com/atlassian/better-ajv-errors

JSON Schema validation for Human 👨‍🎤
https://github.com/atlassian/better-ajv-errors

ajv json-schema

Last synced: 22 days ago
JSON representation

JSON Schema validation for Human 👨‍🎤

• Host: GitHub
• URL: https://github.com/atlassian/better-ajv-errors
• Owner: atlassian
• License: other
• Created: 2017-11-02T04:39:31.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-09-27T03:18:07.000Z (about 1 month ago)
• Last Synced: 2024-10-08T16:59:59.940Z (26 days ago)
• Topics: ajv, json-schema
• Language: JavaScript
• Homepage: https://atlassian.github.io/better-ajv-errors/
• Size: 1.57 MB
• Stars: 233
• Watchers: 7
• Forks: 45
• Open Issues: 48
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  




> JSON Schema validation for Human 👨‍🎤

Main goal of this library is to provide relevant error messages like the following:



  



## Installation

```bash

$ npm i better-ajv-errors

$ # Or

$ yarn add better-ajv-errors

```

Also make sure that you installed [ajv](https://www.npmjs.com/package/ajv) package to validate data against JSON schemas.

## Usage

First, you need to validate your payload with `ajv`. If it's invalid then you can pass `validate.errors` object into `better-ajv-errors`.

```js

import Ajv from 'ajv';

import betterAjvErrors from 'better-ajv-errors';

// const Ajv = require('ajv');

// const betterAjvErrors = require('better-ajv-errors').default;

// Or

// const { default: betterAjvErrors } = require('better-ajv-errors');

// You need to pass `{ jsonPointers: true }` for older versions of ajv

const ajv = new Ajv();

// Load schema and data

const schema = ...;

const data = ...;

const validate = ajv.compile(schema);

const valid = validate(data);

if (!valid) {

  const output = betterAjvErrors(schema, data, validate.errors);

  console.log(output);

}

```

## API

### betterAjvErrors(schema, data, errors, [options])

Returns formatted validation error to **print** in `console`. See [`options.format`](#format) for further details.

#### schema

Type: `Object`

The JSON Schema you used for validation with `ajv`

#### data

Type: `Object`

The JSON payload you validate against using `ajv`

#### errors

Type: `Array`

Array of [ajv validation errors](https://github.com/epoberezkin/ajv#validation-errors)

#### options

Type: `Object`

##### format

Type: `string`  

Default: `cli`  

Values: `cli` `js`

Use default `cli` output format if you want to **print** beautiful validation errors like following:



Or, use `js` if you are planning to use this with some API. Your output will look like following:

```javascript

[

  {

    start: { line: 6, column: 15, offset: 70 },

    end: { line: 6, column: 26, offset: 81 },

    error:

      '/content/0/type should be equal to one of the allowed values: panel, paragraph, ...',

    suggestion: 'Did you mean paragraph?',

  },

];

```

##### indent

Type: `number` `null`  

Default: `null`

If you have an unindented JSON payload and you want the error output indented.

This option have no effect when using the `json` option.

##### json

Type: `string` `null`  

Default: `null`

Raw JSON payload used when formatting codeframe.

Gives accurate line and column listings.