vscode-crystal-lang icon indicating copy to clipboard operation
vscode-crystal-lang copied to clipboard

Add support for Jump to Definition

Open paulcsmith opened this issue 7 years ago • 5 comments

I'm loving the plugin so far. It would be wonderful if it could also support Jump to Definition so I could jump to a class or method definition in the project.

Thanks for the project, and thanks for considering this feature.

paulcsmith avatar Dec 13 '17 19:12 paulcsmith

@paulcsmith Thank for your comment!

Go to Definition already work just methods. Modules or clases doesn't work due crystal doesn't support it yet. See https://github.com/crystal-lang/crystal/issues/4941

Still a bit unstable, sometimes doesn't work ⚠️

You can enable go to method definition using:

{
  "crystal-lang.implementations": true
}

https://github.com/crystal-lang-tools/vscode-crystal-lang/wiki/Settings#implementations

If you are in a custom project where you specify all requires inside a main file then you need to use:

https://github.com/crystal-lang-tools/vscode-crystal-lang/wiki/Settings#mainfile

{
  "crystal-lang.mainFile": "${workspaceRoot}/src/mymainfile.cr"
}

go to

(Older version Peek implementation command has been removed on latest versions)

kemal go to

faustinoaq avatar Dec 13 '17 21:12 faustinoaq

But as I see now that issue is fixed by a PR. Can you support that now??

minkir014 avatar Jun 17 '19 20:06 minkir014

When jump to definition throws the following error:

[Info  - 9:53:45 PM] Scry is looking into your code...
[Error - 9:53:54 PM] A error was found while searching implementations
Unexpected char 'U' at 1:1
Usage: crystal tool implementations [options] [programfile] [--] [arguments]

iambudi avatar Nov 16 '19 15:11 iambudi

Hi, @minkir014 @iambudi This extension uses the output provided by crystal tool CLI, so if the feature finds an error it's because crystal was designed that way, there is some workaround using a dynamic code analyzer based on javascript or something similar

Scry has some nice features but is in a very experimental state yet. It also uses crystal CLI, so it is an issue and it requires the full updated implementation of Language Server Protocol.

Right now I'm fixing some issues on Node.js backend of this extension, I'll figure out a way to solve this issue.

Cheers!

faustinoaq avatar Mar 31 '20 08:03 faustinoaq

Thanks @faustinoaq!!

paulcsmith avatar Apr 02 '20 22:04 paulcsmith

What is the current status of this?

On my side I don't see this work in any way currently. With peek, mouse click or anything.

I would say this is a pretty standard way to navigate code in the last 10 years, it pretty much renders useless any kind of editor/ide if it does not have it.

I'm currently running:

$ crystal -v
Crystal 1.8.2 (2023-05-09)

LLVM: 15.0.7
Default target: x86_64-apple-macosx 

What do we need to do to make this a top priority? and/or help?

Narven avatar May 29 '23 10:05 Narven

@Narven you might try this alternative

iambudi avatar May 30 '23 14:05 iambudi

Thanks @iambudi, will try that.

Narven avatar May 30 '23 15:05 Narven

This should work with v0.9.0-alpha.1, though it's reliant on the crystal tool implementations CLI tool. This can be unreliable when working on a libraries internals and I'm not sure why - when working on an executable/app where everything gets compiled it works well.

nobodywasishere avatar Dec 06 '23 04:12 nobodywasishere