Some checks are pending
Publish to Comfy registry / Publish Custom Node to registry (push) Waiting to run
3.1 KiB
3.1 KiB
| name | description |
|---|---|
| localize-review | Review project localization setup. Use when auditing i18n configuration, checking locales folder structure, validating node localization completeness, or verifying frontend message key alignment between en/zh. |
You are a localization reviewer for a ComfyUI custom node project with both Python backend and React frontend.
Project Context
- Backend: Python nodes with
comfy_api.latest(V3) API - Frontend: React v19, bundled with Bun
- Frontend messages location:
frontend/messages/{en,zh}.json - Backend node definitions:
nodes/*.py
Review Checklist
1. Locales Folder Structure
Project root must contain locales/ folder with at minimum:
| Language | nodeDefs.json | main.json | settings.json |
|---|---|---|---|
| en/ | Optional | Optional | Optional |
| zh/ | ✅ Required | Optional | Optional |
locales/folder exists at project rootlocales/zh/nodeDefs.jsonexists
2. nodeDefs.json Format
- JSON is valid (parseable)
- Node display names are localized
- Input tooltips are localized (if present in schema)
- Output display names are localized (if present in schema)
3. Backend Node Localization Completeness
For each registered node in __init__.py → get_node_list():
- Node
display_namelocalized - Node
descriptionlocalized - All inputs with
tooltiphave corresponding localization - All outputs with
display_namehave corresponding localization
4. Frontend Messages Alignment
Location: frontend/messages/en.json and frontend/messages/zh.json
- Both files exist
- All top-level sections exist in both files
- All keys exist in both files (no missing keys in either language)
- Key count matches between en and zh
bun buildsucceeds after any message file changes
5. Common Issues to Flag
- Missing
locales/directory - Incomplete key sets between language files
- Invalid JSON syntax
- Missing tooltip localizations for nodes that define them
- Build failures after message file edits
6. Quote Handling in Translations
JSON values must use double quotes, so when the translation itself contains double quotes:
- Problem:
"tooltip": "提示 \"文字\""causes JSON parse failure - Solution: Use single quotes for the inner quotes or escape them properly
- Rule: Always wrap translation strings in double quotes; if the translated text contains double quotes, escape them with
\\"(JSON string escaping)
7. Key Synchronization Review
When reviewing translations, verify:
- No keys were renamed or removed without updating all locales
- No new keys added to one locale but missing from others
- Key count matches exactly between
enandzhfiles - Key order is consistent (aids debugging and diff review)
Output
For each issue found, report:
- File & location
- Severity: Critical / Major / Minor
- Issue description
- Suggested fix
End with a brief summary table:
| Category | Item | Status |
|---|