OpenParable
Skip to content
← Back to skills

Compile i18n

Development

Compile i18n is an Agent Skill for development published in the ok-oldking/ok-script repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

How to add i18n to all the ts files, and use the compile_i18n.cmd command to compile the ts files

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/ok-oldking/ok-script/blob/HEAD/.agents/skills/compile_i18n/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/compile-i18n, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Compile i18n

When you are instructed to add or update internationalization (i18n) translations for this project, please follow these steps:

  1. Identify the new strings that need to be translated.
  2. Edit the .ts translation files located in the ok/gui/i18n/ directory. Typically, these files include:
    • zh_CN.ts (Simplified Chinese)
    • zh_TW.ts (Traditional Chinese)
    • ja_JP.ts (Japanese)
    • ko_KR.ts (Korean)
    • es_ES.ts (Spanish)
    • en_US.ts (English)
  3. Ensure that your new translations are correctly added under the appropriate <context> and <message> blocks in each XML file, without the type="unfinished" attribute. If you are adding many translations, or just want to minimize errors, use the provided add_translation.py script to automate the XML injection:
    $py = if (Test-Path .\.venv\Scripts\python.exe) { ".\.venv\Scripts\python.exe" } else { "python" }
    & $py .\.agents\skills\compile_i18n\add_translation.py --context "YourContext" --source "Your Source String" --zh_cn "Your Chinese String"
    
    IMPORTANT WARNING: DO NOT use pyside6-lupdate as it corrupts and deletes existing translations. Always modify the XML nodes natively or use the python script!
  4. Check that there are no unfinished translations in the files. The compile_i18n.cmd script will automatically abort if it detects type="unfinished" in any translation text. You must replace <translation type="unfinished" /> with <translation>Your Translation</translation>.
  5. After updating the .ts files, compile them into .qm binary format by leveraging the provided script. Run the following command from the workspace root:

// turbo

.\compile_i18n.cmd

This will run pyside6-lrelease on all language files and generate the corresponding .qm files used by the application, as well as compile updated resources if necessary.