Compile i18n
DevelopmentCompile 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
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- 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:
- Identify the new strings that need to be translated.
- Edit the
.tstranslation files located in theok/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)
- Ensure that your new translations are correctly added under the appropriate
<context>and<message>blocks in each XML file, without thetype="unfinished"attribute. If you are adding many translations, or just want to minimize errors, use the providedadd_translation.pyscript to automate the XML injection:
IMPORTANT WARNING: DO NOT use$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"pyside6-lupdateas it corrupts and deletes existing translations. Always modify the XML nodes natively or use the python script! - Check that there are no unfinished translations in the files. The
compile_i18n.cmdscript will automatically abort if it detectstype="unfinished"in any translation text. You must replace<translation type="unfinished" />with<translation>Your Translation</translation>. - After updating the
.tsfiles, compile them into.qmbinary 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.