あまブログ

ドキドキ......ドキドキ2択クイ〜〜〜〜〜〜〜ズ!!

【VSCode】ShopifyのRuby LSPを導入する方法

Ruby VSCode RuboCop

rubyide/vscode-rubyが非推奨になり、代わりに Shopify/vscode-ruby-lsp を使うように公式から勧告が出ました。

この記事ではShopify/vscode-ruby-lspを導入する手順を紹介します。

formatterにはrubocopを使用します。

1. 開発環境

  • VSCode：1.84.0
  • Ruby：3.1.0
  • rbenv：1.2.0
  • Shopify/vscode-ruby-lsp：v0.4.13
  • Shopify/ruby-lsp：v0.12.3
  • rubocop：1.57.2
  • macOS：Ventura 13.4.1

2. 導入手順

2-1. 拡張機能のインストール

VSCodeにRuby LSPをインストールします。

marketplace.visualstudio.com

2-2. gemのインストール

Gemfileに以下を追記。

gem "rubocop"

(カレントディレクトリに.ruby-lsp/Gemfileが自動作成されていない場合は、gem "ruby-lsp"も追記)

gemをインストール。

$ bundle install

2-3. settings.jsonの設定

settings.jsonに以下を追記。

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

上記の設定でファイル保存時にフォーマットが実行されます。

その他の機能の使用は以下で切り替えられます。

{
  "rubyLsp.enabledFeatures": {
    "codeActions": true,
    "diagnostics": true,
    "documentHighlights": true,
    "documentLink": true,
    "documentSymbols": true,
    "foldingRanges": true,
    "formatting": true,
    "hover": true,
    "inlayHint": true,
    "onTypeFormatting": true,
    "selectionRanges": true,
    "semanticHighlighting": true,
    "completion": true,
    "codeLens": true,
    "definition": true,
    "workspaceSymbol": true,
    "references": true
  },
}

これらの機能の詳細は以下のドキュメントを参照ください。

【参考】