opencode-i18n 0.1.0 → 0.1.2

package/README.md

@@ -10,20 +10,29 @@ OpenCode TUI 界面本地化插件。
 
 安装后运行 `/i18n`，用选项切换语言。选择中文会自动开启本地化；选择 `English` 会回到原始英文。
 
-## 一键安装（npm）
+## 一键安装（命令面板）
 
-```bash
-opencode plugin opencode-i18n
-```
+在 OpenCode 中：
+
+1. 按 **`Ctrl + P`** 打开命令面板
+2. 搜索 **`install plugin`**
+3. 输入 **`opencode-i18n`**，回车
 
 安装后重启 OpenCode，运行 `/i18n` 选择 English、简体中文或繁體中文。
 
 说明：
 
-- 该命令把插件安装到全局配置（`~/.config/opencode`），自动合并 `tui.json` 的 `plugin` 列表。
+- 插件已发布到 npm，安装方式和 `opencode-visual-cache` 等插件完全一致。
+- 安装会自动写入 `opencode.json`（server 端）和 `tui.json`（TUI 端）的 `plugin` 列表。
 - 插件自带默认语言包（`i18n/locales/*.json`），开箱即用。
 - 如需自定义语言包，把文件放到 `~/.config/opencode/i18n/locales/` 即可覆盖默认值。
 
+也可以用命令行安装：
+
+```bash
+opencode plugin opencode-i18n
+```
+
 ## 一句提示词安装
 
 把下面这一句发给 OpenCode：
@@ -82,7 +91,7 @@ cd opencode-i18n
 /i18n
 ```
 
-打开语言选择。
+打开语言选择对话框（由 TUI 插件注册，npm 安装后直接可用）。选择语言即切换，也可在对话框里开关本地化。
 
 ```text
 /i18n status
