# ajv-i18n

Internationalised error messages for Ajv (opens new window) - superfast JSON validator for JSON Schema and JSON Type Definition.

(opens new window) (opens new window) (opens new window) (opens new window)

# Supported locales

locale	language	contributor	draft-04	draft-06¹	draft-07²	draft 2019-09³ /2020-12⁴	JTD⁵
🇬🇧 en	English		✓	✓	✓	✓	✓
AR ar	Arabic	Mahmoud-Mardeni (opens new window)	✓	✓	✓	-	-
CA ca	Catalan	alexandreec (opens new window)	✓	✓	✓	-	*
🇨🇿 cs	Czech	kiskovacs (opens new window) NAM0007 (opens new window)	✓	✓	✓	-	*
🇩🇪 de	German	jmtoball (opens new window) gflohr (opens new window)	✓	✓	✓	✓	✓
🇪🇸 es	Spanish	jpablom (opens new window)	✓	✓	✓	-	*
🇫🇮 fi	Finnish	saulipurhonen (opens new window)	✓	✓	✓	✓	✓
🇫🇷 fr	French	monlouisj (opens new window) Telokis (opens new window)	✓	✓	✓	-	*
🇭🇺 hu	Hungarian	szilveszter9 (opens new window)	✓	-	-	-	*
🇮🇩 id	Indonesian	ekoeryanto (opens new window)	✓	✓	✓	-	*
🇮🇹 it	Italian	jasoniangreen (opens new window) lucacorti (opens new window)	✓	✓	✓	✓	✓
🇯🇵 ja	Japanese	gilgongo (opens new window)	✓	-	-	-	*
🇰🇷 ko	Korean	MinByeongDon (opens new window)	✓	✓	✓	✓	✓
🇳🇴 nb	Norwegian bokmål	mtramm (opens new window)	✓	✓	-	-	*
🇳🇱 nl	Dutch	pimlie (opens new window) niekvb (opens new window)	✓	✓	✓	✓	✓
🇵🇱 pl	Polish	danielzurawski (opens new window)	✓	-	-	-	*
🇧🇷 pt-BR	Português - Brasil	marcosrava (opens new window) ggondim (opens new window)	✓	✓	✓	✓	✓
🇷🇺 ru	Russian		✓	✓	✓	✓	✓
🇸🇰 sk	Slovak	kiskovacs (opens new window)	✓	✓	-	-	*
🇸🇪 sv	Swedish	limmen (opens new window)	✓	✓	-	-	*
🇹🇭 th	Thai	encX (opens new window)	✓	✓	✓	✓	✓
🇨🇳 zh	Chinese	jinzhubaofu (opens new window) leuction (opens new window)	✓	✓	✓	✓	✓
🇹🇼 zh-TW	Chinese - Taiwan	minipai (opens new window)	✓	✓	✓	✓	✓

¹ added boolean schema, keywords const, contains, propertyNames

² added keywords if/then/else

³ added messages for keywords unevaluatedProperties, unevaluatedItems, dependentRequired

⁴ keyword items messages

⁵ JSON Type Definition

* discriminator form messages are not translated

Please contribute locales that you need to use if they are missing or incomplete.

# Install

Using npm:

npm install ajv-i18n

# Usage

In node:

const Ajv = require("ajv") // version >= 8.0.0
const localize = require("ajv-i18n")
// or for JSON Type Definition
// const localize = require("ajv-i18n/localize/jtd")

const ajv = Ajv({allErrors: true, messages: false})
const validate = ajv.compile(schema)
const valid = validate(data)

if (!valid) {
  // ru for Russian
  localize.ru(validate.errors)
  // string with all errors and data paths
  console.log(ajv.errorsText(validate.errors, {separator: '\n'}))
}

To require only necessary locales (e.g., with browserify):

const localize_ru = require('ajv-i18n/localize/ru')
// or for JSON Type Definition
// const localize_ru = require('ajv-i18n/localize/ru/jtd')

const localize = {
  en: require('ajv-i18n/localize/en'),
  ru: require('ajv-i18n/localize/ru'),
}

See Ajv docs (opens new window) for more information.

# Tests

npm install
git submodule update --init
npm test

# Contributing

Functions that localize error messages are generated using doT template localize.jst (opens new window), JSON Schema messages (opens new window) and JSON Type Definition messages (opens new window). Templates are pre-compiled, so doT is not a run-time dependency.

npm run build - compiles functions to localize (opens new window) folder.

# Contributors of locales

# Enterprise support

ajv-i18n package is a part of Tidelift enterprise subscription (opens new window) - it provides a centralised commercial support to open-source software users, in addition to the support provided by software maintainers.

# Security contact

To report a security vulnerability, please use the Tidelift security contact (opens new window). Tidelift will coordinate the fix and disclosure. Please do NOT report security vulnerability via GitHub issues.

# License

MIT (opens new window)

← ajv-errors ajv-cli →