opencode-i18n 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 huahai0202
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,106 @@
+# OpenCode i18n
+
+OpenCode TUI 界面本地化插件。
+
+支持语言：
+
+- `English`：原始英文，不改标题和描述
+- `简体中文`
+- `繁體中文`
+
+安装后运行 `/i18n`，用选项切换语言。选择中文会自动开启本地化；选择 `English` 会回到原始英文。
+
+## 一键安装（npm）
+
+```bash
+opencode plugin opencode-i18n
+```
+
+安装后重启 OpenCode，运行 `/i18n` 选择 English、简体中文或繁體中文。
+
+说明：
+
+- 该命令把插件安装到全局配置（`~/.config/opencode`），自动合并 `tui.json` 的 `plugin` 列表。
+- 插件自带默认语言包（`i18n/locales/*.json`），开箱即用。
+- 如需自定义语言包，把文件放到 `~/.config/opencode/i18n/locales/` 即可覆盖默认值。
+
+## 一句提示词安装
+
+把下面这一句发给 OpenCode：
+
+```text
+请从 https://github.com/huahai0202/opencode-i18n 安装 OpenCode i18n 插件：克隆仓库，Windows 运行 install.ps1、macOS/Linux 运行 install.sh，或按 README 手动复制文件到我的全局 OpenCode 配置目录，保留我已有配置并合并 tui.json 的 plugin 列表；完成后告诉我重启 OpenCode，并运行 /i18n 选择 English、简体中文或繁體中文。
+```
+
+## 手动安装（复制式）
+
+macOS / Linux：
+
+```bash
+git clone https://github.com/huahai0202/opencode-i18n.git
+cd opencode-i18n
+./install.sh
+```
+
+Windows PowerShell：
+
+```powershell
+git clone https://github.com/huahai0202/opencode-i18n.git
+cd opencode-i18n
+.\install.ps1
+```
+
+脚本会安装到（尊重 `XDG_CONFIG_HOME`，默认 `~/.config/opencode`）：
+
+```text
+~/.config/opencode        # macOS / Linux
+%USERPROFILE%\.config\opencode   # Windows
+```
+
+自定义安装路径：
+
+```bash
+./install.sh --config-root /path/to/opencode-config   # macOS / Linux
+.\install.ps1 -ConfigRoot C:\path\to\opencode-config  # Windows
+```
+
+它会复制这些文件：
+
+- `plugins/i18n/index.ts`
+- `tools/i18n-state.ts`
+- `commands/i18n.md`
+- `i18n/`
+
+并合并：
+
+- `tui.json` 的 `plugin` 列表
+- `package.json` 的 `@opencode-ai/plugin` 依赖
+
+## 使用
+
+```text
+/i18n
+```
+
+打开语言选择。
+
+```text
+/i18n status
+/i18n on
+/i18n off
+/i18n toggle
+```
+
+管理开关状态。
+
+如果界面没有立即刷新，请重启 OpenCode。
+
+## 文件说明
+
+- `plugins/i18n/index.ts`：TUI 插件，读取语言包和状态，改写界面标题/已有描述。
+- `plugins/i18n/server.ts`：server 插件，向 OpenCode 注册 `i18n-state` 工具（npm 安装模式下工具不会自动从 `tools/` 加载）。
+- `tools/i18n-state.ts`：状态工具，负责开关和语言选择。
+- `i18n/lib.ts`：共享路径、状态读取和语言解析逻辑。配置优先读用户目录 `~/.config/opencode/i18n/`，缺失时回退到包内默认数据。
+- `commands/i18n.md`：OpenCode 自定义 command（复制式安装时随脚本复制；npm 安装时请手动放到 `~/.config/opencode/commands/` 或直接调用 `i18n-state` 工具）。
+- `i18n/config.json`：默认语言和内置语言排序。
+- `i18n/locales/*.json`：独立语言包。新增语言时只要添加一个 locale JSON 即可被自动识别；如果想调整显示顺序，可把语言代码加入 `config.json` 的 `locales` 列表。

package/commands/i18n.md

