Udemy 9. Nuxt.jsフロント開発事前準備 #04
2020年07月27日に更新

Nuxt.jsにnuxt-i18nを導入して国際化に対応する

今回達成すること

Nuxt.jsにi18nモジュールを導入し、index.vueに翻訳結果を表示します。

完成イメージ

2020-07-22 18-45-07

i18nとは?

i18nはアプリを多言語化対応するために使われるモジュールです。

このモジュールを使えば「login」の文字列を日本語の「ログイン」に簡単に翻訳できます。

「front」ディレクトリでブランチ切っとく

作業に移る前に「front」ディレクトリに移動してブランチを切ります。

root $ cd front
front $ git checkout -b 20200722_add_nuxt-i18n
front $ git branch

* 20200722_add_nuxt-i18n

front $ cd ..

nuxt-i18nをインストールする

i18nモジュールはNuxt.js用(nuxt-i18n)とVue.js用(vue-i18n)があります。

どちらもNuxt.jsに導入できますが、そもそもnuxt-i18nにはvue-i18nが統合されています。

そこで今回はNuxt.js用のnuxt-i18nをインストールします。

root $ docker-compose run --rm front yarn add nuxt-i18n

参考 nuxt-i18n - npm

インストールを確認しておきましょう。

root $ docker-compose run --rm front yarn list --pattern nuxt-i18n

...
└─ nuxt-i18n@6.13.1

nuxt-i18nのセットアップ

nuxt.config.jsnuxt-i18nのセットアップを行います。

まずはモジュールを登録しましょう。

front/nuxt.config.js
modules: [
  ...
  // 追加
  // Doc: https://www.npmjs.com/package/nuxt-i18n
  'nuxt-i18n'
],

続いてグローバルオプションを設定します。

front/nuxt.config.js
  // 追加
  // Doc: https://nuxt-community.github.io/nuxt-i18n/basic-usage.html#nuxt-link
  i18n: {
    locales: ['ja', 'en'],
    defaultLocale: 'ja',
    // Doc: https://kazupon.github.io/vue-i18n/api/#properties
    vueI18n: {
      fallbackLocale: 'ja',
      // silentTranslationWarn: true,
      silentFallbackWarn: true,
      messages: {
        ja: require('./locales/ja.json'),
        en: require('./locales/en.json')
      }
    }
  },
  // ここまで
  build: {
  }
}
  • locales: ['lang'] … アプリが対応している言語を配列で指定する。
  • defaultLocale: 'lang' … アプリが使用するデフォルトの言語。
  • fallbackLocale: 'lang'defaultLocaleで指定した言語に翻訳対象のキーがない場合に参照される言語。

    このことをフォールバックと言います。今回は同じjaを指定してるので特に意味を持ちません。

  • silentTranslationWarn: Booleantrueの場合、i18nの警告を完全に表示しない。

    今は使わないのでコメントアウトしていますが、のちに使いそうなオプションは調べたときに記述しておくと便利です。

  • silentFallbackWarn: Boolean
    • false(default) … フォールバック時には警告を発する。
    • true … 翻訳のkeyが全くない場合のみ警告が発生し、フォールバック時には警告は発生しない。
  • messages … 言語とその翻訳ファイルを指定する。

    ここはオブジェクトで直接記入することもできます。

vueI18n: {
  fallbackLocale: 'en',
  messages: {
    en: {
      welcome: 'Welcome'
    },
    fr: {
      welcome: 'Bienvenue'
    }
  }
}

localesファイルの作成

翻訳を設定するファイルを作成しましょう。

「locales」ディレクトリを作成し、その下に日本語用と英語用の2つのjsonファイルを作成します。

root $ mkdir front/locales && touch $_/{ja.json,en.json}

en.jsonに波括弧を追加する

今回はen.jsonファイルは編集しません。

エラーを回避するため{}だけ追記しましょう。

front/locales/en.json
{}

ja.jsonにページタイトルを追加する

英語を日本語に翻訳するja.jsonファイルにページタイトルを追加します。

front/locales/ja.json
{
  "title": {
    "signup": "会員登録",
    "login": "ログイン"
  }
}
  • ja.jsonの書き方 … "対象の英語(key)": "翻訳の日本語(value)"

index.vueにi18nを実装する

i18nの設定がうまくいっているか確認します。

index.vueにテストコードを追加してください。

