Skip to content

Localization.md

Latest commit

 

History

History
73 lines (44 loc) · 2.67 KB

Localization.md

File metadata and controls

73 lines (44 loc) · 2.67 KB

Localization

Important

Since our locales are consolidated from different sources, they are managed through a separate process, please do not submit pull requests for localization files as they will not be accepted.

Technical Overview

Thorium Web consolidates localization strings from two separate sources:

  1. Thorium Web - strings specific to this application
  2. Thorium Reader - strings shared across the Thorium suite

While Thorium Web strings are automatically PR’d by Weblate, Thorium Reader strings are manually updated and require coordination between the two projects.

Contributing Translations

Please do not submit pull requests for localization files as they will not be accepted. Translations are exclusively managed through Weblate projects where contributors can submit translations.

Update Process

Updating Locales

pnpm update-locales

This updates the thorium-locales dependency, extracts the latest shared locales, and generates a completion report.

Extracting Shared Locales

pnpm extract-locales

This copies locale files from the thorium-locales package to public/locales/[locale]/thorium-shared.json. It is run when building the Next.js application and bundling the NPM package.

Checking Locale Status

pnpm check-locales

This outputs a minimum viable report of the locales’ completion status in the terminal.

pnpm check-locales --show-missing

This shows missing translations for each locale.

pnpm check-locales --summary

This creates locale-summary.txt at the project root with translation completion percentages and missing keys.

It checks completion twofold:

  1. It checks completion of all locales against English (reference locale)
  2. It checks which translation keys are actually used in the application code

The second check is called "inferred usage" but cannot be run automatically for all strings due to the customizability of the application, and the use of dynamic strings (a.k.a. template literals). These strings require manual review.

When updating locales, we run both options so that it can serve as a snapshot of the current state of the translation files.

List of Supported Languages

The list of supported languages is maintained manually in src/i18n/supported-locales.ts.

There is currently no rule as to when languages should be dropped from or added to the supported list, but we review them periodically, on each release cycle.