OSS Gate Workshop: Tokyo: 2024-09-21: yamatowani: Ruby LSP: Work log

[yamatowani]

This is a work log of a "OSS Gate workshop". "OSS Gate workshop" is an activity to increase OSS developers. Here's been discussed in Japanese. Thanks.

作業ログ作成時の説明

以下のテンプレートを埋めてタイトルに設定します。埋め方例はスクロールすると見えてきます。

OSS Gate Workshop: ${LOCATION}: ${YEAR}-${MONTH}-${DAY}: ${ACCOUNT_NAME}: ${OSS_NAME}: Work log

タイトル例↓：

OSS Gate Workshop: Tokyo: 2017-01-16: kou: Rabbit: Work log

OSS Gateワークショップ関連情報

• スライド：ワークショップの進行に使っているスライドがあります。
• チャット：OSS開発に関することならなんでも相談できます。ワークショップが終わった後もオンラインで相談しながら継続的にOSSの開発に参加しましょう！
• シナリオ：ワークショップの目的・内容・進め方の詳細が書いています。
• 過去のビギナーの作業ログ：他の人の作業ログから学べることがいろいろあるはずです。

[yamatowani]

ruby LSPはコードジャンプ(Go To Definition)がRuby Solargraphよりもできる範囲が狭い...?

[yamatowani]

ruby LSPはコードジャンプがRuby Solargraphよりもできる範囲が狭い...?

Qiitaにもそんな声が https://qiita.com/NaokiIshimura/items/dbe6a9dc0af59fde0c6b

[yamatowani]

https://github.com/user-attachments/assets/f0a03720-69b1-4235-89c5-3cec28d1f1b8

Go To Difinition機能がうまく動作しない

• ドキュメントにはF12を押すか、右クリックしてGo To Definitionを押しても、定義されているはずのUserMailerクラスやaccount_activationメソッドにジャンプできない

[yamatowani]

ドキュメントがこれだけであまり充実していない...?

https://shopify.github.io/ruby-lsp/#go-to-definition

[yamatowani]

https://qiita.com/NaokiIshimura/items/dbe6a9dc0af59fde0c6b

上記の記事に

（インスタンス化したクラスのメソッド呼び出しから、定義元クラスの先頭にしかジャンプできなかった）

とあるが、再現できず。

https://github.com/user-attachments/assets/361b5621-f3bd-4272-a532-e32138698760

[yamatowani]

Environment

• macOS Sonoma 14.4
• ruby 3.2.2 (2023-03-30 revision e51014f9c0) [arm64-darwin23]
• Rails 7.0.4.3
• About VSCode
  • Version: 1.93.1 (Universal)
  • Commit: 38c31bc77e0dd6ae88a4e9cc93428cc27a56ba40
  • Date: 2024-09-11T17:20:05.685Z
  • Electron: 30.4.0
  • ElectronBuildId: 10073054
  • Chromium: 124.0.6367.243
  • Node.js: 20.15.1
  • V8: 12.4.254.20-electron.0
  • OS: Darwin arm64 23.4.0

再現手順

[yamatowani]

日本語のコメントがあるとできないけど、5文字未満の場合はできることが判明

コードジャンプできるコード

class Foo
  # ああああ
  def foobar
    puts 'foobar'
  end
end

foo = Foo.new
foo.foobar

コードジャンプできないコード

class Foo
  # あああああ
  def foobar
    puts 'foobar'
  end
end

foo = Foo.new
foo.foobar

[yamatowani]

Gemfile

# frozen_string_literal: true

source 'https://rubygems.org'

ruby '3.2.4'

gem 'debug', platforms: %i[mri windows]
gem 'rubocop'

[yamatowani]

下記のissueにコメント投げてみた

https://github.com/Shopify/ruby-lsp/issues/1347

I have a similar problem, How is your progress?

Description

I'm also using VSCode's ruby-lsp plugin, but it seems that if there is more than 13 bytes of character data, including multibyte characters, in the method comment, I cannot define a jump. Specifically, it is not possible to jump from the followingfoobar instances to the definition source.

Case	Data Quantity	Result
"あああ"	9byte	Success
"ああああ"	12byte	Success
"ああああa"	13byte	Failed
"あああああ"	15byte	Failed

Success File

class Foo
  # ああああ
  def foobar
    puts 'foobar'
  end
end

foo = Foo.new
foo.foobar

Failed File

class Foo
  # あああああ
  def foobar
    puts 'foobar'
  end
end

foo = Foo.new
foo.foobar

environment

• macOS Sonoma 14.4
• ruby 3.2.2 (2023-03-30 revision e51014f9c0) [arm64-darwin23]
• About VSCode
  • Version: 1.93.1 (Universal)
  • Commit: 38c31bc77e0dd6ae88a4e9cc93428cc27a56ba40
  • Date: 2024-09-11T17:20:05.685Z
  • Electron: 30.4.0
  • ElectronBuildId: 10073054
  • Chromium: 124.0.6367.243
  • Node.js: 20.15.1
  • V8: 12.4.254.20-electron.0
  • OS: Darwin arm64 23.4.0

[github-actions[bot]]

おつかれさまでした！

ワークショップの終了にともないissueを閉じますが、このまま作業メモとして使っても構いません :ok_hand:

ワークショップの感想を集めています！

ブログなどに書かれた際は、このページへリンクの追加をお願いします :pray:

またの参加をお待ちしています！