@@ -91,16 +100,16 @@ cd opencode-i18n
 /i18n toggle
 ```
 
-管理开关状态。
+管理开关状态（这些带参数形式走服务端命令；npm 安装时 server 插件会自动把 `commands/i18n.md` 写入 `~/.config/opencode/commands/`，无需手动操作）。
 
 如果界面没有立即刷新，请重启 OpenCode。
 
 ## 文件说明
 
-- `plugins/i18n/index.ts`：TUI 插件，读取语言包和状态，改写界面标题/已有描述。
-- `plugins/i18n/server.ts`：server 插件，向 OpenCode 注册 `i18n-state` 工具（npm 安装模式下工具不会自动从 `tools/` 加载）。
+- `plugins/i18n/index.ts`：TUI 插件，读取语言包和状态，改写界面标题/已有描述；并注册 `/i18n` 命令（语言选择对话框）。
+- `plugins/i18n/server.ts`：server 插件，向 OpenCode 注册 `i18n-state` 工具（npm 安装模式下工具不会自动从 `tools/` 加载），并在首次启动时自动安装 `commands/i18n.md`（已存在则不覆盖）。
 - `tools/i18n-state.ts`：状态工具，负责开关和语言选择。
 - `i18n/lib.ts`：共享路径、状态读取和语言解析逻辑。配置优先读用户目录 `~/.config/opencode/i18n/`，缺失时回退到包内默认数据。
-- `commands/i18n.md`：OpenCode 自定义 command（复制式安装时随脚本复制；npm 安装时请手动放到 `~/.config/opencode/commands/` 或直接调用 `i18n-state` 工具）。
+- `commands/i18n.md`：OpenCode 自定义 command（复制式安装时随脚本复制；npm 安装时由 server 插件自动安装）。
 - `i18n/config.json`：默认语言和内置语言排序。
 - `i18n/locales/*.json`：独立语言包。新增语言时只要添加一个 locale JSON 即可被自动识别；如果想调整显示顺序，可把语言代码加入 `config.json` 的 `locales` 列表。

package/i18n/lib.ts

@@ -1,5 +1,5 @@
 import { readdirSync, readFileSync } from "node:fs"
-import { readdir, readFile } from "node:fs/promises"
+import { mkdir, readdir, readFile, writeFile } from "node:fs/promises"
 import os from "node:os"
 import path from "node:path"
 import { fileURLToPath } from "node:url"
@@ -236,6 +236,20 @@ export async function readState(): Promise<I18nState> {
   return normalizeState(await readJsonFile<unknown>(STATE_PATH))
 }
 
+export async function writeState(patch: Partial<Pick<I18nState, "enabled" | "locale">>): Promise<I18nState> {
+  const current = await readState()
+  const state: I18nState = {
+    version: 1,
+    enabled: patch.enabled ?? current.enabled,
+    locale: patch.locale ?? current.locale,
+    updatedAt: new Date().toISOString(),
+  }
+
+  await mkdir(STATE_ROOT, { recursive: true })
+  await writeFile(STATE_PATH, `${JSON.stringify(state, null, 2)}\n`, "utf8")
+  return state
+}
+
 export function readConfigSync(): I18nConfig | undefined {
   const index = normalizeIndexConfig(readJsonFileSync<unknown>(CONFIG_PATH) ?? readJsonFileSync<unknown>(PACKAGE_CONFIG_PATH))
   return buildConfig(index, discoverLocalesSync(), readLocaleFileSync)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-i18n",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "OpenCode TUI i18n plugin — localize the interface into 简体中文 / 繁體中文 and more, with one-command install.",
   "license": "MIT",
   "type": "module",

package/plugins/i18n/index.ts

@@ -1,5 +1,12 @@
 import type { TuiPlugin, TuiPluginApi, TuiPluginModule } from "@opencode-ai/plugin/tui"
-import { readConfigSync, readStateSync, resolveLocale, type I18nLocaleConfig } from "../../i18n/lib.ts"
+import {
+  localeInfo,
+  readConfigSync,
+  readStateSync,
+  resolveLocale,
+  writeState,
+  type I18nLocaleConfig,
+} from "../../i18n/lib.ts"
 
 type TranslationSnapshot = {
   enabled: boolean
@@ -229,8 +236,66 @@ function patchKeymap(api: TuiPluginApi) {
   })
 }
 
+function registerI18nCommand(api: TuiPluginApi) {
+  api.keymap.registerLayer({
+    commands: [
+      {
+        name: "i18n.open",
+        title: "Open i18n language picker",
+        desc: "Choose the OpenCode interface language",
+        category: "System",
+        namespace: "palette",
+        slashName: "i18n",
+        run: () => openLanguagePicker(api),
+      },
+    ],
+  })
+}
+
+function openLanguagePicker(api: TuiPluginApi) {
+  const config = readConfigSync()
+  const state = readStateSync()
+  const info = localeInfo(config, state)
+  const active = info.activeLocale
+  const enabled = state.enabled
+
+  const toggleLabel = enabled ? "Disable localization" : "Enable localization"
+  const options = [
+    {
+      title: `${toggleLabel}  ${enabled ? "ON" : "OFF"}`,
+      value: "__toggle__",
+      description: enabled ? "Turn off localized titles" : "Turn on localized titles",
+    },
+    ...info.available.map((locale) => ({
+      title: `${info.labels.get(locale) ?? locale}${locale === active ? "  ✓" : ""}`,
+      value: locale,
+      description: `Switch to ${info.labels.get(locale) ?? locale}`,
+    })),
+  ]
+
+  api.ui.dialog.setSize("medium")
+  api.ui.dialog.replace(() =>
+    api.ui.DialogSelect({
+      title: "OpenCode i18n",
+      placeholder: "Search languages...",
+      options,
+      onSelect(opt: { value: string }) {
+        api.ui.dialog.clear()
+        if (opt.value === "__toggle__") {
+          void writeState({ enabled: !enabled })
+          api.ui.toast({ message: enabled ? "Localization disabled" : "Localization enabled" })
+          return
+        }
+        void writeState({ locale: opt.value, enabled: opt.value !== "en" })
+        api.ui.toast({ message: `Switched to ${info.labels.get(opt.value) ?? opt.value}` })
+      },
+    }),
+  )
+}
+
 const tui: TuiPlugin = async (api) => {
   patchKeymap(api)
+  registerI18nCommand(api)
 }
 
 const plugin = {

package/plugins/i18n/server.ts

@@ -1,7 +1,37 @@
 import type { Plugin, PluginModule } from "@opencode-ai/plugin"
+import { access, mkdir, readFile, writeFile } from "node:fs/promises"
+import path from "node:path"
+import { fileURLToPath } from "node:url"
+import { CONFIG_ROOT } from "../../i18n/lib.ts"
 import i18nStateTool from "../../tools/i18n-state.ts"
 
+const MODULE_ROOT = path.dirname(fileURLToPath(import.meta.url))
+const COMMAND_SOURCE = path.resolve(MODULE_ROOT, "../../commands/i18n.md")
+const COMMAND_TARGET = path.join(CONFIG_ROOT, "commands", "i18n.md")
+
+async function exists(file: string) {
+  try {
+    await access(file)
+    return true
+  } catch {
+    return false
+  }
+}
+
+async function installCommandFile() {
+  try {
+    if (await exists(COMMAND_TARGET)) return
+    const content = await readFile(COMMAND_SOURCE, "utf8")
+    await mkdir(path.dirname(COMMAND_TARGET), { recursive: true })
+    await writeFile(COMMAND_TARGET, content, "utf8")
+  } catch {
+    // Read failure (file missing in copy-based installs) or write failure are
+    // non-fatal: the command file is optional.
+  }
+}
+
 const server: Plugin = async () => {
+  await installCommandFile()
   return {
     tool: {
       "i18n-state": i18nStateTool,

package/tools/i18n-state.ts

@@ -1,13 +1,12 @@
 import { tool } from "@opencode-ai/plugin"
-import { mkdir, writeFile } from "node:fs/promises"
 import {
   CONFIG_PATH,
   STATE_PATH,
-  STATE_ROOT,
   localeInfo,
   readConfig,
   readState,
   resolveLocaleInput,
+  writeState,
   type I18nState,
   type LocaleCode,
   type LocaleInfo,
@@ -145,21 +144,7 @@ function localeConfig(info: LocaleInfo, locale: LocaleCode | undefined) {
   return locale ? info.config?.locales[locale] : undefined
 }
 
-async function writeState(patch: Partial<Pick<I18nState, "enabled" | "locale">>): Promise<I18nState> {
-  const current = await readState()
-  const state: I18nState = {
-    version: 1,
-    enabled: patch.enabled ?? current.enabled,
-    locale: patch.locale ?? current.locale,
-    updatedAt: new Date().toISOString(),
-  }
-
-  await mkdir(STATE_ROOT, { recursive: true })
-  await writeFile(STATE_PATH, `${JSON.stringify(state, null, 2)}\n`, "utf8")
-  return state
-}
-
-function formatLocale(locale: string | undefined, info: LocaleInfo, text: Messages) {
+function formatLocale(locale: string | undefined, info: LocaleInfo, text: Messages) {
   if (!locale) return text.unset
   const label = info.labels.get(locale)
   return label && label !== locale ? `${locale} (${label})` : locale