RubyプロジェクトにおけるLinter/FormatterのVSCode環境設定2024

結論

Gemfileにrubocop/rubocopとShopify/ruby-lspを入れてRuby LSP - Visual Studio MarketplaceのVSCode拡張を入れる。

そんで.vscode/settings.jsonは下記で設定。

{
  "rubyLsp.rubyVersionManager": "none",
  "rubyLsp.formatter": "rubocop",
  "[ruby]": {
    "editor.defaultFormatter": "Shopify.ruby-lsp",
    "editor.formatOnSave": true
  }
}

rubyLsp.rubyVersionManagerに関しては環境に応じて必要な値を設定する。もしrbenvを使っている場合はrbenvを。system環境のRubyを使ってるなら↑のようにnoneを。RVMならrvmを。

これでセマンティックハイライト・シンボル検索・エラーの警告などはもちろん、Linter/Formatterに関しても基本はrubocop.ymlの内容を元にRuby LSPがいい感じにやってくれる。