Rubyで自動コード整形・自動コード補完する手順

【実行環境】

• VScode
• MacOS

1、Ruby Solorgraphをインストール

command + shift + p でコマンドパレットを開いた後、
「Ruby Solargraph」と検索し、インストールしましょう。

2、gemのインストールも済ませておく

ターミナルでgem install Solargraphを実行。

完了までに数分かかります。
![](https://storage.googleapis.com/zenn-user-upload/6b3426e14043-20240505.png)

rbenvですでにrubyのバージョン管理されていれば、現在使われているrubyのバージョン関連ディレクトリに自動的にgemがインストールされます。

gem（RubyGems）はRubyの公式パッケージマネージャーです。macOSにはデフォルトでRubyとgemがインストールされていますが、システムの安全性やアップデートの問題から、これらのバージョンは古いことが多く、システムと密接に結びついています。このため、rbenvのような専用のバージョン管理ツールを使用して最新のRuby環境を構築することが一般的です。

次のコマンドでrbenvのバージョンが確認できます。
rbenv versions

system
  3.0.1
* 3.2.0

このように出てきたら、バージョンがインストールされている証拠です

Ruby Solargraph と gem install Solargraph の比較

機能	説明
VS Code の拡張機能としての Solargraph	コード整形や自動補完ができるようになる
gem install Solargraph	Solargraph の基本的な機能を全体的にインストールし、システムのどの部分からもアクセスできるようになる

インストールしたのに使えない。。。

setting.jsonでcompletionとsuggestionsがfalseになっている、または記述されていない可能性があります。なのでコマンドパレットを開いてsetting.json（ユーザー）に以下を追加しましよう。

setting.json

{
    "solargraph.completion": true,
    "solargraph.suggestions": true
}

Solargraphの全機能を活用するためには、設定を適切に有効化することが重要です。

最後にVScodeの再起動 or 画面リロード

VS Codeの再起動や画面リロードをすることで、更新した設定が適用され、Solargraphの機能が正しく動作するようになります。