IntelliJ IDEAの設定を同期:Settings Syncで複数端末の開発をスムーズにする

前提 (弊社の開発環境について)

Weeybridでは多数の言語でのシステム開発を行っています。 基本的にエディタやIDEの選択は個人に任せることが多いですが、

「PHP」「Scala」「kotlin」「Java」

での開発においては 「IntelliJ IDEA」の使用を強く推奨しています。

www.jetbrains.com

はじめに

弊社ではリモートワークを推進していることもあり、開発者が複数の拠点/端末を使用することが増えてきました。

複数端末で設定を個別に行うと、環境によって挙動が異なるケースが発生し、開発者にとって大きなストレスとなることがあります。 一貫性のない環境は生産性の低下を招き、エラーの原因にもなりかねません。

本記事では、IntelliJの非常に便利な機能である「Settings Sync (設定の同期)」について紹介します。

この機能では、複数の端末間で開発環境の設定を効率的に同期し、一貫性のある快適な Developer Experience(開発者体験)を実現できます。

環境

IntelliJ IDEA 2024.2.3 (Ultimate Edition) (2024年10月現在で最新のものです)

Settings Sync について

IntelliJ IDEA 2024.2.3ではSettings Syncプラグインがデフォルトでバンドルされています。

以前のバージョンでは「IDE設定同期プラグイン」として提供されていましたが、2022.3以降では「Settings Sync(設定の同期)」として統合されました。

Settings Syncは、IntelliJ IDEA Ultimateだけでなく、Community Editionでも利用できるようになりました。また、サードパーティ製のプラグインを含む、より広範囲のプラグイン設定も同期できるようになりました。

アカウント作成

JetBrainsアカウントがない方は、事前にアカウントを作成する必要があります。

account.jetbrains.com

ログイン

[Settings] -> [Settings Sync] -> [Log in with Jetbrains Account]をクリックし、ログインします。

setting_sync_login

同期したい項目を選択し [Push Settings to Account]をクリックします。

setting_sync_push

以上で選択した設定がサーバーに保存されます。

同様に別の端末でもログインし上記の画面で [Get Settings from Account]をクリックすると同期が始まります。

Settings Syncが表示されていない場合

Settings Syncが表示されていない場合は[設定]->[Plugins]でSettings Syncを検索し[Enable]にします。 settings_sync_enable

仕様について

上記の設定を完了すると、設定が同期されます。
IntelliJを起動(再起動)した際に変更がある場合は設定のダウンロードが始まります、便利!

さて、これでプラグインの断捨離と思い立ち、使っていないプラグインを端末からアンインストールしました。 別の端末でも消えるものと想定していましたが、そうではありませんでした。

公式によると、下記のような挙動となるとのことです。

  • プラグインが両方の IDE にインストールされている場合、設定同期は 2 つの IDE 間でプラグインの状態 (有効または無効) を同期します。

  • プラグインが一方の IDE にインストールされて有効になっているが、もう一方の IDE にはインストールされていない場合、設定同期はそのプラグインをもう一方の IDE にインストールします。

  • プラグインが一方の IDE にインストールされて無効になっており、もう一方の IDE にはインストールされていない場合、設定同期はそのプラグインをもう一方の IDE にインストールしません。

  • プラグインをアンインストールし、そのプラグインが他の IDE にインストールされている場合、設定同期は無効になりますが、他の IDE ではアンインストールされません。

www.jetbrains.com

将来的にこのへんもオプションで設定できるようになればいいですね!