架構
架構總覽
程式碼庫分為四層。本節用於建立心智模型;需要檔案級別的詳細資訊時,請開啟原始碼樹。
sync 執行如何協同運作
sync(以及個別的翻譯指令)依序執行已啟用的功能:
| 步驟 | 指令 | 功能 |
|---|---|---|
| 1 | extract → translate-ui | 掃描 UI 原始碼 → 更新 strings.json → 填寫平面語言環境 JSON (de.json,…) |
| 2 | translate-svg (選用) | 翻譯 config.svg 下的 SVG 文字 |
| 3 | translate-docs | 翻譯 markdown、MDX、.astro 頁面;Docusaurus 目錄 JSON;Nextra _meta / 字典 .ts;VitePress 主題目錄 |
| 4 | translate-json (選用) | 翻譯 json[] 下的巢狀 JSON 葉節點 |
每個管線都遵循相同的核心迴圈:提取區段 → 保護語法 → 批次處理 → 快取查詢或 LLM 呼叫 → 寫入輸出。中間的共用服務 — 設定、預留位置、快取、詞彙表、LlmClient — 在共用基礎設施下描述。
模組對應
| 層 | 資料夾 | 角色 |
|---|---|---|
| 入口 | src/cli/ | CLI 指令:init、extract、mark-html、translate-ui、translate-docs、translate-json、translate-svg、sync、status、dashboard,… |
| 管線 | src/extractors/ | 從 JS/TS、HTML 標記、Markdown、JSON、SVG、.astro 提取區段 |
src/processors/ | 預留位置保護、批次處理、驗證、連結重寫 | |
| 共用 | src/core/ | 設定、類型、SQLite 快取、提示、輸出路徑、語言環境工具 |
src/api/ | LlmClient — 與供應商無關的聊天用戶端 (Vercel AI SDK),具有模型備援 | |
src/glossary/ | 詞彙表載入、術語提示,以及用於提示詞的選用專案情境檔案 | |
src/utils/ | 記錄器、雜湊、忽略解析器、顯示寬度表格、.env 載入器 | |
| 您的應用程式執行階段 | src/runtime/ | i18next 輔助程式和顯示工具 — 匯出為 'ai-i18n-tools/runtime' (執行階段輔助程式) |
| 工具使用者介面 (內部測試) | src/i18n/、src/dashboard-app/、src/server/ | 本套件的 CLI 和翻譯儀表板的本地化 — 與您的專案內容分開 (自我本地化) |
所有用於程式化用途的內容都從 src/index.ts 重新匯出 (程式化 API)。
管線摘要
| 管道 | 區段 | 輸入 → 輸出 |
|---|---|---|
| UI 字串 | UI 字串內部 | 原始檔案 → strings.json → 平面 {locale}.json |
| 文件 | 文件內部 | Markdown / MDX / .astro / Docusaurus JSON → docs[].outputDir 下的每個地區設定檔案 |
| JSON 捆綁包 | JSON 內部 | json[] 下的巢狀 JSON → 每個地區設定的 JSON 檔案 |
| SVG | 文件內部 — 擷取器 | config.svg 下的 SVG 檔案 → 翻譯的 SVG 副本 |
UI 字串內部結構
| 步驟 | 元件 | 結果 |
|---|---|---|
| 1 | 原始檔案 (JS/TS;選用 .astro / .html) | 磁碟上的檔案 |
| 2 | UIStringExtractor (透過 ui-string-babel.ts 的 Babel) | 以 MD5 雜湊鍵控的片段 |
| 3 | strings.json | 主要目錄:{ hash: { source, translated, models?, locations? } } |
| 4 | LlmClient.translateUIBatch() | 原始字串的 JSON 陣列 → 翻譯 (+ 每批次的模型 ID) |
| 5 | de.json、pt-BR.json、… | 平面對應:原始字串 → 翻譯 (無模型中繼資料) |
UIStringExtractor
extractUiCallsFromFileContent 在 ui-string-babel.ts 中尋找 t("literal") 和 i18n.t("literal") 呼叫。JS 和 TS 檔案使用 @babel/parser 解析(模組原始碼、TypeScript 和 JSX)。對於 .astro 來源(當列於 ui.uiExtractor.extensions 中時),相同的函數會解析前置內容和範本 {expression} 區塊,並套用相同的 funcNames 規則。函數名稱和檔案副檔名可透過 ui.uiExtractor 設定(ui.reactExtractor 是支援的別名)。extract 也會將額外輸入合併到相同的目錄中: 當 includePackageDescription 啟用時(預設),專案的 package.json description;以及當 includeUiLanguageEnglishNames 為 true 時,來自捆綁的 ui-languages 主目錄(建立自 sourceLocale + targetLocales)的每個 englishName(已在原始碼中找到的字串保持優先;不讀取 languagesManifestPath)。extract 也會在 languagesManifestPath 重新產生 ui-languages.json。片段雜湊是修剪過的原始字串的 MD5 前 8 個十六進位字元 — 這些成為 strings.json 中的鍵。
對於 .html / .htm 來源 (當列於 ui.uiExtractor.extensions 中時),extract 會改為透過 html-i18n-marks.ts 路由檔案,後者會掃描 data-i18n / data-i18n-title / data-i18n-placeholder / data-i18n-alt / data-i18n-aria-label 標記屬性 (可透過 ui.uiExtractor.htmlI18nAttributes 配置)。裸標記會從元素本身的 textContent 或屬性中取得其原始文字;帶值標記 (data-i18n="Key") 則使用該值。data-i18n-locale-src 和 data-i18n-locale-href 保留給瀏覽器執行階段,永不提取。相同的模組驅動著 mark-html 命令,該命令會自動插入裸標記 (包括 alt 和 aria-label),且永不插入地區設定 URL 標記。HTML 檔案永不進入 Babel 處理階段。文件 outputDir 下產生的地區設定 HTML 會從此掃描中排除。
純 Astro SSG 網站可以略過 i18next:在建置時載入扁平的 {locale}.json,並透過來源文字索引鍵來解析 t('source text')。來源語言是 sourceLocale,且可以是任何語言 (請參閱 examples/astro-website/src/i18n/t.ts 和 UI 字串 — Astro 網站)。
純 HTML 應用程式遵循相同的目錄模型,帶有標記屬性而非 t() 呼叫 — 請參閱標記 HTML 以供翻譯。現成的指令碼為 ai-i18n-tools/html-runtime/i18n.js。
應成為每個地區設定一個檔案的靜態 HTML 屬於文件管線(translate-docs 內的 HtmlTemplateExtractor),而非此目錄。請參閱 HTML 頁面。
strings.json
主目錄的結構如下:
{
"a1b2c3d4": {
"source": "The English string",
"translated": {
"de": "Der deutsche Text",
"pt-BR": "O texto em português"
},
"models": {
"de": "anthropic/claude-3.5-haiku",
"pt-BR": "openai/gpt-4o"
},
"locations": [{ "file": "src/app/page.tsx", "line": 51 }]
}
}models(選用)— 每個語系中,該語系上次成功執行 translate-ui 後產生該翻譯的模型(若文字是從翻譯儀表板儲存的則為 user-edited)。locations(選用)— extract 找到該字串的位置(掃描器 + 套件描述行;內建主目錄 englishName 字串可省略 locations)。
extract 會新增索引鍵,並為掃描中仍存在的索引鍵(掃描器字面值、選用描述、選用內建主目錄 englishName)保留既有的 translated / models 資料。translate-ui 會填入缺失的 translated 項目、更新其翻譯之語系的 models,並寫入扁平的語系檔案。
ui-languages.json manifest — { code, label, englishName, direction } 的 JSON 陣列(BCP-47 code、UI label、參考 englishName、"ltr" 或 "rtl")。使用 generate-ui-languages 或 extract 從 sourceLocale + targetLocales 與內建主目錄 data/ui-languages-complete.json 建置專案檔。
扁平化地區設定檔案
每個目標地區設定都會獲得一個扁平化的 JSON 檔案 (de.json) 將來源字串對應到翻譯 (沒有 models 欄位):
{
"The English string": "Der deutsche Text",
"Save": "Speichern"
}i18next 會將這些載入為資源套件,並透過來源字串 (預設值即金鑰模型) 來查找翻譯。
UI 翻譯提示
buildUIPromptMessages 建置系統 + 使用者訊息,這些訊息會:
- 識別來源與目標語言(透過
localeDisplayNames或ui-languages.json的顯示名稱)。 - 當目標地區具有預期的書寫系統時(明確的 BCP-47 腳本,或語言預設值,例如
hi→ 天城文,ar→ 阿拉伯文,ja→ 日文假名/漢字),請在前面加上腳本指令。 - 傳送字串的 JSON 陣列,並要求傳回翻譯的 JSON 陣列。
- 可用時包含詞彙表提示。
LlmClient.translateUIBatch 依序嘗試每個模型,在剖析、網路或錯誤指令碼錯誤時回退 (包括針對原生指令碼地區設定的羅馬化/拉丁文回退)。CLI 會根據 localeModels、選用的 uiModels 和 translationModels 為每個目標地區設定建立該清單 (請參閱 AI 模型)。
文件內部結構
| 步驟 | 元件 | 結果 |
|---|---|---|
| 1 | Markdown / MDX / JSON / .astro 檔案 (translate-docs) | 原始檔案 |
| 2 | MarkdownExtractor / JsonExtractor / AstroTemplateExtractor | segments[] — 帶有雜湊 + 內容的類型化區段 |
| 3 | PlaceholderHandler | 受保護的文字 — HTML、提示、錨點、MDX、URL、行內程式碼、以標記遮罩的強調 |
| 4 | splitTranslatableIntoBatches | batches[] — 按計數 + 字元限制分組 |
| 5 | TranslationCache 查詢 | 快取命中 → 跳過;未命中 → LlmClient.translateDocumentBatch |
| 6 | PlaceholderHandler.restoreAfterTranslation | 最終文字 — 預留位置已還原 |
| 7 | resolveDocumentationOutputPath | 輸出檔案 — Docusaurus 版面配置或平面版面配置 |
提取器
所有提取器都會擴充 BaseExtractor 並實作 extract(content, filepath): Segment[]。
MarkdownExtractor- 將 markdown 分割為具類型的區段:frontmatter、heading、paragraph、code、admonition。YAML frontmatter 被歸類為不可翻譯 (slug、id和其他路由索引鍵保持穩定)。頂層export ...區塊 (例如 React 元件定義) 被歸類為不可翻譯的other區段,與現有的import ...處理方式並行。以大寫 JSX 標籤開頭的多行區塊 (例如<Tabs>區塊) 被歸類為可翻譯的段落。不可翻譯的區段 (程式碼區塊、原始 HTML) 會逐字保留。AstroTemplateExtractor- 針對.astro行銷頁面進行剖析和取代 (在doc-translate.ts中透過translateAstroFile使用translate-docs)。擷取使用者可見的 HTML 文字節點和可翻譯的屬性 (alt、title、aria-label、placeholder),以及範本{expression}區塊內使用者可見的字串常值。略過 frontmatter TypeScript、<script>、<style>、受保護的屬性/索引鍵值,以及t('…')內的常值。當輸出路徑較深時 (例如src/pages/de/index.astro),重新組合會調整相對匯入。請參閱 Astro 網站頁面。JsonExtractor- 從 Docusaurus JSON 標籤檔案中擷取字串值 (Docusaurus UI 目錄,而非 MDX 主體)。SvgExtractor- 從 SVG 擷取<text>、<title>和<desc>內容 (由translate-svg用於config.svg下的檔案,而非translate-docs)。html-i18n-marks.ts- 一個專注的 HTML 標記掃描器,由extract用於.html/.htm來源,並由mark-html命令使用。collectHtmlI18nStrings/collectHtmlI18nLocations讀取data-i18n*標記屬性(純標記 → 元素textContent/title/placeholder;有值標記 → 該值),而markHtmlContent會將純標記插入到葉面文字 / 標題 / 預留位置元素中(結果相同,尊重data-i18n-ignore,並略過類似程式碼和混合內容的元素)。共用的normalizeI18nText輔助工具可確保建置時的索引鍵與瀏覽器執行階段的索引鍵相同。
Astro 混合網站 (UI + 頁面 HTML)
純 Astro 應用程式通常在一個設定中同時啟用 UI 字串和文件(參考:examples/astro-website/):
| 層 | 機制 | 輸出 |
|---|---|---|
| 範本 HTML | AstroTemplateExtractor + translate-docs | docs[].outputDir 下的每個地區設定 .astro |
Frontmatter / t('…') | ui-string-babel.ts + extract + translate-ui | 扁平 public/locales/{locale}.json (來源語言字串作為索引鍵;sourceLocale 可以是任何語言) |
sync 命令會依序執行已啟用的步驟:提取,然後是 翻譯 UI(當 features.translateUIStrings 時)→ 可選的 翻譯 SVG → 翻譯文件 → 可選的 翻譯 JSON(除非使用 --no-ui、--no-svg、--no-docs 或 --no-json 跳過)。初始化模板 ui-astro-website 僅搭建 UI 字串;新增 docs[] 和 features.translateDocs 以用於頁面 HTML。
標題錨點插入 (write-heading-ids CLI)
write-heading-ids 命令是一個 本機、非 LLM 的文件 Markdown 預處理器。實作方式:src/cli/write-heading-ids.ts 負責協調檔案發現;src/markdown/write-heading-ids-core.ts 解析行內容並插入錨點。
它需要一個有效的設定,內含至少一個 at least one docs[] block。對於每個區塊,它會收集 contentPaths 下的 .md / .mdx 檔案,套用專案的 .translate-ignore 規則(概念與文件翻譯相同),並可選擇使用 --path / --file 限制於子樹狀結構。每個檔案都會透過 applyHeadingAnchorsToMarkdown 進行轉換:對於每個位於圍欄程式碼區塊外的 flat ATX heading(# … 至 ###### …),任何形式的現有標題 ID 都會被替換為所選樣式。HTML 樣式會在無後綴標題的上一行寫入 <a id="slug"></a>;--slug-style mdx-comment 會在標題行寫入 {/* #slug */}(並移除前面的 HTML 錨點)。Slug 一律取自目前的標題文字。--remove 會移除 HTML 錨點、傳統的 {#id} 後綴,以及 MDX 註解 ID,而不寫入新的。Slug 演算法符合常見的生態系統 — github(預設)、bitbucket、gitlab、pymdown(可選的 Unicode 正規化 / 百分比編碼旗標)、azure-devops,以及 mdx-comment(github slug + MDX 註解輸出)— 這樣錨點 ID 就能與現有工具保持一致(doctoc、PyMdown、Docusaurus 等)。--dry-run 會報告將進行的編輯而不實際寫入。
在來源遍歷之後,同一指令會將這些英文 id 重新定位到各語系現有的翻譯 markdown(resolveTranslatedOutputPath)上。翻譯後的標題絕不會重新產生 slug;標題中間的 {#id} / {/* #id */} 會被移回至所選樣式預期的後綴(或 HTML 錨點)位置。缺少的語系檔案會被略過。
此命令不會在 translate-docs 或 sync 中執行;當您希望在翻譯或發佈前,原始檔案中有穩定的片段 ID 時,請明確執行此命令。
佔位符保護
在翻譯之前,敏感語法會被替換為不透明的 token,以防止 LLM 損壞,按此順序套用(還原是反向的):
- 圍欄式程式碼區塊(三個或更多反引號或波浪號,包括一個較長的圍欄包覆較短的圍欄)- 整個圍欄,包括資訊字串,會被替換為
{{CDF_N}}並與其他結構性標記保持順序。這會將::: code-group或::: tip等容器內的範例固定在原位。圍欄資訊字串(VitePress 標籤)會保留原始語言。未關閉的開頭標記會保留為文字,以避免後續的容器關閉標記被吞噬。 - 標題 ID 尾碼(傳統的
{#id}/ MDX{/* #id */}位於 ATX 標題末尾)— 會從該行完全剝離,且不會傳送給模型。恢復後,它們會被重新釘選到匹配標題的末尾,以便 Docusaurus 仍能識別有效的 ID。標題中間的註解會保留在文字中,並由後續的 MDX /{#…}層處理。遮罩圍欄內的標題不會被剝離。 - HTML 標籤和註解(
<strong>、<!-- ... -->等)- 來自已知允許清單的小寫 HTML 標籤會被替換為{{HTM_N}}標記。大寫的 JSX 標籤(<Highlight>、<Tabs>、</Tab>)會由 MDX 層(步驟 6)單獨處理。 - 警示標記(
:::note、:::)- 只有開頭行的指令前綴會被替換為{{ADM_OPEN_N}};任何同行的標題會留給模型翻譯。恢復時會使用確切的原始文字。 - 文件錨點 (HTML
<a id="…">、殘留的標題中 Docusaurus{#…}) - 逐字保留。 - 僅限 MDX 的結構 (
src/processors/mdx-placeholders.ts):- MDX 註解 (
{/* … */},包括非行尾後綴的標題中{/* #my-id */}) 被{{MDX_N}}取代。 - 大寫的 JSX 標籤 (
<Highlight>、<Tabs>、<TabItem>、<TOCInline />、</Highlight>) - 保留為{{MDX_N}},具有可翻譯的字串屬性 (label、tooltip、aria-label),在標籤內重寫為{{JXA_N}},除非屬性名稱出現在docs[].protectAttributes中;<Tabs values={[ { label: '…' } ]}>物件字面值內的label:(可透過docs[].protectKeys跳過) 以及<TabItem value="…">(當不存在label屬性時,跳過小寫的 slug 類值) 也會被擷取。作為||JXA_N: …||行附加到區段,由restoreMdx合併回來。 - MDX 大括號運算式 (
{frontMatter.title}、style={{…}}) - 深度感知匹配,被{{MDX_N}}取代。
- MDX 註解 (
- Markdown URL (
](url)、src="…") - 翻譯後從對應表中還原。 - 行內程式碼範圍 (
`code`) 和粗體包覆的行內程式碼 (**code**) - 保留。 - Markdown 強調 (選用,為 CJK/RTL 語系自動啟用) - 強調分隔符會被遮罩。
模型傳回後,translate-docs 會還原對應表並驗證區段:必須存在相同的雙大括號權杖多重集,結構性權杖 ({{HTM_N}}、告誡標記、{{CDF_N}}) 必須保持其有序的子序列 (內容權杖例如 {{ILC_N}} / {{URL_N}} / {{SE}} 可隨字序移動),還原的 HTML 標籤種類必須與未受保護的來源相符,且任何剩餘的雙大括號識別碼都必須已存在於來源中 (因此自創的權杖會失敗)。文件提示也會要求模型將每個權杖複製一次、保持結構性權杖的順序,且不要自創新的雙大括號包裝器;機械式檢查仍具權威性。
Astro 模板和 MDX JSX 的共享屬性/鍵保護在 src/processors/expression-attribute-protection.ts 中實現,並由 docs[].protectAttributes 和 docs[].protectKeys 按區塊驅動(請參閱 protectAttributes / protectKeys)。
快取(TranslationCache)
SQLite 資料庫(透過 node:sqlite)儲存列,其金鑰為 (source_hash, locale),包含 translated_text、model、filepath、last_hit_at 和相關欄位。雜湊是正規化內容(空白字元折疊)的前 16 個十六進位字元的 SHA-256。
每次執行時,區段會依雜湊 × 地區設定進行查詢。只有快取未命中才會傳送至 LLM。翻譯後,針對目前翻譯範圍中未命中的區段列,last_hit_at 會重設。文件翻譯期間成功的快取命中會清除該區段的過時 translation_failures 列。
cleanup 會先執行 sync --force-update,然後:
- 移除過時的區段列 (空值
last_hit_at/ 空檔案路徑); - 當解析的來源路徑在磁碟上遺失時,修剪
file_tracking鍵 (例如doc-block:…、json-block:…、svg-files:…等); - 移除其中繼資料檔案路徑指向遺失檔案的翻譯列;
- 修剪孤立的
translation_failures列; - 修剪其解析的來源路徑在磁碟上遺失的孤立
markdown_source_issues列; - 捨棄設定中不存在的地區設定的快取列 (
sourceLocale、根targetLocales,以及任何每個區塊的docs[]/json[]targetLocales);(僅限 SQLite — 使用purge-locale刪除產生的檔案)。
除非傳遞 --backup <path>,否則它不會備份 cache.db,這會先將備份寫入該路徑。
計費的模型呼叫(已接受的翻譯與已捨棄的重試)會儲存在 api_calls 中。在執行記錄呼叫的命令後,超過七個 UTC 曆日的詳細資料列會彙總至月度 api_totals。usage 與儀表板的「使用量與成本」檢視會合併這兩個資料表。請參閱使用量與成本。
詞彙表Context備註和glossary.contextFiles會被建立指紋(prompt_context_hash),並注入到使用者介面、文件、JSON、SVG 和校對提示中。更改該指引會使下次執行時,相符的快取區段和檔案追蹤列失效。儀表板user-edited快取列會被保留。僅更改非強制列上的首選詞彙表翻譯,會保留現有快取,直到--force/--force-update。Force列僅在儲存的文字尚未包含強制翻譯時,對於來源包含該術語的區段會遺失快取,並且對於輸出仍缺少該術語的檔案,會拒絕未變更檔案跳過。將該列上的Context留空;上下文備註仍會重新整理整個地區設定。Markdown 也會拒絕遺漏引用之兩到五個字的使用者介面標籤 (目錄鍵或預設標籤形狀前綴) 的翻譯區段。引用可以是粗體、行內程式碼、標題,或僅包含該標籤的行。句子中的標題大小寫是一個提示,因此翻譯可以進行詞形變化 (印地語Cursor account可能會變成कर्सर खाते,而不是字典形式कर्सर खाता)。單一內容字詞標籤 (例如Sign in) 仍然是提示。該檢查會忽略翻譯中的大小寫,因此當來源引用時,句子中的小寫標籤仍然計數。使用相同字詞的普通散文可能會對其進行詞形變化。預設前綴必須是首字母大寫的標籤,其共享翻譯是一個不含佔位符的短語;句子詞幹不會被預設。該檢查會重試下一個模型,並且不會分割區段。
translate-docs 命令也使用 檔案追蹤,因此未變更的來源若已有現成且最新的輸出,則可完全跳過工作。--check-cache 會以預期的書寫系統重新開啟地區設定,以便重新驗證快取的區段;--force-update 會針對每個地區設定重新執行檔案處理,同時仍使用區段快取;--force 會清除檔案追蹤並略過 API 翻譯的區段快取讀取。當針對 Markdown 區段嘗試的模型未能通過 AST 驗證時,translate-docs 可以逐步分割區段並重試較小的部分 (docs[].segmentSplitting.qualityRetrySplit,預設啟用)。相同的品質錯誤發生三次會提早結束該模型清單。請參閱 文件 — 快取行為與旗標 以取得完整的旗標表格。
批次提示格式: translate-docs --prompt-format 僅為 LlmClient.translateDocumentBatch 選擇 XML (<seg> / <t>) 或 JSON 陣列/物件形狀;提取、佔位符和驗證保持不變。請參閱 批次提示格式。
輸出路徑解析
resolveDocumentationOutputPath(config, cwd, locale, relPath, kind) 將相對於來源的路徑對應至輸出路徑:
nested樣式(預設):用於 Markdown 的{outputDir}/{locale}/{relPath}。doc-system樣式:在docsRoot下,輸出使用{outputDir}/{locale}/[localeSubpath/]{relativeToDocsRoot};docsRoot以外的路徑會回溯到巢狀佈局。別名:docusaurus(預設localeSubpath= Docusaurus 外掛程式路徑)、astro-starlight(預設為空localeSubpath)、vitepress(與doc-system相同,但localeSubpath為空;保留 BCP-47 資料夾大小寫)。flat樣式:{outputDir}/{stem}.{locale}{extension}。當flatPreserveRelativeDir為true時,來源子目錄會保留在outputDir下。- 自訂
pathTemplate:任何使用{outputDir}、{locale}、{LOCALE}、{relPath}、{stem}、{basename}、{extension}、{docsRoot}、{relativeToDocsRoot}的 Markdown 佈局。 - 自訂
jsonPathTemplate:為 JSON 標籤檔案提供獨立的自訂佈局,使用相同的佔位符。 linkRewriteDocsRoot協助平面連結重寫器在翻譯輸出位於預設專案根目錄以外的位置時計算正確的前置詞。
平面連結重寫
當 docsOutput.style === "flat" 時,翻譯後的 markdown 檔案會與源檔案並排放置,並帶有語系後綴。頁面之間的相對連結會被改寫,使 readme.de.md 中的 [Guide](./guide.md) 指向 guide.de.md。由 rewriteRelativeLinks 控制(扁平樣式且無自訂 pathTemplate 時自動啟用)。同一遍次會在 postProcessing.regexAdjustments 執行前,為非 markdown 資源 URL 加上按檔案深度的前綴 — 參見扁平連結改寫器。
JSON 內部結構
| 步驟 | 元件 | 結果 |
|---|---|---|
| 1 | json[].contentPaths | 檔案已解析(檔案、目錄或 glob) |
| 2 | NestedJsonExtractor | 字串葉子由 keyPolicy 選取(點路徑 + minimatch) |
| 3 | PlaceholderHandler + 批次 + TranslationCache | 快取命中 → 跳過;未命中 → LlmClient.translateDocumentBatch (共享 SQLite) |
| 4 | NestedJsonExtractor.reassemble | 透過 expandJsonBlockOutputPath(outputPathTemplate) 輸出檔案 |
NestedJsonExtractor(src/extractors/nested-json-extractor.ts) 遍歷任意巢狀 JSON,並為每個可翻譯的字串葉節點發出一個區段。keyPolicy.mode(allowlist、denylist或both) 使用點符號上的 minimatch 過濾路徑(像slug這樣的裸名稱匹配最終的鍵區段)。- 快取檔案追蹤使用
json-block:{blockIndex}:{projectRelPath}在file_tracking中(與文件和 SVG 相同的cacheDir)。 - 不適用於 Docusaurus
write-translations目錄 ({ message, description }形狀) — 這些使用文件 (docs[].docusaurusCatalogDir+JsonExtractor在translate-docs內部)。 - 不適用於
t()UI 字串 — UI 字串 (strings.json+ 扁平套件)。 - CLI:
translate-json;協調在src/cli/translate-json-run.ts。初始化範本:ui-json-bundles。
共用基礎結構
LlmClient
基於 Vercel AI SDK(ai + @ai-sdk/openai-compatible)建置的提供者無關的聊天用戶端。它會從 provider / providers 解析作用中的提供者,為該提供者的 baseUrl + API 金鑰建置一個 OpenAI 相容的用戶端(createOpenAICompatible),並透過 generateText 路由所有呼叫。OpenRouterClient 保留為已淘汰的別名。主要行為:
- 模型回退:依序嘗試解析清單中的每個模型;在請求或解析失敗時回退。每個目標語言環境都有其自己的解析鏈:如果已設定,則
localeModels(locale)優先,然後是uiModels(僅限 UI 管線),然後是translationModels。文件、JSON 和 SVG 翻譯會為每個語言環境建立一個使用非 UI 鏈的用戶端。bench-models命令則為每個已設定的 ID 建立一個單一模型用戶端 (translationModels、uiModels和localeModels的聯集;translationModels: [id],無回退),以便獨立計時和定價每個模型。 - 請求逾時:在作用中的提供者上為
requestTimeout(秒) 或requestTimeoutMs,否則為設定頂部的相同鍵 (預設 120 秒),透過AbortSignal.timeout中止每個請求。當 CLI 為check-models(任何提供者) 載入提供者的模型清單時,相同的值也適用於GET /models。選擇性的預檢篩選器 (用於捨棄未知模型 ID) 僅在作用中的提供者為 OpenRouter 時執行。 - OpenRouter 額外功能 (僅在
openrouter作用中時):透過provider請求欄位和HTTP-Referer/X-Title標頭進行吞吐量路由。每個提供者都會報告權杖使用量。OpenRouter 和 Cheaper Inference 也會傳回已計費的美元金額 (usage.cost;Cheaper Inference 回退至cheaper_inference.billing.billed_cost_usd)。當提供者省略該金額時,美元成本會從providers.<name>.modelPricing計算,然後是提供者範圍的pricing預設值,然後是 models.dev 的輸入和輸出定價,並儲存在api_calls列上。提供者報告的成本 (包括0) 絕不會被取代。未知成本保持未設定。定價呼叫僅讀取<cacheDir>/benchmark-scores.json的 models.dev 片段;它不會下載 languagebench 或 Arena 檔案。 - 偵錯流量日誌:如果設定了
debugTrafficFilePath,則將請求和回應 JSON 附加到檔案 (程式化)。CLI--debug-failed會在cacheDir下寫入FAILED-TRANSLATION檔案,其中包含系統/使用者提示、原始助理回覆,以及針對失敗的 UI、文件、JSON 和 SVG 翻譯檢查嘗試的驗證錯誤。提供者 API / 空主體失敗會在控制台列印,而不是傾印僅包含提示的檔案。
suggest-models 和儀表板的「模型」分頁不會呼叫 LLM。它們會使用來自 languagebench ChrF 和 LMArena Arena Score 的品質指數,對活躍供應商的聊天目錄進行排名。價格是 3:1 的混合費率,以每百萬個權杖的美元計價(目錄、models.dev,然後是 languagebench)。--quality 依指數排序;--price 則沿著品質-價格的帕累托前沿移動。它們可以選擇性地取代 providers.<name>.translationModels。聚合資料位於 <cacheDir>/benchmark-scores.json 中。請參閱 AI 模型 和 suggest-models。
設定載入
loadI18nConfigFromFile(configPath, cwd) 管道:
- 讀取並剖析
ai-i18n-tools.config.json(JSON)。 mergeWithDefaults— 與defaultI18nConfigPartial深度合併,並將任何docs[].sourceFiles項目合併至contentPaths。expandTargetLocalesFileReferenceInRawInput— 將targetLocales強制轉換為陣列,並拒絕路徑狀項目(必須為 BCP-47 代碼,而非通往ui-languages.json的路徑);在mergeWithDefaults期間,languagesManifestPath預設為{ui.flatOutputDir}/ui-languages.json。expandDocumentationTargetLocalesInRawInput— 對每個docs[].targetLocales項目執行相同操作。expandJsonTargetLocalesInRawInput- 每個json[].targetLocales條目都相同。parseI18nConfig- Zod 驗證 +validateI18nBusinessRules。applyProviderOverrideToRawInput- 當-P/--provider在 CLI 上傳遞時。applyEnvOverrides- 設定時應用OPENROUTER_BASE_URL、OLLAMA_BASE_URL、I18N_SOURCE_LOCALE和I18N_TARGET_LOCALES(API 金鑰在LlmClient內部為每個提供者單獨解析)。augmentConfigWithUiLanguagesMaster- 從捆綁的主目錄中附加清單顯示名稱。assertEffectiveLocalesInUiLanguagesMaster- 在適用時根據主目錄驗證地區設定代碼。
init 會從 initConfigTemplates 寫入入門設定檔:ui-markdown (UI 字串加上單層 README 區塊)、docs-markdown (僅 README 與 Markdown)、ui-docusaurus、ui-starlight、ui-vitepress (VitePress 文件 + vitepressThemeCatalog)、ui-nextra (Nextra 文件 + nextraDictionaryPath)、ui-astro-website (純 Astro UI;新增 docs[] 以進行 .astro 頁面翻譯)、ui-json-bundles (僅 JSON json[])、ui-python、ui-python-gettext、ui-python-django 及 ui-python-flask。--with-readme 會將相同的 README 區塊附加至任何尚未列出 README.md 的範本,並開啟 translateDocs。請參閱 UI 字串 — 初始化、將 i18n 新增至您的 README 與 Markdown 文件 及 Python 應用程式。
記錄器
Logger 支援 debug、info、warn、error 層級,並帶有 ANSI 顏色輸出。詳細模式(-v)啟用 debug。當設定了 logFilePath 時,記錄行也會寫入該檔案。
自我本地化 (工具使用者介面)
此工具會將其自己的使用者介面 — CLI 說明、高流量日誌/摘要/錯誤訊息,以及翻譯儀表板 — 與其為您翻譯的內容分開進行本地化。
- 地區設定解析 (
resolveUiLocale於src/core/ui-locale.ts):從-L/--ui-lang>AI_I18N_LANG> 設定uiLanguage> 主機作業系統地區設定 (Intl.DateTimeFormat().resolvedOptions().locale) 中選取 UI 地區設定。候選項目會正規化,並與隨附的套件集完全比對或依最接近的變體比對 (例如pt-PT→pt-BR、en-US→en-GB),回退至來源地區設定 (en-GB)。CLI 會在建置說明之前 (預先剖析 argv 掃描) 解析一次,並在載入設定後再次解析,以便uiLanguage適用 (旗標和環境變數仍然優先)。 - 執行階段 (
src/i18n/index.ts):具有{{name}}內插的最小t(source, vars),透過英文來源字串對應src/i18n/locales/<code>.json中扁平的每個地區設定套件 (在建置時複製到dist/i18n/locales)。遺失的鍵或套件會傳回來源文字。這與 UI 字串的「鍵即預設值」模型相同 — 沒有雜湊查詢。 - 儀表板:伺服器會公開
GET /api/ui-i18n,傳回解析的 UI 地區設定的{ locale, dir, bundle };前端會設定<html lang>/dir,並透過data-i18n*屬性本地化靜態標記。 - 內部測試:套件由
pnpm i18n:self(sync-ui --ui-block src/i18n/strings.json) 產生,它會擷取並翻譯ai-i18n-tools.config.json中的 CLI 和儀表板ui區塊。目錄鍵來自src/cli/和src/i18n/中的t()呼叫,以及src/dashboard-app/index.html中儀表板的data-i18n*標記。
擴充點
自訂函式名稱(UI 提取)
透過設定新增非標準翻譯函式名稱:
{
"ui": {
"uiExtractor": {
"funcNames": ["t", "i18n.t", "translate", "i18n.translate"],
"extensions": [".js", ".jsx", ".ts", ".tsx", ".astro", ".html"],
"htmlI18nAttributes": ["data-i18n", "data-i18n-title", "data-i18n-placeholder", "data-i18n-alt", "data-i18n-aria-label"]
}
}
}(ui.reactExtractor 是 ui.uiExtractor 的完全支援別名。)
將 .html / .htm 加入 extensions 中,以便在 extract 期間掃描 HTML 標記屬性。ui.uiExtractor.htmlI18nAttributes 是選用的,預設為 ["data-i18n", "data-i18n-title", "data-i18n-placeholder"];data-i18n 對應到元素的 textContent,而 data-i18n-<attr> 對應到該屬性的值(例如 data-i18n-aria-label)。
自訂提取器
實作套件中的 ContentExtractor:
import { BaseExtractor, type Segment } from 'ai-i18n-tools';
class MyExtractor extends BaseExtractor {
readonly name = 'my-format';
canHandle(filepath: string) { return filepath.endsWith('.myext'); }
extract(content: string, filepath: string): Segment[] { /* … */ }
reassemble(segments: Segment[], translations: Map<string, string>): string { /* … */ }
}透過擴展從 'ai-i18n-tools' 匯出的公共提取器類別來註冊自訂提取器(例如子類別 MarkdownExtractor)。CLI 在內部連接內建提取器;不支援深度匯入 doc-translate.ts。
自訂輸出路徑
對任何檔案配置使用 docsOutput.pathTemplate:
{
"docs": [
{
"docsOutput": {
"pathTemplate": "{outputDir}/{locale}/{relativeToDocsRoot}"
}
}
]
}原始碼樹
完整的 src/ 版面配置(檔案級參考)
src/
├── index.ts Public API re-exports
│
├── cli/
│ ├── index.ts CLI entry point (commander)
│ ├── extract-strings.ts `extract` command implementation
│ ├── mark-html.ts `mark-html` command (insert bare `data-i18n*` markers into HTML)
│ ├── translate-ui-strings.ts `translate-ui` command implementation
│ ├── doc-translate.ts `translate-docs` command (documentation files only)
│ ├── translate-json-run.ts `translate-json` command (`json[]` nested locale bundles)
│ ├── translate-svg.ts `translate-svg` command (SVG files from `config.svg`)
│ ├── write-heading-ids.ts `write-heading-ids` command (markdown heading anchors)
│ ├── bench-models.ts `bench-models` command (per-model translate latency/token/cost benchmark)
│ ├── helpers.ts Shared CLI utilities
│ └── file-utils.ts File collection helpers
│
├── markdown/
│ └── write-heading-ids-core.ts Slug styles + `<a id="…">` insertion for `write-heading-ids`
│
├── core/
│ ├── types.ts Zod schemas + TypeScript types for all config shapes
│ ├── config.ts Config loading, merging, validation, init templates
│ ├── cache.ts SQLite translation cache (node:sqlite)
│ ├── prompt-builder.ts LLM prompt construction for docs and UI strings
│ ├── output-paths.ts Docusaurus / flat output path resolution
│ ├── ui-languages.ts ui-languages.json loading and locale resolution
│ ├── ui-locale.ts Resolve the tool's own UI locale (flag/env/config/OS → shipped bundle)
│ ├── locale-utils.ts BCP-47 normalisation, locale list parsing, script/Han-variant validation
│ └── errors.ts Typed error classes
│
├── extractors/
│ ├── base-extractor.ts Abstract base class for all extractors
│ ├── ui-string-extractor.ts JS/TS and `.astro` UI scanner (Babel via `ui-string-babel.ts`)
│ ├── ui-string-babel.ts Babel `t()` discovery (`extractUiCallsFromFileContent`)
│ ├── ui-string-locations.ts Source locations for extracted UI strings
│ ├── html-i18n-marks.ts HTML `data-i18n*` marker scanner + `mark-html` annotator
│ ├── classify-segment.ts Heuristic segment type classification
│ ├── markdown-extractor.ts Markdown / MDX segment extraction
│ ├── markdown-segment-split.ts Optional segment splitting for long markdown blocks
│ ├── frontmatter-fields.ts Selective YAML front matter field translation
│ ├── astro-template-extractor.ts `.astro` parse-and-replace (HTML + template expressions; used by `translate-docs`)
│ ├── json-extractor.ts Docusaurus catalog JSON extraction (`translate-docs`)
│ ├── nested-json-extractor.ts Arbitrary nested JSON leaves (`translate-json`, `json[]`)
│ └── svg-extractor.ts SVG text extraction
│
├── processors/
│ ├── placeholder-handler.ts Chain: HTML → admonitions → anchors → MDX → URLs → emphasis
│ ├── expression-attribute-protection.ts Shared protected attribute/key lists (Astro + MDX JSX)
│ ├── url-placeholders.ts Markdown URL protection/restore
│ ├── admonition-placeholders.ts Docusaurus admonition protection/restore
│ ├── anchor-placeholders.ts HTML anchor / heading ID protection/restore
│ ├── html-tag-placeholders.ts Lowercase HTML tag / comment protection ({{HTM_N}})
│ ├── placeholder-integrity.ts Pre/post-restore token sequence + tag-kind + invented {{IDENT}} checks
│ ├── mdx-placeholders.ts MDX comments, JSX tags, brace expressions, JSX attribute extraction
│ ├── batch-processor.ts Segment → batch grouping (count + char limits)
│ ├── validator.ts Post-translation structural checks
│ └── flat-link-rewrite.ts Relative link rewriting for flat output
│
├── api/
│ ├── llm-client.ts LlmClient: provider-agnostic chat client (AI SDK) with model fallback chain
│ └── provider-models-catalog.ts Fetch/parse any provider's OpenAI-compatible GET /models catalog
│
├── glossary/
│ ├── glossary.ts Glossary loading (CSV + auto-build from strings.json)
│ ├── matcher.ts Term hint extraction for prompts
│ └── translation-context.ts contextFiles loader and guidance fingerprints
│
├── runtime/
│ ├── index.ts Runtime re-exports
│ ├── template.ts interpolateTemplate, flipUiArrowsForRtl
│ ├── ui-language-display.ts getUILanguageLabel, getUILanguageLabelNative
│ └── i18next-helpers.ts RTL detection, i18next setup factories
│
├── i18n/ Self-localisation runtime for the tool's own UI
│ ├── index.ts t(source, vars) + bundle/manifest loaders (keyed by English source string)
│ └── locales/ Shipped UI bundles (de.json, es.json, …; generated by `pnpm i18n:self`)
│
├── dashboard-app/
│ ├── index.html Translation Dashboard static UI (HTML/CSS/JS)
│ ├── app.js
│ └── styles.css
│
├── server/
│ └── translation-dashboard.ts Express app for Translation Dashboard (cache / strings.json / glossary)
│
└── utils/
├── logger.ts Leveled logger with ANSI support
├── hash.ts Segment hash (SHA-256 first 16 hex)
├── table.ts Display-width aware table rendering (CJK/emoji column alignment)
├── load-dotenv.ts Load `.env` / `.env.local` beside the config when no API key is set
└── ignore-parser.ts .translate-ignore file parser