front/pages/index.vue
<template>
  <v-container fluid>
    <v-card
      flat
      tile
      color="transparent"
    >
      ...
      <!-- 追加 -->
      <v-card-title>
        nuxt-i18nの検証
      </v-card-title>
      <v-card-text>
        <v-simple-table dense>
          <template v-slot:default>
            <thead>
              <tr>
                <th>en</th>
                <th>ja</th>
              </tr>
            </thead>
            <tbody>
              <tr
                v-for="(path, i) in ['signup', 'login']"
                :key="`path-${i}`"
              >
                <td>{{ path }}</td>
                <td>{{ $t(`title.${path}`) }}</td>
              </tr>
            </tbody>
          </template>
        </v-simple-table>
      </v-card-text>
      <!-- ここまで -->
    </v-card>
  </v-container>
</template>
...
  • $t('パス') … i18nを使って翻訳する場合は$t()にjsonファイルのパスを指定する。

コンテナを起動して確認しましょう。

root $ docker-compose up

よし、うまくいきました。

2020-07-22 18-45-07

確認が取れたらコンテナを削除してください。

HerokuにPushする

2020年7月23日 追記: 当初「front」ディレクトリのコミットだけでしたが、HerokuにPushするよう変更しました。

以上でi18nの導入は終了です。

「front」ディレクトリをHerokuにPushしましょう。

root $ cd front
front $ git add -A
front $ git commit -m "add_nuxt-i18n-module"
front $ git checkout master
front $ git merge 20200722_add_nuxt-i18n
front $ git push
front $ git push heroku

デプロイが完了したらHerokuを開いて本番環境の動作を確認しておきましょう。

front $ heroku open

確認が終わったら「root」ディレクトリをGitHubにPushします。

front $ cd ..
root $ git commit -am "front_add_nuxt-i18n_module"
root $ git push

まとめ

今回はnuxt-i18nモジュールを導入しました。

このモジュールを導入することで配列の値やパスを日本語変換できるので、スッキリとしたコードを書くことができます。

また、今回は触れませんでしたがブラウザの設定によって表示する言語を変えたり、言語別のパスを追加したり、かなり便利に使えます。

是非試してみてください。(そして教えてください。あわよくば)

このチャプターまとめ

以上で「Nuxt.jsフロント開発事前準備」を終わります。

このチャプターではNuxt.jsに以下を実装しました。

これでフロント開発の事前準備が完了です。

今までテストコードばかりでしたが、次回からは実際にレイアウトを構築していきます。

次章予告

次回より新章「認証アプリのレイアウト設計」が始まります。

ログインによってレイアウトが変化する、Nuxt.jsコンポーネント設計の全体像を把握し、ウェルカムページ(トップページ)の実装を行います。

