|
| 1 | +# i18n 国际化指南 |
| 2 | + |
| 3 | +## 概述 |
| 4 | + |
| 5 | +Claude Code 的国际化 (i18n) 系统允许应用支持多种语言,目前支持: |
| 6 | +- **en-US** - 英语(默认) |
| 7 | +- **zh-CN** - 简体中文 |
| 8 | + |
| 9 | +## 快速开始 |
| 10 | + |
| 11 | +### 1. 导入翻译函数 |
| 12 | + |
| 13 | +```typescript |
| 14 | +import { t } from 'src/i18n'; |
| 15 | +``` |
| 16 | + |
| 17 | +### 2. 使用翻译 |
| 18 | + |
| 19 | +```typescript |
| 20 | +// 简单翻译 |
| 21 | +const text = t('common.loading'); // "加载中..." 或 "Loading..." |
| 22 | + |
| 23 | +// 带参数的翻译 |
| 24 | +const message = t('notifications.noImage', { shortcut: 'Ctrl+V' }); |
| 25 | +// 输出:"剪贴板中没有图片。使用 Ctrl+V 粘贴图片。" |
| 26 | +``` |
| 27 | + |
| 28 | +## 翻译键命名规范 |
| 29 | + |
| 30 | +使用点分隔的层级命名: |
| 31 | + |
| 32 | +``` |
| 33 | +category.subcategory.item |
| 34 | +``` |
| 35 | + |
| 36 | +例如: |
| 37 | +- `common.loading` - 通用加载文本 |
| 38 | +- `chat.input.placeholder` - 聊天输入框占位符 |
| 39 | +- `permissions.title` - 权限对话框标题 |
| 40 | + |
| 41 | +## 可用的翻译键 |
| 42 | + |
| 43 | +### 通用 (common.*) |
| 44 | +| 键 | 英文 | 中文 | |
| 45 | +|---|---|---| |
| 46 | +| `common.loading` | Loading... | 加载中... | |
| 47 | +| `common.confirm` | Confirm | 确认 | |
| 48 | +| `common.cancel` | Cancel | 取消 | |
| 49 | +| `common.yes` | Yes | 是 | |
| 50 | +| `common.no` | No | 否 | |
| 51 | +| `common.ok` | OK | 确定 | |
| 52 | +| `common.close` | Close | 关闭 | |
| 53 | +| `common.retry` | Retry | 重试 | |
| 54 | + |
| 55 | +### 聊天 (chat.*) |
| 56 | +| 键 | 英文 | 中文 | |
| 57 | +|---|---|---| |
| 58 | +| `chat.input.placeholder` | Type a message... | 输入消息或 '/' 查看命令... | |
| 59 | +| `chat.submit` | Send | 发送 | |
| 60 | +| `chat.cancelling` | Cancelling... | 取消中... | |
| 61 | + |
| 62 | +### 权限 (permissions.*) |
| 63 | +| 键 | 英文 | 中文 | |
| 64 | +|---|---|---| |
| 65 | +| `permissions.title` | Permission Request | 权限请求 | |
| 66 | +| `permissions.allow` | Allow | 允许 | |
| 67 | +| `permissions.deny` | Deny | 拒绝 | |
| 68 | + |
| 69 | +### 设置 (settings.*) |
| 70 | +| 键 | 英文 | 中文 | |
| 71 | +|---|---|---| |
| 72 | +| `settings.title` | Settings | 设置 | |
| 73 | +| `settings.general` | General | 通用 | |
| 74 | +| `settings.appearance` | Appearance | 外观 | |
| 75 | + |
| 76 | +## 添加新的翻译 |
| 77 | + |
| 78 | +### 步骤 1: 在翻译文件中添加键值 |
| 79 | + |
| 80 | +编辑 `src/i18n/locales/en-US.json` 和 `src/i18n/locales/zh-CN.json`: |
| 81 | + |
| 82 | +```json |
| 83 | +{ |
| 84 | + "my.new.key": "English text", |
| 85 | + "my.new.key": "中文文本" |
| 86 | +} |
| 87 | +``` |
| 88 | + |
| 89 | +### 步骤 2: 在代码中使用 |
| 90 | + |
| 91 | +```typescript |
| 92 | +const text = t('my.new.key'); |
| 93 | +``` |
| 94 | + |
| 95 | +### 步骤 3: 带参数的翻译 |
| 96 | + |
| 97 | +如果文本包含动态内容,使用参数: |
| 98 | + |
| 99 | +```json |
| 100 | +{ |
| 101 | + "greeting": "Hello, {name}!", |
| 102 | + "greeting": "你好,{name}!" |
| 103 | +} |
| 104 | +``` |
| 105 | + |
| 106 | +```typescript |
| 107 | +const text = t('greeting', { name: 'World' }); |
| 108 | +``` |
| 109 | + |
| 110 | +## 运行时切换语言 |
| 111 | + |
| 112 | +```typescript |
| 113 | +import { setLocale, getLocale } from 'src/i18n'; |
| 114 | + |
| 115 | +// 获取当前语言 |
| 116 | +const current = getLocale(); // 'en-US' 或 'zh-CN' |
| 117 | + |
| 118 | +// 切换语言 |
| 119 | +setLocale('zh-CN'); |
| 120 | +``` |
| 121 | + |
| 122 | +## 最佳实践 |
| 123 | + |
| 124 | +1. **始终使用翻译键**:不要在 UI 代码中使用硬编码的字符串 |
| 125 | +2. **保持一致性**:相同的概念使用相同的翻译键 |
| 126 | +3. **避免过度嵌套**:键名深度不超过 3-4 层 |
| 127 | +4. **参数化动态内容**:使用 `{param}` 语法而不是字符串拼接 |
| 128 | +5. **翻译所有用户可见文本**:包括错误消息、通知、按钮文本等 |
| 129 | + |
| 130 | +## 示例 |
| 131 | + |
| 132 | +### 组件中使用 i18n |
| 133 | + |
| 134 | +```typescript |
| 135 | +import { t } from 'src/i18n'; |
| 136 | +import { Text } from 'src/ink.js'; |
| 137 | + |
| 138 | +function MyComponent() { |
| 139 | + return ( |
| 140 | + <Box> |
| 141 | + <Text>{t('common.loading')}</Text> |
| 142 | + <Text>{t('permissions.title')}</Text> |
| 143 | + </Box> |
| 144 | + ); |
| 145 | +} |
| 146 | +``` |
| 147 | + |
| 148 | +### 错误处理 |
| 149 | + |
| 150 | +```typescript |
| 151 | +import { t } from 'src/i18n'; |
| 152 | + |
| 153 | +function handleError(error: Error) { |
| 154 | + console.error(t('errors.generic'), error); |
| 155 | + // 如果翻译键不存在,会返回键名本身,便于调试 |
| 156 | +} |
| 157 | +``` |
| 158 | + |
| 159 | +## 文件结构 |
| 160 | + |
| 161 | +``` |
| 162 | +src/i18n/ |
| 163 | +├── index.ts # 核心翻译函数 t() |
| 164 | +├── init.ts # 初始化逻辑 |
| 165 | +├── README.md # 快速参考 |
| 166 | +└── locales/ |
| 167 | + ├── en-US.json # 英文翻译 |
| 168 | + └── zh-CN.json # 中文翻译 |
| 169 | +``` |
| 170 | + |
| 171 | +## 注意事项 |
| 172 | + |
| 173 | +1. **不要删除已有的翻译键**:可能导致旧代码返回键名 |
| 174 | +2. **保持英文和中文键名一致**:便于维护 |
| 175 | +3. **测试两种语言**:确保翻译正确显示 |
| 176 | +4. **locale 自动检测**:启动时根据系统语言自动选择 |
0 commit comments