Solargraph: Autocomplete on comments

Created on 22 Nov 2019  路  8Comments  路  Source: castwide/solargraph

Is it possible to enable Solargraph module/class completions in yard docs?

For example:

# @type [Message::Cl...] #... autocomplete here.
tx = mime_type('png)

Basically if we declare a type, return or similar helpers we should see completion list.

enhancement

Most helpful comment

It should be possible. Solargraph can already detect when you're inside a comment, but its current behavior during autocompletion is to ignore them. We might be able to trigger autocompletion in tags with a simple regular expression. I'll look into it.

All 8 comments

It should be possible. Solargraph can already detect when you're inside a comment, but its current behavior during autocompletion is to ignore them. We might be able to trigger autocompletion in tags with a simple regular expression. I'll look into it.

The first implementation of autocompletion on comments is in the master branch.

@castwide Works perfectly on my end. 馃帀 Thank you!

In the future can CTRL + Hover&Click -> Go to definition feature be implemented? (Just a suggestion)

In the future can CTRL + Hover&Click -> Go to definition feature be implemented? (Just a suggestion)

It should already work, at least in the simplest case of a tag with a single type:

class Foo; end

class Bar
  # @return [Foo] <- Go to definition should work inside the tag
  def get_foo; end
end

...although I did notice a small bug where the above doesn't work with the cursor between the last o and the ]. I'll add it to the roadmap.

Ah! Yes it is indeed works. However what makes me think of not was that, there is no underline and hover effect on when I hover my mouse there along with CTRL. Let me show you:

fred

When we hover with CTRL on B module or A class, can we highlight them? Underscore and colorization perhaps.

I think that's a problem with nested namespaces, e.g., [B] should work, but [B::A] does not. I'll work on that next.

Yes, It is indeed works with only B but not with nested.

This feature (including a fix for nested namespaces) is released in v0.39.12.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

dgutov picture dgutov  路  5Comments

douglascamata picture douglascamata  路  5Comments

Sam-Killgallon picture Sam-Killgallon  路  5Comments

art-solopov picture art-solopov  路  3Comments

PyvesB picture PyvesB  路  4Comments