@@ -0,0 +1,18 @@
+---
+description: 管理 OpenCode 界面本地化开关和语言
+---
+
+用户想管理 OpenCode 界面的本地化开关和语言。请按以下规则解析参数，并调用 `i18n-state` 工具。
+
+参数内容：$ARGUMENTS
+
+规则：
+
+1. 如果参数为空，先调用 `i18n-state`，传入 `action: "locales"`，读取返回内容末尾的 `QUESTION_DATA:` JSON；然后使用 `question` 工具让用户图形化选择语言。question 的问题文字必须逐字使用 JSON 里的 `question` 字段。选项必须逐项使用 JSON 里的 `options[].label` 和 `options[].description`，不要自行翻译、补充、改写，也不要给选项追加“当前”或“默认”。用户选择后调用 `i18n-state`，传入 `action: "locale"` 和用户选择的语言名称，也就是被选中的 `label`。
+2. 如果参数为 `status`、`状态`，调用 `i18n-state`，传入 `action: "status"`。
+3. 如果参数为 `on`、`enable`、`开启`、`开`，调用 `i18n-state`，传入 `action: "set"` 和 `enabled: true`。
+4. 如果参数为 `off`、`disable`、`关闭`、`关`，调用 `i18n-state`，传入 `action: "set"` 和 `enabled: false`。
+5. 如果参数为 `toggle`、`切换`，调用 `i18n-state`，传入 `action: "toggle"`。
+6. 如果参数无法识别，调用 `i18n-state` 的 `status`，然后简短说明支持的参数只有 `status`、`on`、`off`、`toggle`；切换语言请直接运行 `/i18n` 并在选项中选择。
+
+切换开关后，提醒用户：如果当前界面没有立即刷新，请重启 OpenCode。

package/i18n/config.json

@@ -0,0 +1,23 @@
+{
+  "defaultLocale": "zh-Hans",
+  "locales": [
+    "en",
+    "zh-Hans",
+    "zh-Hant",
+    "ko",
+    "de",
+    "es",
+    "fr",
+    "da",
+    "ja",
+    "pl",
+    "ru",
+    "uk",
+    "bs",
+    "ar",
+    "no",
+    "pt-BR",
+    "th",
+    "tr"
+  ]
+}

package/i18n/lib.ts

