i18n-tasks gemでRailsの多言語対応を効率化する
概要
Railsの国際化（i18n）機能は、アプリケーションを多言語対応させるための強力な仕組みです。しかし、プロジェクトが成長するにつれて、config/localesディレクトリ内のYAMLファイルは肥大化し、管理が困難になります。
- 「この翻訳キーは、もうコードのどこからも使われていないのでは？」
- 「新しい機能を追加したけど、どの言語の翻訳が漏れているだろうか？」
- 「大量のキーを翻訳するのが大変...」
i18n-tasksは、このようなi18nにまつわる一般的な課題を解決するためのGemです。静的解析の力で、翻訳キーの利用状況を分析し、翻訳作業を強力にサポートします。
この記事では、i18n-tasksの導入方法と、日々の開発を効率化するための主要なコマンドを紹介します。
i18n-tasksの導入
Gemfileの:developmentグループにi18n-tasksを追加し、bundle installを実行します。
Gemfile
group :development do
gem 'i18n-tasks', '~> 1.0.0' # バージョンを指定することを推奨
end次に、設定ファイルを生成します。
$ cp $(bundle exec i18n-tasks gem-path)/config/i18n-tasks.yml config/これにより、config/i18n-tasks.ymlが作成され、i18n-tasksの挙動を細かくカスタマイズできるようになります。
主要なコマンドと使い方
i18n-tasksは、i18n-tasksというコマンドを提供します。bundle exec i18n-tasksで実行できます。
1. 翻訳の健康状態をチェック (health)
まず最初に実行すべきコマンドはhealthです。これは、翻訳ファイル全体の状態を診断し、問題点を報告してくれます。
$ i18n-tasks health出力例:
I18n-tasks is working with 2 locales: en, ja
Missing keys (1):
ja.users.show.title
Unused keys (2):
en.common.old_feature
ja.common.old_feature- Missing keys: 翻訳が不足しているキーを報告します。この例では、
jaロケールにusers.show.titleの翻訳がないことを示しています。 - Unused keys: コード中のどこからも使われていない（と思われる）翻訳キーを報告します。リファクタリングで不要になったキーを安全に削除するのに役立ちます。
2. 不足している翻訳の追加 (missing)
missingコマンドを使うと、不足しているキーを一覧表示したり、自動でファイルに追記したりできます。
# 不足しているキーをロケールごとに表示
$ i18n-tasks missing
# jaロケールで不足しているキーを、Google翻訳を使って自動で翻訳し、ファイルに追記
$ i18n-tasks missing --locale ja --format yaml | tee -a config/locales/ja.yml3. Google翻訳との連携 (translate-missing)
i18n-tasksの最も強力な機能の一つが、Google Cloud Translation APIとの連携です。APIキーを設定することで、不足している翻訳を自動で生成できます。
Google Cloud Translation APIの有効化: Google Cloud PlatformでAPIを有効にし、APIキーを取得します。
APIキーの設定:
i18n-tasks.ymlまたは環境変数でAPIキーを設定します。yaml# config/i18n-tasks.yml translation: google_api_key: "YOUR_GOOGLE_API_KEY"自動翻訳の実行:
bash# 不足しているキーを、ベース言語（通常はen）から他の言語に自動翻訳 $ i18n-tasks translate-missingこれにより、
ja.ymlなどのファイルに、Google翻訳による訳文が自動的に追加されます。機械翻訳なので完璧ではありませんが、翻訳作業の初稿としては非常に有用です。
4. 未使用の翻訳キーの削除 (remove-unused)
healthコマンドで報告された未使用キーを、安全に削除します。
$ i18n-tasks remove-unusedこのコマンドは、該当するキーを全てのロケールファイルから削除します。実行前に、Gitでコミットしておくなど、バックアップを取っておくと安心です。
5. 翻訳キーの正規化 (normalize)
YAMLファイル内のキーをアルファベット順にソートし、フォーマットを統一します。
$ i18n-tasks normalizeこれにより、複数人での開発時にコンフリクトが起きにくくなり、可読性も向上します。
CI/CDへの組み込み
Brakemanと同様に、i18n-tasksもCI/CDパイプラインに組み込むことで、翻訳漏れや不要なキーの混入を自動的に防ぐことができます。
GitHub Actionsでの実行例
# .github/workflows/i18n.yml
name: I18n Check
on:
pull_request:
jobs:
i18n-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.2'
bundler-cache: true
- name: Check for missing or unused i18n keys
run: bundle exec i18n-tasks healthこの設定により、Pull Requestが作成されるたびにi18n-tasks healthが実行され、何か問題があればCIが失敗します。これにより、翻訳の品質を常に高く保つことができます。
まとめ
i18n-tasksは、Railsのi18n対応における面倒な作業を自動化し、開発者の負担を大幅に軽減してくれる必須のツールです。
- 健康診断:
healthで翻訳ファイルの問題点を一目で把握。 - 自動翻訳:
translate-missingでGoogle翻訳と連携し、作業を効率化。 - クリーンアップ:
remove-unusedで不要なキーを安全に削除。 - コード品質:
normalizeでフォーマットを統一し、CI連携で品質を維持。
多言語対応は多くのアプリケーションにとって重要な要件です。i18n-tasksを開発ワークフローに組み込み、効率的で質の高いi18n管理を実現しましょう。