generate-translations

翻訳生成ガイド

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: {
         // ... existing keys
         newFeature: 'New Feature Text',
       },
     }
     

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

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

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

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

---

2. プラグイン翻訳

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

手順:

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

   • 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

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

プラグインにまだ translations フォルダーがない場合は、スキャフォールディングするかどうかをユーザーに確認してください。

作成する構造:

packages/plugin-{name}/src/translations/
├── index.ts
├── types.ts
└── languages/
    ├── en.ts
    ├── es.ts
    └── ... (all other language files)

作成するファイル:

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 で使用される翻訳にのみ必要です
• プラグイン翻訳: 競合を避けるために、プラグイン名の下に自動的に名前空間が設定されます