chore: improve i18n workflow with semantic__type suffix convention by PatrickChoo · Pull Request #10131 · OneKeyHQ/app-monorepo

PatrickChoo · 2026-02-11T02:46:37Z

Summary

Unified naming convention: All i18n docs now use {semantic_key}__{type} suffix format (e.g. send__title, confirm_send__action)
Added CLI tools: i18n:search for local key lookup, i18n:add for Lokalise API, renamed fetch:locale → i18n:pull
Slimmed CLAUDE.md: i18n section condensed, pointing to /1k-i18n skill for details

4 type suffixes

Suffix	Case	Usage
`__title`	Title Case	Page/dialog title, form label
`__action`	Title Case	Button, menu item, tab, link
`__desc`	Sentence case	Description, placeholder, hint
`__msg`	Sentence case	Error, toast, alert

Note on auto-generated files

translations.ts and localeJsonMap.ts have a comment change (yarn fetch:locale → yarn i18n:pull). The build template in build-locale-json-map.js was also updated, so next i18n:pull run will produce consistent output. This is an intentional one-time sync.

Test plan

yarn workspace @onekeyhq/shared i18n:search "send" works with suffix detection
yarn workspace @onekeyhq/shared i18n:add send__title "Send" validates suffix format
yarn workspace @onekeyhq/shared i18n:pull syncs correctly
No build breakage from renamed scripts

🤖 Generated with Claude Code

revan-zhang · 2026-02-11T02:48:30Z

✅ Snyk checks have passed. No issues have been found so far.

Status	Scanner	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues
✅	Licenses	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

huhuanming

