README.md

The translation files checker and syncing tool

---

Table of contents

• « Main README
• « Documentation table of contents
• Validators
  • Checking base and translation files
• Available checks
  • Syntax check
  • Brackets
  • DanglingKeys
  • EmptyTranslations
  • FormattingValues
  • KeyFormat
  • MissingTranslations
  • Punctuation
  • QuotationMarks
  • StartsWithTheSameCase
  • Substitutions
  • TrailingWhiteChars
  • TypesettingQuotationMarks
  • WhiteCharsBeforeLinefeed

---

Validators

The main purpose of trans-tool is to ensure all property files are correct and that translation files are in sync with the reference file. For that reason, you need to have at least two *.properties files to use trans-tool. One is your base language (usually English texts) used as a reference, and all the others are your translations. trans-tool performs several checks on both the base (reference) file and each translation.

Checking Base and Translation Files

Some validators can perform their work with just a single file to process. In such cases, you can use them to check both your base file and translation files. Those validators that need a base file reference (i.e., DanglingKeys) can only be used to validate translations.