VSCode Settings Syncで端末ごとに同期する設定値を切り替える方法

VSCode Settings Syncで端末ごとに同期する設定値を切り替える方法

v1.4.8から標準になったSettings Syncで複数台の端末で設定値を同期できるようになりました。
しかし、端末ごとに異なる値にしたいフォントサイズや、OSごと(Windows, Mac, Linux)に異なる設定値にする必要が出てきます。

Settings Syncとは

VSCodeの設定値、キーボードのカスタマイズ、拡張機能を複数台の端末で同期できる機能です。

元々は拡張機能の一つとしてリリースされていましたが、v1.4.8から公式で標準機能となりました。
紛らわしく注意が必要なのは、機能名が新旧で同じですが中身は別物で設定方法も異なります。
ここでは、公式で標準になった新しいSettings Syncの設定方法を記載しています。

端末によって同期したくない設定値

端末ごとに異なる値にしたいフォントサイズや、OSごと(Windows, Mac, Linux)に異なる設定値にする必要があったとしても、そのままでは問答無用に全て同期されてしまいます。

設定値を同期したくない設定項目は、設定項目単位で同期対象から除外することが出来ます。

settings.jsonに除外対象の設定値をセットする

基本設定 > 設定(Ctrl+, / ⌘+,)から設定画面を開きます。
同期の除外対象を設定する設定項目settingsSync.ignoredSettingsに同期したくない設定値名を追加します。

{
  "settingsSync.ignoredSettings": [
    "editor.fontSize"
  ],
  "editor.fontSize": 15
}

これで、設定した端末だけSettings Syncの同期対象から外れます。

旧Settings SyncのOS別の属性設定は使えない

VSCode標準になる前の拡張機能の一つとしてリリースされていたSetting Syncでは、設定値の上に特定のコメントを付けることでOS単位で同期する設定値を切り替えることが出来ました。

この機能は公式で標準となったSettings Syncでは動作しません。

{
    // @sync os=linux
    "editor.fontSize": 15
}

参考

Settings Syncに関する公式ドキュメント
https://code.visualstudio.com/docs/editor/settings-sync

プログラミングカテゴリの最新記事