Code review comments (issues #3 and #4 from review)

socket-security · 2026-02-24T15:41:46Z

No dependency changes detected. Learn more about Socket for GitHub.

👍 No dependency changes detected in pull request

boring-claw · 2026-02-24T21:01:46Z

🔍 Code Review Report

检查时间: 2026-02-25 05:00 CST

变更摘要:

改进 i18n 工作流，引入语义化命名约定 {semantic_key}__{type}
新增 CLI 工具: i18n:search 和 i18n:add
更新技能文档和开发规范
添加 dotenv 依赖支持

Review 意见:

✅ 优点:

命名约定清晰 - __title/__action/__desc/__msg 四类后缀与 Apple HIG 对齐，语义明确
向后兼容 - 明确说明旧 key 保持有效，无需迁移，降低风险
工具完善 - i18n:search 和 i18n:add 脚本提升了开发者体验
文档详尽 - SKILL.md 和 i18n.md 的更新非常全面，包含使用示例和最佳实践

⚠️ 建议:

建议为新增的 i18n-add.js 和 i18n-search.js 添加单元测试，确保脚本稳定性
i18n:add 命令涉及 Lokalise API 调用，建议添加错误重试机制和详细的错误提示
考虑在 CI 中添加 key 命名规范检查，自动拦截不符合新规范的 key

总体评价: LGTM 👍 这是一个组织良好的改进，提升了 i18n 工作流的可维护性。

Reviewed by BoringClaw 🤖

… placeholder validation - Add i18n:add script to create Lokalise keys with semantic__type suffix convention - Add i18n:search script for searching existing translation keys - Rename fetch:locale to i18n:pull for consistent naming - Use 1Password CLI (yarn op) for secrets instead of dotenv - Add ICU placeholder extraction and en/zh mismatch validation - Add root-level yarn i18n:add, i18n:search, i18n:pull shortcuts - Update CLAUDE.md, SKILL.md, AGENTS.md docs with new CLI commands

Shared package is for app runtime code. Dev tooling scripts belong in development/scripts/ alongside other build and CI scripts.

- Fix grouping to use full semantic prefix before __ instead of first word only - Update next-step hint to use root-level yarn i18n:pull command

Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com>

- Wrap JSON.parse in try/catch to prevent uncaught exception on malformed API response - Add .catch() handler on main() to prevent unhandled promise rejection

devin-ai-integration

Devin Review found 2 new potential issues.

View 15 additional findings in Devin Review.

PatrickChoo requested review from ezailWang, huhuanming, originalix, revan-zhang and sidmorizon as code owners February 11, 2026 02:46

This comment was marked as resolved.

Sign in to view

huhuanming reviewed Feb 11, 2026

View reviewed changes

Comment thread .claude/skills/1k-i18n/SKILL.md Outdated

huhuanming reviewed Feb 11, 2026

View reviewed changes

Comment thread packages/shared/src/locale/enum/translations.ts

PatrickChoo force-pushed the chore/i18n-workflow-improvement branch 2 times, most recently from 88f3b16 to 7454b35 Compare February 11, 2026 04:30

This comment was marked as resolved.

Sign in to view

PatrickChoo force-pushed the chore/i18n-workflow-improvement branch from 7454b35 to 0ca1bad Compare February 11, 2026 04:36

huhuanming previously approved these changes Feb 12, 2026

View reviewed changes

originalix reviewed Feb 24, 2026

View reviewed changes

Comment thread packages/shared/package.json Outdated

PatrickChoo dismissed huhuanming’s stale review via b9b87ba February 24, 2026 20:44

PatrickChoo force-pushed the chore/i18n-workflow-improvement branch from cbe0517 to b9b87ba Compare February 24, 2026 20:44

PatrickChoo force-pushed the chore/i18n-workflow-improvement branch from b9b87ba to be1ad8f Compare February 25, 2026 06:57

originalix approved these changes Feb 25, 2026

View reviewed changes

PatrickChoo requested a review from huhuanming February 27, 2026 10:09

originalix previously approved these changes Feb 27, 2026

View reviewed changes

originalix reviewed Feb 27, 2026

View reviewed changes

Comment thread package.json

PatrickChoo dismissed originalix’s stale review via 406628f February 27, 2026 10:38

This comment was marked as resolved.

Sign in to view

PatrickChoo force-pushed the chore/i18n-workflow-improvement branch from c31e9ab to aeb0ee7 Compare March 10, 2026 13:39

PatrickChoo added 4 commits March 10, 2026 21:42

chore: move i18n scripts from shared to development/scripts/i18n

f9840bd

Shared package is for app runtime code. Dev tooling scripts belong in development/scripts/ alongside other build and CI scripts.

fix: resolve lint issues in i18n scripts

66691d6

fix: i18n search grouping and add command hint

396bf2c

- Fix grouping to use full semantic prefix before __ instead of first word only - Update next-step hint to use root-level yarn i18n:pull command

PatrickChoo force-pushed the chore/i18n-workflow-improvement branch from aeb0ee7 to 396bf2c Compare March 10, 2026 13:43

Merge branch 'x' into chore/i18n-workflow-improvement

0f2d0d0

originalix previously approved these changes Mar 10, 2026

View reviewed changes

originalix enabled auto-merge (squash) March 10, 2026 15:38

Merge branch 'x' into chore/i18n-workflow-improvement

14468f0

huhuanming previously approved these changes Mar 11, 2026

View reviewed changes

This comment was marked as resolved.

Sign in to view

Update development/scripts/i18n/i18n-add.js

18383ac

Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com>

auto-merge was automatically disabled March 11, 2026 05:26
Head branch was pushed to by a user without write access

PatrickChoo dismissed stale reviews from huhuanming and originalix via 18383ac March 11, 2026 05:26

This comment was marked as resolved.

Sign in to view

PatrickChoo and others added 3 commits March 11, 2026 18:56

fix: format long line in i18n-add.js for prettier

c475d44

Merge branch 'x' into chore/i18n-workflow-improvement

f0205f5

fix: add error handling in i18n-add.js

f930206

- Wrap JSON.parse in try/catch to prevent uncaught exception on malformed API response - Add .catch() handler on main() to prevent unhandled promise rejection

originalix approved these changes Mar 11, 2026

View reviewed changes

Merge branch 'x' into chore/i18n-workflow-improvement

00f03bb

devin-ai-integration bot reviewed Mar 11, 2026

View reviewed changes

Comment thread packages/shared/src/locale/enum/translations.ts

Comment thread packages/shared/src/locale/localeJsonMap.ts

sidmorizon approved these changes Mar 11, 2026

View reviewed changes

huhuanming merged commit 8b43d0e into OneKeyHQ:x Mar 11, 2026
7 checks passed

Conversation

PatrickChoo commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

4 type suffixes

Note on auto-generated files

Test plan

Uh oh!

revan-zhang commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Snyk checks have passed. No issues have been found so far.

Uh oh!

This comment was marked as resolved.

Uh oh!

huhuanming left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

socket-security bot commented Feb 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

boring-claw commented Feb 24, 2026

🔍 Code Review Report

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

devin-ai-integration bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

PatrickChoo commented Feb 11, 2026 •

edited

Loading

revan-zhang commented Feb 11, 2026 •

edited

Loading

socket-security bot commented Feb 24, 2026 •

edited

Loading