お楽しみに!

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
1. このカテゴリーの歩き方 #01
【お知らせ】UdemyでRails × Nuxt.jsの動画を公開することになりました
1. このカテゴリーの歩き方 #02
【随時更新】このカテゴリーで作るアプリケーションの仕様書
1. このカテゴリーの歩き方 #03
【随時更新】このカテゴリーの歩き方
1. このカテゴリーの歩き方 #04
(Docker+Rails6+Nuxt.js+PostgreSQL)=>Heroku 環境構築~デプロイまでの手順書
2. Docker入門 #01
Docker for Macをインストールする手順
2. Docker入門 #02
分かるDocker解説。仮想環境・コンテナ・Dockerイメージ・Dockerfileとは何か?
2. Docker入門 #03
分かるDocker解説。DockerComposeとは何か?
3. Dockerを使ったRails+Nuxt.js環境構築 #01
【Docker+Rails6+Nuxt.js】今回作成するアプリの開発環境の全体像を知ろう
3. Dockerを使ったRails+Nuxt.js環境構築 #02
【MacOS】Homebrew経由でGitをインストールする方法
3. Dockerを使ったRails+Nuxt.js環境構築 #03
Rails6を動かすAlpineベースのDockerfileを作成する(AlpineLinuxとは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #04
Nuxt.jsを動かすAlpineベースのDockerfileを作成する(C.UTF-8とは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #05
.envファイルを使ったdocker-compose.ymlの環境変数設計
3. Dockerを使ったRails+Nuxt.js環境構築 #06
Rails6・Nuxt.js・PostgreSQLを動かすdocker-compose.ymlファイルを作成する
3. Dockerを使ったRails+Nuxt.js環境構築 #07
docker-compose.ymlを使ってRails6を構築する(PostgreSQLパスワード変更方法)
3. Dockerを使ったRails+Nuxt.js環境構築 #08
docker-compose.ymlを使ってNuxt.jsを構築する
4. 複数プロジェクトのGit管理 #01
複数プロジェクトで行うGit管理の全体像を理解しよう(Gitサブモジュール解説)
4. 複数プロジェクトのGit管理 #02
【Git】既存の子ディレクトリをサブモジュール管理に変更する手順
4. 複数プロジェクトのGit管理 #03
【GitHub】秘密鍵の生成・公開鍵を追加・SSH接続するまでを画像で分かりやすく
4. 複数プロジェクトのGit管理 #04
【GitHub】リモートリポジトリの追加・サブモジュールのリンク設定を行う
5. RailsAPI×Nuxt.js初めてのAPI通信 #01
【Rails6】"Hello" jsonを返すコントローラを作成する
5. RailsAPI×Nuxt.js初めてのAPI通信 #02
【Nxut.js】axiosの初期設定を行う(baseURL・browserBaseURLを解説)
5. RailsAPI×Nuxt.js初めてのAPI通信 #03
【Rails6】Gem rack-corsを導入してCORS設定を行う(オリジン・CORSとは何か)
6. Heroku.ymlを使ったDockerデプロイ #01
デプロイ準備。Herokuへ新規会員登録を行いHerokuCLIをインストールする
6. Heroku.ymlを使ったDockerデプロイ #02
heroku.yml解説編。Docker環境のRails6をHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #03
HerokuCLI-manifestのデプロイ解説編。Docker環境のRails6をHerokuにデプロイする(2/2)
6. Heroku.ymlを使ったDockerデプロイ #04
Dockerfile解説編。Docker環境のNuxt.jsをHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #05
デプロイ完結編。Docker環境のNuxt.jsをHerokuにデプロイする(2/2)
7. モデル開発事前準備 #01
【Rails6】application.rbの初期設定(タイムゾーン・I18n・Zeitwerk)
7. モデル開発事前準備 #02
【Rails6】モデル開発に必要なGemのインストールとHirb.enableの自動化
7. モデル開発事前準備 #03
【Docker+Rails】A server is already running. Check /tmp/pids/server.pidエラーの対応
7. モデル開発事前準備 #04
【Docker】<none>タグのイメージを一括削除する & Rails .gitignoreの編集
8. ユーザーモデル開発 #01
Railsユーザーモデル作成。テーブル設計・ユーザー認証設計を理解する
8. ユーザーモデル開発 #02
Railsユーザーモデルのバリデーション設定(has_secure_password解説)
8. ユーザーモデル開発 #03
Railsバリデーションエラーメッセージの日本語化(ja.yml設定方法)
8. ユーザーモデル開発 #04
EachValidatorクラスのカスタムバリデーション設定(Rails6/lib以下読込)
8. ユーザーモデル開発 #05
Rails環境ごとにSeedデータ切り替えるseeds.rbの書き方
8. ユーザーモデル開発 #06
Rails6から導入された並列テストを理解する
8. ユーザーモデル開発 #07
Railsユーザーモデルバリデーションテスティング(name/email/password)
8. ユーザーモデル開発 #08
Nuxt.jsからRailsのユーザーテーブルを取得しHerokuにデプロイする
9. Nuxt.jsフロント開発事前準備 #01
【Nuxt.js2.13超解説】バージョンアップ手順と6つの新機能+2つの変更点
9. Nuxt.jsフロント開発事前準備 #02
Docker AlpineベースのNode.js上で動くNuxt.jsにVuetifyを導入する
9. Nuxt.jsフロント開発事前準備 #03
VuetifyにカスタムCSSを導入してオリジナルブレイクポイントを作る
9. Nuxt.jsフロント開発事前準備 #04
Nuxt.jsにnuxt-i18nを導入して国際化に対応する
10. 認証アプリのレイアウト設計 #01
Nuxt.jsのレイアウト・ページ・コンポーネントの役割を理解しよう
10. 認証アプリのレイアウト設計 #02
ウェルカムページを構成するコンポーネントファイル群を作成しよう(1/4)
新着
10. 認証アプリのレイアウト設計 #03
ウェルカムページにアイキャッチ画像・アプリ名・メニューボタンを表示しよう(2/4)
新着
10. 認証アプリのレイアウト設計 #04
addEventListenerでスクロールを検知しツールバーの色を変化させよう(3/4)
新着
10. 認証アプリのレイアウト設計 #05
ウェルカムページをレスポンシブデザインに対応させよう(4/4)
新着
SPA開発
ブログ構築
小ネタ集