chki18nYour translation files, checked

Twenty-five checks over every i18n JSON layout, run from the command line, in CI, or from your own code. JavaScript, Dart and Python.

Get started

What it checks

API

Twenty-five checks, one report

Missing keys, empty values, strings nobody translated, interpolation that does not match, invisible characters, terminology that drifted between two screens. Every comparison check reports at a severity you can override.

What it checks

Every layout you already use

One file per locale, one folder per locale, or a single file holding them all. Files that share keys are compared as a group, so errors.json is never confused with common.json.

File layouts

Three languages, one library

JavaScript, Dart and Python packages that run the same checks in the same order and print the same report, character for character. Pick the one your project already speaks.

Getting started

The CLI and the API are one thing

Every command-line flag is an API option and the other way round, resolved from a single definition. What passes in CI passes in your build script.

Options

Results you can render

Every issue carries its level, its key, its locale and a sentence describing it, so a dashboard or a translation editor can show a result without hard-coding a single string.

The result object

Runs where your app runs

The comparison engine reaches no file system and is published on its own, so it bundles for a browser, a Flutter web build or a sandbox with no disk.

The core entry point

What it looks like

Point it at a folder and name the language everything is compared against:

bash

npx chki18n ./locales --target en

bash

dart pub global activate chki18n
chki18n ./locales --target en

bash

pip install chki18n
chki18n ./locales --target en

text

  Path     ./locales
  Target   en
  Locales  en, ko
  Layout   single, 1 group, 10 keys

 ko ──────────────────────────────────────────────────────────────────────── 1 error · 1 warning

  ERROR  NO_KEY (1)
         The key exists in the target language but is missing here.
    attr.folder  en: "Folder"

  WARN   NOT_TRANSLATED_VALUE (1)
         The value is identical to the target language, so the translation may be incomplete.
    desc.no-str  en: "12345"

 Summary ───────────────────────────────────────────────────────────────────────────────────────

  Compared 10 keys across 2 locales in 1 group. (3ms)
  1 error · 1 warning
  Clean: en

  FAIL  1 error must be fixed before this passes.

It exits with 1 when an error level issue was found, so a CI job fails on it. Every package prints that report to the column, whichever one you install.

The same run from code returns an object instead of a page of text:

javascript

import { checkTranslationFiles } from 'chki18n';

const result = await checkTranslationFiles('./locales', { target: 'en' });

result.success; // false
result.summary; // { error: 1, warn: 1, info: 0, total: 2, byCode: {…}, byLocale: {…} }
result.issues[0];
// {
//   code: 'NO_KEY',
//   level: 'error',
//   locale: 'ko',
//   key: 'attr.folder',
//   group: '',
//   targetValue: 'Folder',
//   file: '/project/locales/ko.json',
//   message: 'The key exists in the target language but is missing here.'
// }

dart

import 'package:chki18n/chki18n.dart';

final result = await checkTranslationFiles(
  path: './locales',
  options: const Chki18nOptions(target: 'en'),
);

result.success; // false
result.summary.error; // 1
result.issues.first;
// Chki18nIssue(
//   code: Chki18nCheckCode.noKey,
//   level: Chki18nLevel.error,
//   locale: 'ko',
//   key: 'attr.folder',
//   group: '',
//   targetValue: 'Folder',
//   file: '/project/locales/ko.json',
//   message: 'The key exists in the target language but is missing here.',
// )

python

from chki18n import Options, check_translation_files

result = check_translation_files("./locales", Options(target="en"))

result.success  # False
result.summary.error  # 1
result.issues[0]
# Issue(
#     code="NO_KEY",
#     level="error",
#     locale="ko",
#     key="attr.folder",
#     group="",
#     target_value="Folder",
#     file="/project/locales/ko.json",
#     message="The key exists in the target language but is missing here.",
# )

Installing it is one page, Getting started. What each check looks for is on Checks, and every option is on Options.

chki18nYour translation files, checked

Twenty-five checks, one report

Every layout you already use

Three languages, one library

The CLI and the API are one thing

Results you can render

Runs where your app runs

What it looks like ​

What it looks like