Intlayerを使ってreact-i18nextのJSON翻訳を自動化する方法

Intlayerとは何ですか？

Intlayerは、従来のi18nソリューションの欠点を解決するために設計された革新的なオープンソースの国際化ライブラリです。Reactアプリケーションにおけるコンテンツ管理に対して、モダンなアプローチを提供します。

具体的な比較については、当社のブログ記事react-i18next vs. react-intl vs. Intlayerをご覧ください。

なぜIntlayerをreact-i18nextと組み合わせるのか？

Intlayerは優れた単独のi18nソリューションを提供します（当社のReact統合ガイドを参照）が、以下のような理由でreact-i18nextと組み合わせたい場合があります：

1. 既存のコードベース: 既に確立されたreact-i18nextの実装があり、Intlayerの改善された開発者体験に徐々に移行したい場合。
2. レガシー要件: プロジェクトが既存のreact-i18nextプラグインやワークフローとの互換性を必要とする場合。
3. チームの慣れ親しみ: チームがreact-i18nextに慣れているが、より良いコンテンツ管理を望んでいる場合。
4. Intlayerの機能利用: コンテンツ宣言、翻訳の自動化、翻訳のテストなど、Intlayerの機能を活用したい場合。

そのために、Intlayerはreact-i18nextのアダプターとして実装でき、CLIやCI/CDパイプラインでのJSON翻訳の自動化、翻訳のテストなどを支援します。

このガイドでは、react-i18nextとの互換性を維持しながら、Intlayerの優れたコンテンツ宣言システムを活用する方法を示します。

目次

react-i18nextとIntlayerをセットアップするステップバイステップガイド

ステップ1: 依存関係のインストール

必要なパッケージをインストールします:

npm install intlayer @intlayer/sync-json-plugin

パッケージの説明:

• intlayer: 国際化管理、コンテンツ宣言、およびビルドのためのコアライブラリ
• @intlayer/sync-json-plugin: Intlayerのコンテンツ宣言をreact-i18next互換のJSON形式にエクスポートするプラグイン

ステップ2: JSONをラップするためのIntlayerプラグインの実装

サポートするロケールを定義するためのIntlayer設定ファイルを作成します。

react-i18next用のJSON辞書もエクスポートしたい場合は、syncJSONプラグインを追加してください:

import { Locales, type IntlayerConfig } from "intlayer";import { syncJSON } from "@intlayer/sync-json-plugin";const config: IntlayerConfig = {  internationalization: {    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],    defaultLocale: Locales.ENGLISH,  },  plugins: [    syncJSON({      source: ({ key, locale }) => `./locales/${locale}/${key}.json`,    }),  ],};`export default config;

syncJSONプラグインはJSONを自動的にラップします。コンテンツの構造を変更することなく、JSONファイルの読み書きを行います。

もしJSONとintlayerのコンテンツ宣言ファイル（.contentファイル）を共存させたい場合、Intlayerは以下の手順で処理します：

1. JSONファイルとコンテンツ宣言ファイルの両方を読み込み、intlayerの辞書に変換します。
2. JSONとコンテンツ宣言ファイル間に競合がある場合、Intlayerはすべての辞書をマージします。プラグインの優先度やコンテンツ宣言ファイルの優先度に応じて処理されます（すべて設定可能です）。

CLIを使ってJSONの翻訳を変更した場合やCMSを使用した場合、Intlayerは新しい翻訳でJSONファイルを更新します。

syncJSONプラグインの詳細については、syncJSONプラグインのドキュメントを参照してください。

（オプション）ステップ3：コンポーネントごとのJSON翻訳の実装

デフォルトでは、IntlayerはJSONファイルとコンテンツ宣言ファイルの両方を読み込み、マージし、同期します。詳細については、コンテンツ宣言のドキュメントを参照してください。しかし、必要に応じてIntlayerプラグインを使用して、コードベースのどこにでもあるJSONのローカライズをコンポーネント単位で管理することも可能です。

そのためには、loadJSONプラグインを使用できます。

import { Locales, type IntlayerConfig } from "intlayer";import { loadJSON, syncJSON } from "@intlayer/sync-json-plugin";const config: IntlayerConfig = {  internationalization: {    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],    defaultLocale: Locales.ENGLISH,  },  // 現在のJSONファイルをIntlayerの辞書と同期させる  plugins: [    /**     * src内の{key}.i18n.jsonパターンに一致するすべてのJSONファイルを読み込みます     */    loadJSON({      source: ({ key }) => `./src/**/${key}.i18n.json`,      locale: Locales.ENGLISH,      priority: 1, // これらのJSONファイルが`./locales/en/${key}.json`のファイルより優先されることを保証します    }),    /**     * ローカルディレクトリ内のJSONファイルに出力と翻訳を書き戻しながら読み込みます     */    syncJSON({      source: ({ key, locale }) => `./locales/${locale}/${key}.json`,      priority: 0,    }),  ],};export default config;

これにより、src ディレクトリ内の {key}.i18n.json パターンに一致するすべての JSON ファイルが読み込まれ、Intlayer の辞書としてロードされます。

Git 設定

自動生成された Intlayer ファイルは無視することを推奨します：

# Intlayer によって生成されたファイルを無視する.intlayer

これらのファイルはビルドプロセス中に再生成可能であり、バージョン管理にコミットする必要はありません。

VS Code 拡張機能

開発者体験を向上させるために、公式の Intlayer VS Code 拡張機能 をインストールしてください：

VS Code マーケットプレイスからインストール