How to get the run and debug icons on a custom compiler plugin generated main entry point

[soronpo]

I have compiler plugin that from an annotated class like @top class Foo creates a main entry point named top_Foo.
I wonder if there is a way to get metals to recognize the main entry point and place the run and debug icons above the @top annotation (scalac of course recognizes these entry points successfully). Is there something that the compiler plugin needs to do for Metals to be able to recognize this?

[tgodzik]

As long as it's found as a main class by the build tool it should work. I guess the problem here is that we do not know where top_Foo should be shown, since it's not a class or method that exists in the sourcecode.

[tgodzik]

Some further experiments resulted in:
https://github.com/scalameta/metals/compare/main...tgodzik:metals:experiment-custom?expand=1

What we can do currently is just add any unknown mains (not knowing what produced them) to the top of the file, which will be rather limited effort and impact on performance. (so we can do it soon)

As a possible follow up we could try to add position to .info method result, which might be able to give us the exact position if you attach the position to the created symbol. Assuming I understand how this works. We could try to do all the steps separately and if they do not work, it should not be an issue for anything else.

Opinions?

[soronpo]

What we can do currently is just add any unknown mains (not knowing what produced them) to the top of the file, which will be rather limited effort and impact on performance. (so we can do it soon)

Slight ambiguity if there is more than one @top in the same file. The user can be instructed to avoid that, so this could be a solution, at least short term.

if you attach the position to the created symbol

From what I was able to ascertain, from v0.7.1 the symbol has proper positioning.

We could try to do all the steps separately and if they do not work, it should not be an issue for anything else.

Sounds like a good plan. I really appreciate it you looking into this.

[tgodzik]

I don't quite understand.

Sorry, I just meant the Bloop issue. Code lenses are still an issue.

I quickly got something like this working:

Also, I should refresh the page before writing a response 😅

[soronpo]

I don't quite understand.

Sorry, I just meant the Bloop issue. Code lenses are still an issue.

I quickly got something like this working:

Also, I should refresh the page before writing a response 😅

That's really cool! With the explicit name no ambiguity. This looks good enough to me.

[soronpo]

Since we can solve this from Metals' side, I opened issue #6738