Internationalised error messages for Ajv JSON-Schema validator
Latest commit 2909401 May 8, 2018

README.md

ajv-i18n

Internationalised error messages for Ajv - currently the fastest JSON-Schema validator

Build Status npm Coverage Status Greenkeeper badge Gitter

Supported locales

locale language contributor draft-04 draft-06* draft-07**
๐Ÿ‡ฌ๐Ÿ‡ง en English โœ“ โœ“ โœ“
AR ar Arabic Mahmoud-Mardeni โœ“ โœ“ โœ“
๐Ÿ‡จ๐Ÿ‡ฟ cz Czech kiskovacs โœ“ โœ“ -
๐Ÿ‡ฉ๐Ÿ‡ช de German jmtoball โœ“ โœ“ -
๐Ÿ‡ช๐Ÿ‡ธ es Spanish jpablom โœ“ - -
๐Ÿ‡ซ๐Ÿ‡ท fr French monlouisj โœ“ โœ“ -
๐Ÿ‡ญ๐Ÿ‡บ hu Hungarian szilveszter9 โœ“ - -
๐Ÿ‡ฎ๐Ÿ‡น it Italian jasoniangreen
lucacorti
โœ“
ย 

โœ“

โœ“
๐Ÿ‡ฏ๐Ÿ‡ต ja Japanese gilgongo โœ“ - -
๐Ÿ‡ณ๐Ÿ‡ด nb Norwegian bokmรฅl mtramm โœ“ โœ“ -
๐Ÿ‡ณ๐Ÿ‡ฑ nl Dutch pimlie โœ“ โœ“ โœ“
๐Ÿ‡ต๐Ÿ‡ฑ pl Polish danielzurawski โœ“ - -
๐Ÿ‡ง๐Ÿ‡ท pt-BR Portuguรชs - Brasil marcosrava โœ“ - -
๐Ÿ‡ท๐Ÿ‡บ ru Russian โœ“ โœ“ โœ“
๐Ÿ‡ธ๐Ÿ‡ฐ sk Slovak kiskovacs โœ“ โœ“ -
๐Ÿ‡ธ๐Ÿ‡ช sv Swedish limmen โœ“ โœ“ -
๐Ÿ‡น๐Ÿ‡ญ th Thai encX โœ“ โœ“ โœ“
๐Ÿ‡จ๐Ÿ‡ณ zh Chinese jinzhubaofu
leuction
โœ“
ย 

โœ“

โœ“
๐Ÿ‡น๐Ÿ‡ผ zh-TW Chinese - Taiwan minipai โœ“ โœ“ โœ“

* added boolean schema, keywords const, contains, propertyNames

** added keywords if/then/else

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

Install

Using npm:

npm install ajv-i18n

Using bower:

bower install ajv-i18n
cd bower_components/ajv-i18n
npm install && npm run bundle-all

Usage

In node:

var Ajv = require('ajv'); // version >= 2.0.0
var localize = require('ajv-i18n');

// option `i18n` is required for this package to work
var ajv = Ajv({ allErrors: true });
var validate = ajv.compile(schema);
var 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 in browser (with browserify):

var localize_ru = require('ajv-i18n/localize/ru');

or

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

See Ajv docs for more information.

Tests

npm install
git submodule update --init
npm test

Contributing

Functions that localize error messages are generated using doT templates in messages and localize.jst template. Templates are precompiled so doT is not a run-time dependency.

npm run build - compiles functions to localize folder.

Contributors of locales

danielzurawski szilveszter9 jmtoball gilgongo jasoniangreen jpablom limmen jinzhubaofu mahmoud-mardeni monlouisj marcosrava mtramm Mahmoud-Mardeni leuction lucacorti minipai encX pimlie

License

MIT