Skip to content

Internationalised error messages for Ajv JSON-Schema validator

License

Notifications You must be signed in to change notification settings

NAM0007/ajv-i18n

Repository files navigation

ajv-i18n

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

Build Status npm version

Supported locales

locale language contributor
๐Ÿ‡ฌ๐Ÿ‡ง en English
๐Ÿ‡จ๐Ÿ‡ฟ cz Czech kiskovacs
๐Ÿ‡ฉ๐Ÿ‡ช de German jmtoball
๐Ÿ‡ช๐Ÿ‡ธ es Spanish jpablom
๐Ÿ‡ซ๐Ÿ‡ท fr French monlouisj
๐Ÿ‡ญ๐Ÿ‡บ hu Hungarian szilveszter9
๐Ÿ‡ฎ๐Ÿ‡น it Italian jasoniangreen
๐Ÿ‡ฏ๐Ÿ‡ต ja Japanese gilgongo
๐Ÿ‡ต๐Ÿ‡ฑ pl Polish danielzurawski
๐Ÿ‡ท๐Ÿ‡บ ru Russian
๐Ÿ‡ธ๐Ÿ‡ฐ sk Slovak kiskovacs
๐Ÿ‡ธ๐Ÿ‡ช sv Swedish limmen
๐Ÿ‡จ๐Ÿ‡ณ zh Chinese jinzhubaofu
Please contribute locales that you need to use if they are missing.

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.

License

MIT

About

Internationalised error messages for Ajv JSON-Schema validator

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 99.7%
  • Shell 0.3%