@@ -0,0 +1,307 @@
+import { readdirSync, readFileSync } from "node:fs"
+import { readdir, readFile } from "node:fs/promises"
+import os from "node:os"
+import path from "node:path"
+import { fileURLToPath } from "node:url"
+
+export type LocaleCode = string
+
+export type I18nState = {
+  version: 1
+  enabled: boolean
+  locale?: LocaleCode
+  updatedAt?: string
+}
+
+export type I18nLocaleConfig = {
+  name: string
+  language_picker: {
+    question?: string
+    option_descriptions: Record<string, string>
+  }
+  commands: Record<string, Record<string, string>>
+  descriptions: Record<string, string>
+  slash_commands: Record<string, string>
+}
+
+export type I18nConfig = {
+  defaultLocale?: LocaleCode
+  locales: Record<LocaleCode, I18nLocaleConfig>
+}
+
+type I18nIndexConfig = {
+  defaultLocale?: LocaleCode
+  locales: LocaleCode[]
+}
+
+export type LocaleInfo = {
+  defaultLocale?: LocaleCode
+  activeLocale?: LocaleCode
+  available: LocaleCode[]
+  labels: Map<LocaleCode, string>
+  config?: I18nConfig
+}
+
+type JsonObject = Record<string, unknown>
+
+const MODULE_ROOT = path.dirname(fileURLToPath(import.meta.url))
+
+/**
+ * Package root. When installed as an npm plugin this is the package directory
+ * (bundled default data). When installed by copying files into the config
+ * directory it is the config directory itself.
+ */
+export const PACKAGE_ROOT = path.resolve(MODULE_ROOT, "..")
+
+function resolveConfigRoot() {
+  const env = process.env.OPENCODE_CONFIG_DIR
+  if (env) return path.resolve(env)
+  return path.join(os.homedir(), ".config", "opencode")
+}
+
+/** User config root. User-customized i18n data takes priority over bundled defaults. */
+export const CONFIG_ROOT = resolveConfigRoot()
+export const CONFIG_PATH = path.join(CONFIG_ROOT, "i18n", "config.json")
+export const LOCALES_ROOT = path.join(CONFIG_ROOT, "i18n", "locales")
+export const PACKAGE_CONFIG_PATH = path.join(PACKAGE_ROOT, "i18n", "config.json")
+export const PACKAGE_LOCALES_ROOT = path.join(PACKAGE_ROOT, "i18n", "locales")
+export const STATE_ROOT = path.join(process.env.XDG_STATE_HOME ?? path.join(os.homedir(), ".local", "state"), "opencode")
+export const STATE_PATH = path.join(STATE_ROOT, "i18n-state.json")
+
+export function readJsonFileSync<T>(file: string): T | undefined {
+  try {
+    return JSON.parse(readFileSync(file, "utf8")) as T
+  } catch {
+    return undefined
+  }
+}
+
+export async function readJsonFile<T>(file: string): Promise<T | undefined> {
+  try {
+    return JSON.parse(await readFile(file, "utf8")) as T
+  } catch {
+    return undefined
+  }
+}
+
+function isObject(value: unknown): value is JsonObject {
+  return typeof value === "object" && value !== null && !Array.isArray(value)
+}
+
+function stringRecord(value: unknown): Record<string, string> {
+  if (!isObject(value)) return {}
+
+  const result: Record<string, string> = {}
+  for (const [key, item] of Object.entries(value)) {
+    if (typeof item === "string") result[key] = item
+  }
+
+  return result
+}
+
+function commandGroups(value: unknown): Record<string, Record<string, string>> {
+  if (!isObject(value)) return {}
+
+  const result: Record<string, Record<string, string>> = {}
+  for (const [group, commands] of Object.entries(value)) {
+    result[group] = stringRecord(commands)
+  }
+
+  return result
+}
+
+function languagePicker(value: unknown): I18nLocaleConfig["language_picker"] {
+  if (!isObject(value)) {
+    return {
+      option_descriptions: {},
+    }
+  }
+
+  return {
+    question: typeof value.question === "string" && value.question.trim() ? value.question.trim() : undefined,
+    option_descriptions: stringRecord(value.option_descriptions),
+  }
+}
+
+function normalizeLocaleConfig(value: unknown, fallbackName: string): I18nLocaleConfig {
+  const locale = isObject(value) ? value : {}
+  const name = typeof locale.name === "string" && locale.name.trim() ? locale.name.trim() : fallbackName
+
+  return {
+    name,
+    language_picker: languagePicker(locale.language_picker),
+    commands: commandGroups(locale.commands),
+    descriptions: stringRecord(locale.descriptions),
+    slash_commands: stringRecord(locale.slash_commands),
+  }
+}
+
+export function normalizeState(state: unknown): I18nState {
+  const raw = isObject(state) ? state : {}
+
+  return {
+    version: 1,
+    enabled: raw.enabled === true,
+    locale: typeof raw.locale === "string" ? raw.locale : undefined,
+    updatedAt: typeof raw.updatedAt === "string" ? raw.updatedAt : undefined,
+  }
+}
+
+function normalizeIndexConfig(config: unknown): I18nIndexConfig | undefined {
+  if (!isObject(config)) return undefined
+
+  const locales = Array.isArray(config.locales)
+    ? config.locales.filter((locale): locale is string => typeof locale === "string" && locale.trim().length > 0)
+    : []
+
+  const defaultLocale = typeof config.defaultLocale === "string" && locales.includes(config.defaultLocale) ? config.defaultLocale : undefined
+  return { defaultLocale, locales }
+}
+
+function localeCodeFromFile(file: string) {
+  return file.endsWith(".json") ? file.slice(0, -".json".length) : undefined
+}
+
+function mergeLocaleNames(indexLocales: readonly LocaleCode[], discoveredLocales: readonly LocaleCode[]) {
+  return Array.from(new Set([...indexLocales, ...discoveredLocales])).filter(Boolean)
+}
+
+function discoverLocalesInSync(root: string) {
+  try {
+    return readdirSync(root, { withFileTypes: true })
+      .filter((entry) => entry.isFile())
+      .map((entry) => localeCodeFromFile(entry.name))
+      .filter((locale): locale is string => typeof locale === "string" && locale.length > 0)
+      .sort((a, b) => a.localeCompare(b))
+  } catch {
+    return []
+  }
+}
+
+function discoverLocalesSync() {
+  return Array.from(new Set([...discoverLocalesInSync(LOCALES_ROOT), ...discoverLocalesInSync(PACKAGE_LOCALES_ROOT)])).sort(
+    (a, b) => a.localeCompare(b),
+  )
+}
+
+async function discoverLocalesIn(root: string) {
+  try {
+    return (await readdir(root, { withFileTypes: true }))
+      .filter((entry) => entry.isFile())
+      .map((entry) => localeCodeFromFile(entry.name))
+      .filter((locale): locale is string => typeof locale === "string" && locale.length > 0)
+      .sort((a, b) => a.localeCompare(b))
+  } catch {
+    return []
+  }
+}
+
+async function discoverLocales() {
+  const [user, pkg] = await Promise.all([discoverLocalesIn(LOCALES_ROOT), discoverLocalesIn(PACKAGE_LOCALES_ROOT)])
+  return Array.from(new Set([...user, ...pkg])).sort((a, b) => a.localeCompare(b))
+}
+
+function readLocaleFileSync(locale: LocaleCode) {
+  const user = readJsonFileSync<unknown>(path.join(LOCALES_ROOT, `${locale}.json`))
+  if (user !== undefined) return user
+  return readJsonFileSync<unknown>(path.join(PACKAGE_LOCALES_ROOT, `${locale}.json`))
+}
+
+async function readLocaleFile(locale: LocaleCode) {
+  const user = await readJsonFile<unknown>(path.join(LOCALES_ROOT, `${locale}.json`))
+  if (user !== undefined) return user
+  return await readJsonFile<unknown>(path.join(PACKAGE_LOCALES_ROOT, `${locale}.json`))
+}
+
+function buildConfig(index: I18nIndexConfig | undefined, discoveredLocales: readonly LocaleCode[], readLocale: (locale: LocaleCode) => unknown): I18nConfig | undefined {
+  if (!index) return undefined
+
+  const locales: Record<LocaleCode, I18nLocaleConfig> = {}
+  for (const locale of mergeLocaleNames(index.locales, discoveredLocales)) {
+    const value = readLocale(locale)
+    if (value === undefined) continue
+    locales[locale] = normalizeLocaleConfig(value, locale)
+  }
+
+  if (Object.keys(locales).length === 0) return undefined
+  const defaultLocale = index.defaultLocale && locales[index.defaultLocale] ? index.defaultLocale : undefined
+  return { defaultLocale, locales }
+}
+
+export function readStateSync(): I18nState {
+  return normalizeState(readJsonFileSync<unknown>(STATE_PATH))
+}
+
+export async function readState(): Promise<I18nState> {
+  return normalizeState(await readJsonFile<unknown>(STATE_PATH))
+}
+
+export function readConfigSync(): I18nConfig | undefined {
+  const index = normalizeIndexConfig(readJsonFileSync<unknown>(CONFIG_PATH) ?? readJsonFileSync<unknown>(PACKAGE_CONFIG_PATH))
+  return buildConfig(index, discoverLocalesSync(), readLocaleFileSync)
+}
+
+export async function readConfig(): Promise<I18nConfig | undefined> {
+  const index = normalizeIndexConfig((await readJsonFile<unknown>(CONFIG_PATH)) ?? (await readJsonFile<unknown>(PACKAGE_CONFIG_PATH)))
+  if (!index) return undefined
+
+  const localeNames = mergeLocaleNames(index.locales, await discoverLocales())
+  const entries = await Promise.all(
+    localeNames.map(async (locale) => [
+      locale,
+      normalizeLocaleConfig(await readLocaleFile(locale), locale),
+    ] as const),
+  )
+  const locales = Object.fromEntries(entries) as Record<LocaleCode, I18nLocaleConfig>
+
+  if (Object.keys(locales).length === 0) return undefined
+  return { defaultLocale: index.defaultLocale, locales }
+}
+
+export function localeNames(config: I18nConfig | undefined) {
+  return Object.keys(config?.locales ?? {})
+}
+
+export function resolveLocale(config: I18nConfig | undefined, state: Pick<I18nState, "locale"> | undefined) {
+  const available = localeNames(config)
+  const stateLocale = state?.locale
+
+  if (available.length === 0) return stateLocale
+  if (stateLocale && available.includes(stateLocale)) return stateLocale
+  if (config?.defaultLocale && available.includes(config.defaultLocale)) return config.defaultLocale
+
+  return available[0]
+}
+
+export function localeInfo(config: I18nConfig | undefined, state: I18nState): LocaleInfo {
+  const available = localeNames(config)
+  const labels = new Map<LocaleCode, string>()
+
+  for (const locale of available) {
+    labels.set(locale, config?.locales[locale]?.name ?? locale)
+  }
+
+  return {
+    defaultLocale: config?.defaultLocale,
+    activeLocale: resolveLocale(config, state),
+    available,
+    labels,
+    config,
+  }
+}
+
+export function resolveLocaleInput(locale: string, info: LocaleInfo) {
+  const value = locale.trim()
+  const normalizedLower = value.toLocaleLowerCase()
+
+  for (const available of info.available) {
+    if (available === value || available.toLocaleLowerCase() === normalizedLower) return available
+  }
+
+  for (const available of info.available) {
+    const label = info.labels.get(available)
+    if (label === value || label?.toLocaleLowerCase() === normalizedLower) return available
+  }
+
+  return value
+}