翻訳生成ガイド

Payload には 2 つの独立した翻訳システムがあります:

1. コア翻訳 - Payload のコアパッケージ用 (packages/ui, packages/payload, packages/next)
2. プラグイン翻訳 - プラグイン用 (packages/plugin-*)

目次

• 1. コア翻訳
• 2. プラグイン翻訳
  • 新しいプラグイン翻訳のスカフォルディング
• 重要な注意事項

---

1. コア翻訳

使用時: Payload のコアパッケージに翻訳を追加する場合 (packages/ui, packages/payload, packages/next)

ステップ:

1. 英語翻訳を追加 packages/translations/src/languages/en.ts

   • 新しいキー/バリューを適切なセクション (例: authentication, general, fields など) に追加
   • 整理のためにネストされたオブジェクトを使用
   • 例:

     export const enTranslations = {
       authentication: {
         // ... 既存キー
         newFeature: 'New Feature Text',
       },
     }
     

2. クライアントキーを追加 (クライアント側の使用が必要な場合) packages/translations/src/clientKeys.ts

   • コロン記法を使用して翻訳キーパスを追加
   • 例: 'authentication:newFeature'
   • クライアントキーはブラウザで利用可能にする必要がある翻訳に使用

3. すべての言語の翻訳を生成

   • ディレクトリを変更: cd tools/scripts
   • 実行: pnpm generateTranslations:core
   • これにより新しい英語キーが他のすべてのサポート言語に自動翻訳されます

---

2. プラグイン翻訳

使用時: プラグインパッケージに翻訳を追加する場合 (packages/plugin-*)

ステップ:

1. プラグインに翻訳フォルダがあることを確認

   • packages/plugin-{name}/src/translations が存在するか確認
   • 存在しない場合は、下記の「新しいプラグイン翻訳のスカフォルディング」を参照

2. 英語翻訳をプラグインの翻訳ファイルに追加 packages/plugin-{name}/src/translations/languages/en.ts

   • プラグイン翻訳はプラグイン名でネームスペース化されます
   • plugin-multi-tenant の例:

     export const enTranslations = {
       'plugin-multi-tenant': {
         'new-feature-label': 'New Feature',
       },
     }
     

3. すべての言語の翻訳を生成

   • ディレクトリを変更: cd tools/scripts
   • プラグイン固有のスクリプトを実行: pnpm generateTranslations:plugin-{name}
   • 例:
     • pnpm generateTranslations:plugin-multi-tenant
     • pnpm generateTranslations:plugin-ecommerce
     • pnpm generateTranslations:plugin-import-export

新しいプラグイン翻訳のスカフォルディング

プラグインにまだ翻訳フォルダがない場合、ユーザーにスカフォルディングを行うかどうかを確認してください。

作成する構造:

packages/plugin-{name}/src/translations/
├── index.ts
├── types.ts
└── languages/
    ├── en.ts
    ├── es.ts
    └── ... (その他すべての言語ファイル)

作成するファイル:

1. types.ts - プラグインの翻訳型を定義
2. index.ts - すべての翻訳をエクスポートして型を再エクスポート
3. languages/en.ts - 英語翻訳 (生成の元となるもの)
4. languages/*.ts - その他の言語ファイル (初期状態は空、生成される)

作成する生成スクリプト:

1. tools/scripts/src/generateTranslations/plugin-{name}.ts を作成

   • plugin-multi-tenant.ts をテンプレートとして使用
   • インポートパスを新しいプラグインを指すように更新
   • targetFolder パスを更新

2. tools/scripts/package.json にスクリプトを追加:

   "generateTranslations:plugin-{name}": "node --no-deprecation --import @swc-node/register/esm-register src/generateTranslations/plugin-{name}.ts"
   

---

重要な注意事項

• すべての翻訳生成には OPENAI_KEY 環境変数を設定する必要があります
• 生成スクリプトは OpenAI を使用して英語から他の言語に翻訳します
• 常に英語に翻訳を追加してください - これは情報源です
• コア翻訳: クライアントキーは ブラウザ/管理 UI で使用される翻訳にのみ必要です
• プラグイン翻訳: プラグイン名の下に自動的にネームスペース化され、競合を回避します