IntelliJ IDEA のユーザ辞書をチームで共有する方法

IntelliJ IDEAのユーザ辞書とは

Intellij IDEAには、タイポ（Typo・打ち間違え）と推測された単語に並線を表示する機能があります。誤った英単語に対してはとても有用なツールですが、業界特有の用語や固有名詞に対してもタイポと認識してしまうことがあります。

この際に、上記画像の”その他のアクション”からユーザ辞書へ登録すると、今後はタイポとして認識しなくなります。
しかしそのユーザ辞書の保管場所はローカルマシンであるため、チーム間で共有することができません。

チームで共有する方法

IntelliJ IDEAで何かしらのプロジェクトを使っていると、プロジェクトルートディレクトリに

.idea

というディレクトリがあるます。この中に以下のXMLファイルを指定書式で作成します。

.idea/dictionaries/hoge_dictionaries.xml

ファイル名は何でもOK。.idea/dictionaries配下にあるXMLファイルは全てユーザ辞書として認識されます。

<component name="ProjectDictionaryState">
  <dictionary name="hoge_dictionaries">
    <words>
      <w>yahoo</w>
      <w>rakuten</w>
      <w>rakuten</w>
    </words>
  </dictionary>
</component>

※.idea配下は.gitignoreに登録されていることがあるので、.gitignoreから除外しておきましょう。

# .gitignore
# dictionaries
!.idea/dictionaries/hoge_dictionaries.xml

ファイル作成後、IntelliJIDEAの再起動をするとタイポの警告が消えているはずです。

ちなみに辞書ファイルを作成すると、勝手にabc順に並び替えされます。全員で編集するとコンフリクトする可能性があるので、このファイルについては単独でプルリクを立てて管理するほうが無難かもしれません。