feat(i18n): add OpenAPI translation pipeline and localized specs #1249
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -69,6 +69,16 @@ const addedRaw = gitLines( | |
| const changedFiles = filterEnglish(changedRaw.filter((f) => f.endsWith(".mdx"))); | ||
| const deletedFiles = filterEnglish(deletedRaw.filter((f) => f.endsWith(".mdx"))); | ||
| const addedFiles = filterEnglish(addedRaw.filter((f) => f.endsWith(".mdx"))); | ||
| const openapiSources = (CONFIG.openapi_specs ?? []).map((spec) => spec.source); | ||
| const changedOpenApiSources = changedRaw.filter((file) => openapiSources.includes(file)); | ||
|
|
||
| function localizedOpenApiSource(source, langCode) { | ||
| if (!source || langCode === "en") return source; | ||
| if (/\.en\.(ya?ml|json)$/i.test(source)) { | ||
| return source.replace(/\.en\.(ya?ml|json)$/i, (_, ext) => `.${langCode}.${ext}`); | ||
| } | ||
| return source.replace(/\.(ya?ml|json)$/i, (_, ext) => `.${langCode}.${ext}`); | ||
| } | ||
|
Comment on lines
+75
to
+81
There was a problem hiding this comment. 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win
This is the same DRY concern raised on See the proposed consolidation in the comment on 🤖 Prompt for AI Agents |
||
|
|
||
| const allDiffNames = gitLines(`git diff --name-only ${baseSha} ${headSha}`); | ||
| const acmrtNames = gitLines( | ||
|
|
@@ -87,9 +97,10 @@ const renamedDestinations = renameLines | |
| if ( | ||
| changedFiles.length === 0 && | ||
| deletedFiles.length === 0 && | ||
| addedFiles.length === 0 && | ||
| changedOpenApiSources.length === 0 | ||
| ) { | ||
| console.log("No English MDX or OpenAPI source files changed outside translation directories. Skipping check."); | ||
| writeOutput({ skipped: true, missingByLang: {}, movedFiles: [] }); | ||
| process.exit(0); | ||
| } | ||
|
|
@@ -154,6 +165,16 @@ for (const lang of languages) { | |
| missing.push(langFile); | ||
| } | ||
|
|
||
| for (const source of changedOpenApiSources) { | ||
| const langFile = localizedOpenApiSource(source, lang.code); | ||
| if (acmrtNames.includes(langFile)) { | ||
| console.log(`✅ [${lang.code}] Found OpenAPI translation update: ${langFile}`); | ||
| continue; | ||
| } | ||
| console.log(`❌ [${lang.code}] Missing OpenAPI translation update: ${langFile}`); | ||
| missing.push(langFile); | ||
| } | ||
|
|
||
| if (missing.length > 0) { | ||
| missingByLang[lang.code] = { name: lang.name, files: missing }; | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| import { describe, expect, test } from "bun:test"; | ||
| import { | ||
| applyTranslations, | ||
| extractTranslatableStrings, | ||
| localizedOpenApiSource, | ||
| sidecarPathForOutput, | ||
| stringifyYamlSpec, | ||
| stripYamlHeader, | ||
| } from "./openapi-translate.ts"; | ||
|
|
||
| describe("localizedOpenApiSource", () => { | ||
| test("inserts language code before extension", () => { | ||
| expect(localizedOpenApiSource("openapi/cloud.en.yaml", "zh")).toBe( | ||
| "openapi/cloud.zh.yaml" | ||
| ); | ||
| expect(localizedOpenApiSource("openapi/registry.en.yaml", "ja")).toBe( | ||
| "openapi/registry.ja.yaml" | ||
| ); | ||
| expect(localizedOpenApiSource("openapi/cloud.en.yaml", "en")).toBe( | ||
| "openapi/cloud.en.yaml" | ||
| ); | ||
| }); | ||
| }); | ||
|
|
||
| describe("sidecarPathForOutput", () => { | ||
| test("uses openapi/.i18n/ directory", () => { | ||
| expect(sidecarPathForOutput("openapi/cloud.zh.yaml")).toBe( | ||
| "openapi/.i18n/cloud.zh.json" | ||
| ); | ||
| expect(sidecarPathForOutput("openapi/registry.ko.yaml")).toBe( | ||
| "openapi/.i18n/registry.ko.json" | ||
| ); | ||
| }); | ||
| }); | ||
|
|
||
| describe("extractTranslatableStrings", () => { | ||
| test("collects summary and description only", () => { | ||
| const spec = { | ||
| info: { title: "API", description: "Root description" }, | ||
| paths: { | ||
| "/users": { | ||
| get: { | ||
| summary: "List users", | ||
| description: "Returns all users", | ||
| operationId: "listUsers", | ||
| }, | ||
| }, | ||
| }, | ||
| components: { | ||
| schemas: { | ||
| User: { | ||
| type: "object", | ||
| properties: { | ||
| id: { type: "string", description: "User id" }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| expect(extractTranslatableStrings(spec)).toEqual({ | ||
| "info.description": "Root description", | ||
| "paths./users.get.summary": "List users", | ||
| "paths./users.get.description": "Returns all users", | ||
| "components.schemas.User.properties.id.description": "User id", | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe("stringifyYamlSpec", () => { | ||
| test("produces indented multi-line YAML", () => { | ||
| const yaml = stringifyYamlSpec({ | ||
| openapi: "3.0.3", | ||
| info: { title: "API", description: "Hello" }, | ||
| }); | ||
| expect(yaml.split("\n").length).toBeGreaterThan(3); | ||
| expect(yaml).toContain("openapi: 3.0.3"); | ||
| expect(yaml).toContain(" title: API"); | ||
| }); | ||
| }); | ||
|
|
||
| describe("stripYamlHeader", () => { | ||
| test("preserves translation metadata comments", () => { | ||
| const { header, body } = stripYamlHeader( | ||
| "# translationSourceHash: abc\n# translationFrom: x.yaml\n\nopenapi: 3.0.3\n" | ||
| ); | ||
| expect(header).toContain("translationSourceHash"); | ||
| expect(body).toContain("openapi: 3.0.3"); | ||
| }); | ||
| }); | ||
|
|
||
| describe("applyTranslations", () => { | ||
| test("replaces targeted strings without changing structure", () => { | ||
| const english = { | ||
| info: { description: "Hello" }, | ||
| paths: { "/x": { get: { summary: "Get X" } } }, | ||
| }; | ||
| const localized = applyTranslations(english, { | ||
| "info.description": "你好", | ||
| "paths./x.get.summary": "获取 X", | ||
| }); | ||
| expect(localized).toEqual({ | ||
| info: { description: "你好" }, | ||
| paths: { "/x": { get: { summary: "获取 X" } } }, | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
Repository: Comfy-Org/docs
Length of output: 19010
Correct the sidecar path note. Lines 67-72 describe the JSON sidecar as living beside each translated spec, but it is written under
openapi/.i18n/<basename>.json.🤖 Prompt for AI Agents