2022年2月18日金曜日

Mac に VSCode をインストールして solargraph の設定をしてみた

Mac に VSCode をインストールして solargraph の設定をしてみた

概要

タイトルの通りです
まずは solargraph をインストールして Ruby の開発環境を構築しました

環境

  • macOS 11.6.3
  • vscode 1.64.2

インストール

  • brew install visual-studio-code --cask

初期設定

  • テーマの設定
  • 設定のクラウド同期の設定
  • ショートカットを有効にするかの設定
  • 言語の補完とシンタックスハイライトの設定

1つ目のプロジェクトを開いたあとでプロジェクトの製作者を信頼するかどうかのダイアログが出るので必要に応じて信頼してください

プロジェクトを開くと Welcome ページが表示されます
Welcome ページを毎回表示しない場合はチェックボックをオフにしてください

Solargraph の設定

Code -> Preferences -> Extensions

で「solargraph」と検索し Install します

プロジェクトを開いたらコマンドパレット (Cmd+Shift+p) で「Build new gem documentation」で gem の補完も有効にします

バックグラウンドで yard プロセスが動作し yardoc を生成しているのがわかります

solargraph 自体をインストールしていない場合は

  • gem install solargraph

Gemfile 配下で solargraph をインストールした場合は

同じことをプロジェクト配下で実施する感じです
プロジェクトごとにやらないとダメです

  • mkdir .vscode
  • vim .vscode/settings.json
{
  "solargraph.useBundler": true,
  "solargraph.bundlerPath": "/usr/local/lib/ruby/gems/3.0.0/bin/bundle"
}
  • bundle exec yard gems

solargraph.useBundler: true にして bundler コマンドが見つからないというエラーが出る場合は solargraph.bundlerPath を設定してください

最後に

bundler 配下が面倒という場合はグローバルな gem にインストールして yardoc を生成すれば OK です

参考サイト

0 件のコメント:

コメントを投稿