Skip to content

chore(wiki): document Lingui plugin i18n#8

Open
NewtTheWolf wants to merge 1 commit into
mainfrom
chore/i18n-lingui-docs
Open

chore(wiki): document Lingui plugin i18n#8
NewtTheWolf wants to merge 1 commit into
mainfrom
chore/i18n-lingui-docs

Conversation

@NewtTheWolf

Copy link
Copy Markdown
Contributor

Summary

The host app migrated from i18next to Lingui (see TabularisDB/tabularis#351). This updates the plugin author docs to match.

Changes

  • building-plugins.md / plugins.mdusePluginTranslation(pluginId) now reads the plugin's own locales/<lang>.json (ICU {var} placeholders; legacy i18next {{var}} still resolves), instead of being described as an "i18next-compatible translator".
  • building-plugins.md — new "Translating your plugin" section: the locales/ folder shipped by the --with-ui scaffold, how to read keys with usePluginTranslation, and the en.json → key fallback chain.

Docs-only; no code changes.

🤖 Generated with Claude Code

@vercel

vercel Bot commented Jun 22, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
website Ready Ready Preview, Comment Jun 22, 2026 2:33pm

Request Review

@kilo-code-bot

kilo-code-bot Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Files Reviewed (2 files)
  • content/wiki/building-plugins.md — Updated usePluginTranslation hook description and added new "Translating your plugin" section documenting Lingui-based localization, the locales/ folder structure, ICU {var} placeholders, and legacy {{var}} backward compatibility.
  • content/wiki/plugins.md — Updated usePluginTranslation hook description in the Plugin API table to reference locales/<lang>.json with ICU {var} syntax and legacy {{var}} support.
Previous Review Summary (commit eca1cee)

Current summary above is authoritative. Previous snapshots are kept for context only.

Previous review (commit eca1cee)

Status: No Issues Found | Recommendation: Merge

Files Reviewed (2 files)
  • content/wiki/building-plugins.md — Updated usePluginTranslation hook description and added new "Translating your plugin" section documenting Lingui-based localization, the locales/ folder structure, ICU {var} placeholders, and legacy {{var}} backward compatibility.
  • content/wiki/plugins.md — Updated usePluginTranslation hook description in the Plugin API table to reference locales/<lang>.json with ICU {var} syntax and legacy {{var}} support.

Reviewed by kimi-k2.6-20260420 · Input: 21.3K · Output: 2.8K · Cached: 170.8K

@kilo-code-bot

kilo-code-bot Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Files Reviewed (2 files)
  • content/wiki/building-plugins.md — Updated usePluginTranslation hook description and added new "Translating your plugin" section documenting Lingui-based localization, the locales/ folder structure, ICU {var} placeholders, and legacy {{var}} backward compatibility.
  • content/wiki/plugins.md — Updated usePluginTranslation hook description in the Plugin API table to reference locales/<lang>.json with ICU {var} syntax and legacy {{var}} support.

The host app now runs on Lingui. Update the plugin docs accordingly:
- usePluginTranslation reads the plugin's locales/<lang>.json (ICU {var};
  legacy {{var}} still works), not an i18next-compatible translator.
- Add a "Translating your plugin" section to building-plugins.md covering the
  locales/ folder, usage, and the en.json -> key fallback chain.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant