VS Code 1.101 以降が必要です。VS Code Web、remote/virtual workspace は対象外です。
初回の設定と同期
コマンドパレット(Windows/Linux: Ctrl+Shift+P、macOS: Cmd+Shift+P)から Docs Sync: Select Japanese Folder と Docs Sync: Select English Folder を実行し、対象フォルダを指定します。workspace 内の相対パス(例: docs/ja)または workspace 内の絶対パスを指定できます。初期値は ja と en です。2つのフォルダは異なる場所にし、互いを含まないようにしてください。
Docs Sync: Set Up Provider and API Key から OpenAI、Claude、Gemini の提供元・モデル・API key を設定します。翻訳本文の送信には別途許可が必要です。Custom API は HTTPS の JSON POST を受け付け、翻訳済み Markdown 文字列を返す必要があります。Custom API を使う場合は、user settings の docsSync.provider、docsSync.model、docsSync.endpoint、docsSync.apiProfile に値を設定し、Docs Sync: Register Provider API Key でkeyを登録して送信を許可してください。apiProfile では認証ヘッダー、リクエスト項目、応答から翻訳文字列を取り出す方法を指定します。
OpenAI、Claude、Gemini の提供元・モデル・keyを変更するときも同じセットアップコマンドを再実行します。現在の提供元には (current) が付き、モデルを入力し直して新しいkeyを登録できます。保存済みkeyの値は表示されません。Custom API の設定変更はuser settingsで行い、keyは Docs Sync: Register Provider API Key から再登録します。提供元やモデルを変更した場合、その設定に対する翻訳本文の送信許可を改めて確認してください。
翻訳元の UTF-8 .md ファイルを保存し、Japanese to English または English to Japanese を実行します。実行前に内容を確認するには Japanese to English with preview または English to Japanese with preview を使い、予定操作と送信する Markdown 本文を確認して Apply を選びます。Apply までは API を呼び出しません。
すべてコマンドパレットから実行できます。Docs Sync ビューには API 設定、両方向の同期、プレビュー実行、前回同期時の状態へ戻すボタンもあります。
操作
コマンド
日本語フォルダを選択・変更
Docs Sync: Select Japanese Folder
英語フォルダを選択・変更
Docs Sync: Select English Folder
API 提供元・モデル・keyを設定
Docs Sync: Set Up Provider and API Key
日本語から英語へ同期
Japanese to English
英語から日本語へ同期
English to Japanese
日本語から英語へ、事前確認して同期
Japanese to English with preview
英語から日本語へ、事前確認して同期
English to Japanese with preview
実行中の同期を中止
Docs Sync: Cancel Current Operation
直近の同期を元に戻す
Docs Sync: Undo Last Translation
日本語を前回同期時の状態に戻す
Docs Sync: Restore Japanese to Last Sync
英語を前回同期時の状態に戻す
Docs Sync: Restore English to Last Sync
現在の提供元のAPI keyを登録・変更
Docs Sync: Register Provider API Key
保存済みのAPI keyを削除
Docs Sync: Delete Provider API Key
翻訳本文の送信を許可
Docs Sync: Allow Translation Text Sending
送信許可を解除
Docs Sync: Clear Translation Send Permission
「前回同期時の状態に戻す」は、選択したフォルダの組の追跡済み文書を、ファイルごとの最後の成功同期時の内容へ戻します。対象件数と言語を確認して実行すると、その言語の保存済み編集を破棄します。手動で削除した追跡済み文書は再作成します。反対言語と同期の比較基準は維持し、翻訳APIやProvider設定は不要です。未保存の対象文書は安全停止します。未追跡文書や、同期による削除が確定して比較基準から除去された文書は対象外です。復元で変更を適用すると、以前の Undo Last Translation 用記録はクリアされます。
失敗時の確認
完了通知の Show Details から、Output の Docs Sync でファイル別の失敗理由と参考警告を確認できます。コードやURLなどの比較で差分があっても訳を適用し、警告として表示します。警告のみの場合は翻訳成功です。詳細には種類・Unit番号・件数を表示し、本文やAPI応答、保護文字列そのものは表示しません。
処理が長い場合は Docs Sync: Cancel Current Operation で中止できます。開発用デバッガーのブレークポイントで停止した場合は、続行するまで完了通知が出ません。
既存プロンプトでコード・URLなどを維持するよう指示し、自然な英語表現や空白・改行・Markdownの表記差を許容します。APIエラー、空応答、出力切断、Unitへの対応不能などの場合は適用を停止します。適用した訳は確認・編集でき、直近の同期は Docs Sync: Undo Last Translation で取り消せます。
データと制約
API key は VS Code SecretStorage に保存されます。API には翻訳対象の Markdown 本文を送信します。同期状態と Undo 用データには両言語の本文をローカル保存します。送信先は選択した提供元または自分で設定した Custom API です。送信を許可する前に、送信予定の本文とAPI提供元のデータ取り扱いを確認してください。
UTF-8 CommonMark/GFM の .md が対象です。ファイル上限は 1 MiB、翻訳 unit 上限は 16 KiB です。見出し #〜### を基準に分割し、1ファイル分を1つの論理 API リクエストで送信します。
追跡済み Markdown の削除は同期先にも反映します。Undo はフォルダの組ごとの直近 run が対象で、その後に編集されている場合は停止します。両側の変更を自動で統合する機能はありません。