clojure-lsp-intellij
clojure-lsp-intellij copied to clipboard
What about using LSP4IJ?
I noticed that you have implemented your own lsp support, but I would like to notify you that it exists now a free LSP support for IntelliJ https://github.com/redhat-developer/lsp4ij
-
You can see the current LSP support at https://github.com/redhat-developer/lsp4ij/blob/main/docs%2FLSPSupport.md By reading your LSP support at https://github.com/clojure-lsp/clojure-lsp-intellij/blob/master/docs/capabilities.md it seems LSP4IJ covers the same thing than your plugin and perhaps more. I have tested quickly https://github.com/clojure-lsp/clojure-lsp-intellij/issues/51 and it seems it is working with LSP4IJ.
-
LSP4IJ provides an LSP console to show LSP traces and see the state of language server https://github.com/redhat-developer/lsp4ij/blob/main/docs%2FUserGuide.md
-
If you want to play quickly with LSP4IJ and your Clojure LS without developping an IJ plugin please read https://github.com/redhat-developer/lsp4ij/blob/main/docs/user-defined-ls/clojure-lsp.md
-
If you want to integrate your ls in an IJ plugin please read https://github.com/redhat-developer/lsp4ij/blob/main/docs%2FDeveloperGuide.md
You can read an article about LSP4IJ at https://idetools.dev/blog/lsp4ij-announcement/
Hope you could be interested with LSP4IJ and don't hesitate to answer me if you have any questions.
Thanks!
Hey @angelozerr, thanks for bringing that, I was not aware of that and it's awesome to see free open source alternatives like that one! I'll take a closer look, but some things I noticed:
- When I hold
Ctrl, and hover over a symbol, I see the whole buffer text underlined, seems a little bit weird - Do you support semantic tokens?
- When I click on a code lens I see this, which I'm not entirely sure what means:
- clojure-lsp-intellij has a good feedback during initialization which I don't see easily, I need to click on LanguageServers and even so have logs enabled, check the
$/progressnotifications:
When I created this plugin, the idea is to provide LSP support but in a way intellij users don't need to setup nothing, like just works out of the box, with minor customization as possible, is it possible to have a plugin that uses lsp4ij under the hood and have all those things configured already out of the box? Most Clojure Intellij users came from Cursive which is a great Clojure paid plugin, and works really well out of the box, so I'd change this plugin base only if it could have the same things and work out of the box as possible
When I hold Ctrl, and hover over a symbol, I see the whole buffer text underlined, seems a little bit weird
I think it is the same issue than https://github.com/redhat-developer/lsp4ij/issues/98 It is because if you have use just TextMate or TEXT language, the PsiFile is not tokenized and the range is the full file content. It is badly not possible to customize that with gotoDeclarationHandler extension point -( But if you have a plugin which tokenized the PsiFile with PsiElement you will not have this problem.
Do you support semantic tokens?
I have pushed last hours this support, see doc at https://github.com/redhat-developer/lsp4ij/blob/main/docs/UserGuide.md#semantic-tokens-support but it is experimental and it seems that there is a CPU issue https://github.com/redhat-developer/lsp4ij/issues/394 but if you want to play with this feature you can install nightly build https://github.com/redhat-developer/lsp4ij?tab=readme-ov-file#testing-nightly-builds
I have played with clojure lsp and it seems it colorizes some tokens.
When I click on a code lens I see this, which I'm not entirely sure what means:
It means that language server report Codelens with command code-lens-references, you can see those CodeLens by using LSP console https://github.com/redhat-developer/lsp4ij/blob/main/docs/UserGuide.md#lsp-console
If language server doesn't provide this command, it tries to search if it exists a command on client side, if this command doesn't exist, you have this popup error and you have a link which suggest to implement an IJ plugin which register the expected command.
I think you have implemente this LSP command in your plugin, right?
clojure-lsp-intellij has a good feedback during initialization which I don't see easily, I need to click on LanguageServers and even so have logs enabled, check the $/progress notifications
$/progress has been implemented with IntelliJ Backgroind Task, see https://github.com/redhat-developer/lsp4ij/blob/main/docs/LSPSupport.md#progress-support
What is your suggestion to improve that?
When I created this plugin, the idea is to provide LSP support but in a way intellij users don't need to setup nothing, like just works out of the box, with minor customization as possible, is it possible to have a plugin that uses lsp4ij under the hood and have all those things configured already out of the box?
Yes! It is the goal of LSP4IJ that we use https://github.com/redhat-developer/intellij-quarkus and we have the luck that some projects are based on LSP4IJ https://github.com/redhat-developer/lsp4ij?tab=readme-ov-file#who-is-using-lsp4ij
See the section of our article https://idetools.dev/blog/lsp4ij-announcement/#how-to-integrate-your-language-server-in-an-intellij-plugin
It seems that you have played with https://github.com/redhat-developer/lsp4ij/blob/main/docs/user-defined-ls/clojure-lsp.md which is working just with few settings and you don't need to write an IJ plugin, but it is better to develop an IJ plugin:
- to embed the clojure-lsp in the plugin
- provide required LSP command like the
code-lens-referencescommand.
In other words, my suggestion is to update your IJ plugin, by removing all LSP features and based on LSP4IJ and register the Clojure LSP with the LSP4IJ server extension point https://github.com/redhat-developer/lsp4ij/blob/main/docs/DeveloperGuide.md
The goal of your plugin is to:
- embed default clojure lsp
- provide an action to download last version of clojure lsp
- implement required LSP command like
code-lens-referencescommand
@angelozerr thanks for the explanation, it completly makes sense! I wish we had that plugin when I started developing this one hehe, but I agree it makes sense to leave the LSP logic to LSP4IJ indeed, especially because of semantic tokens which I know is hard to support on client side, it's just that it's a huge transition we'd need to make carefully, especially because there are lots of people already using clojure-lsp-intellij plugin.
But if you have a plugin which tokenized the PsiFile with PsiElement you will not have this problem.
clojure-lsp-intellij already has a language parser for Clojure, why that still happens?
So, just summarizing some things I have in mind so we can be aligned:
- I still need to test each existing feature and check it's working or the most important ones are working
- we would need to launch a 3.0.0 (next major version) of clojure-lsp-intellij, which would delegate all LSP connection to LSP4IJ
- I wanna a way to download clojure-lsp automatically the same way it does ATM, is there any way to have this logic working and after downloaded manually trigger the LSP start like we do today?
- about the code-lens-reference, got it, it should be easy to support it.
- we would need to fix this underlined issue
- Also, there is a behavior I'd like you to consider supporting, which is when Ctrl+click on a definition, we show the references, it's something I brought from Cursive which Intellij users use a lot instead the need to manually triggering the find-references shortcut, WDYT?
BTW, really cool project the LSP4IJ, it remembers me when we extracted clojure-lsp logic to https://github.com/clojure-lsp/lsp4clj 😄
clojure-lsp-intellij already has a language parser for Clojure, why that still happens?
How have you tested LSP4IJ,with your plugin? If you did that you should have duplicate completion (one from your pluin, and one from LSP4IJ), right?
I still need to test each existing feature and check it's working or the most important ones are working
Exactly, when I discovered your project, I have spend some time to check the feature that you have implemented before annoying you and I think a feature that you will loose is the code action available from the refactor menu. I have not implemented this feature. Perhaps LSP4IJ will need to provide some customization, I don't know, I'm waiting for feedback from adaptor like you if you decide to migrate to LSP4IJ.
we would need to launch a 3.0.0 (next major version) of clojure-lsp-intellij, which would delegate all LSP connection to LSP4IJ
Indeed it will be more careful if you decide to adopt LSP4IJ.
I wanna a way to download clojure-lsp automatically the same way it does ATM, is there any way to have this logic working and after downloaded manually trigger the LSP start like we do today?
Yes, LSP4IJ provide an API to enable/disable and start/stop language server. See https://github.com/redhat-developer/lsp4ij/blob/main/docs/DeveloperGuide.md#language-server-manager
about the code-lens-reference, got it, it should be easy to support it.
I think.Please note that it exists the default command https://github.com/redhat-developer/lsp4ij/blob/main/docs/DeveloperGuide.md#editoractionshowreferences perhaps you could declare you action by using the class of this action?
we would need to fix this underlined issue
Also, there is a behavior I'd like you to consider supporting, which is when Ctrl+click on a definition, we show the references, it's something I brought from Cursive which Intellij users use a lot instead the need to manually triggering the find-references shortcut, WDYT?
Today Ctrl+Click is associate to the textDocument/definition, you woule like to associate to textDocument/references? I would like to avoid doing that because references can be expensive, but if you need it we could provide a customization or perhaps you could implement on your side the GoToDeclarationHandler with references. The main thing to do is to create issues on LSP4IJ to discuss about that
How have you tested LSP4IJ,with your plugin? If you did that you should have duplicate completion (one from your pluin, and one from LSP4IJ), right?
I disabled my plugin, enabled yours and restarted intellij
a feature that you will loose is the code action available from the refactor menu.
TBH, That's not a core feature, if code actions are provided via the context menu (lightbulb), that's its good enough. It'd be nice though to support that in the future
provide an API to enable/disable and start/stop language server.
awesome, so I think that will keep working as expected
perhaps you could declare you action by using the class of this action?
Ah, yeah, that should be enough!
Today Ctrl+Click is associate to the textDocument/definition, you woule like to associate to textDocument/references?
Yeah, first time I heard about that I disliked too, but I understood later, the point is that if you are already on the definition, you don't want to go to definition, but the references of it, so users can use the same shortcut to go and come back. IMO would be nice to have this in the core without the need to support any customization, but if you disagree, a customization would be really useful.
I'll find some time during the next week to deep dive and check if there are other bugs, thanks again for raising this.
I disabled my plugin, enabled yours and restarted intellij
Ok so it means that you have not a PsiFile for clojure, right?
TBH, That's not a core feature, if code actions are provided via the context menu (lightbulb), that's its good enough.
It is and with fast performance (it should)
It'd be nice though to support that in the future
Please create a new ossue for that with your detailled idea (ex : do you want some customization of the icon,etc)
IMO would be nice to have this in the core without the need to support any customization, but if you disagree, a customization would be really useful.
Let's create a new issue to discuss about that and see the feedback from the community.
I'll find some time during the next week to deep dive and check if there are other bugs, thanks again for raising this.
Great!
Ok so it means that you have not a PsiFile for clojure, right?
Ah makes sense 😅, so if we had clojure-lsp-intellij using lsp4ij and defining a Parser like it does today, that would work, right? BTW, with lsp4ij, would be required to change anything related to Langauge declaration, like parser, lexer etc?
Please create a new ossue for that with your detailled idea (ex : do you want some customization of the icon,etc)
Will do!
Ok so it means that you have not a PsiFile for clojure, right?
Ah makes sense 😅, so if we had clojure-lsp-intellij using lsp4ij and defining a Parser like it does today, that would worinspecter?
Yes!
BTW, with lsp4ij, would be required to change anything related to Langauge declaration, like parser, lexer etc?
No LSP4IJ works with or without a PsiFile
Please create a new ossue for that with your detailled idea (ex : do you want some customization of the icon,etc)
Will do!
@ericdallo just for your information, we will release 0.6.0 next week and we provide a cool new feature with document symbol.
Here a screenshot with clojure:
Awesome! I still need to check the feature parity with current features so we can consider switch to LSP4IJ
Awesome!
Glad it pleases you!
For some shortcut, I think it will not the same thing than you, since I have not found a solution to override the Action menu for Find implementation for instances https://github.com/redhat-developer/lsp4ij/blob/main/docs/LSPSupport.md#implementation
I had to provide new shortcut. I don'tunderstand how you have manage this usecase without breaking this feature for standard IntelliJ plugin (ex : Java plugin which doesn't use LSP).
@ericdallo I have started the 0.8.0 release of LSP4IJ (it will be available in few days by waiting for approvment from JetBrains) which provides type + call hierarchy. Here a sample with clojure:
See https://github.com/redhat-developer/lsp4ij/blob/main/docs/LSPSupport.md#call-hierarchy to know how to integrate call hierarchy with clojure since you are using a custom clojure language
@angelozerr thanks for the followup, I will spend more time on this project from now on, and I will take a closer look on lsp4ij, the first thing I need to know is check the features parity, if we can provide all current features the migration seems to worth it!
@ericdallo that's great! You can quickly read LSP support at https://github.com/redhat-developer/lsp4ij/blob/main/docs/LSPSupport.md
When you will integrate, you will use a custom language I think (no texmate), you will have to define some LSP features like signatureHelp, see https://github.com/redhat-developer/lsp4ij/blob/main/docs/LSPSupport.md#signature-help
Perhaps you will have to customize LSP features, please read https://github.com/redhat-developer/lsp4ij/blob/main/docs/LSPApi.md
And for your information, I have started to implement a DAP (to debug clojure for instance) support in https://github.com/redhat-developer/lsp4ij/pull/735 which will be available in 0.10.0 Perhaps you could be interested?
I took a look at the LSPSupport doc, AFAICS there is nothing missing!
Ok, my next concern is how much I will need to change the core of the plugin, since it's written in Clojure using clj4intellij, but if most of the work is done in the plugin.xml, it should be ok
Ah yes, DAP is really cool, I used dap-mode with emacs for java for a long time, would be awesome to see that working with clojure, a real game changer for this plugin.
@angelozerr I created a branch here to start this integration, some points I noticed:
-
clojure-lsp supports intellij 2021 while the plugin supports only 2023 onwards, that's not a big deal though as I plan to support only 2023 onwards as well I guess
-
Not sure why the server is not being created automatically even associating with a language
Just wanna mention that it's really important that the clojure-lsp plugin require minimal configs from users as possible, just like it's ATM (where it downloads the server automatically by default and starts it as soon a clojure file is opened).
-
After creating manually the server, during the initialize request, I'm not seeing the $progress notifications that server produces during the initialize request, like I mentioned here, is it required to do any extra config?
-
I wanna keep the status bar clojure icon that exists atm, where user has options to see if the LSP is connected without any action and options to restart the server, I suppose I can do that with
LanguageServerManagerclass, will take a look later.
@angelozerr I created a branch here to start this integration, some points I noticed:
- clojure-lsp supports intellij 2021 while the plugin supports only 2023 onwards, that's not a big deal though as I plan to support only 2023 onwards as well I guess
Lsp4ij supports 2022.3 to eap (for the moment)
- Not sure why the server is not being created automatically even associating with a language
Just wanna mention that it's really important that the clojure-lsp plugin require minimal configs from users as possible, just like it's ATM (where it downloads the server automatically by default and starts it as soon a clojure file is opened).
It should be created, that it is strange?
If you restart IJ you dont see your ls?
- After creating manually the server, during the initialize request, I'm not seeing the $progress notifications that server produces during the initialize request, like I mentioned here, is it required to do any extra config?
No it should work. Need some investigation
- I wanna keep the status bar clojure icon that exists atm, where user has options to see if the LSP is connected without any action and options to restart the server, I suppose I can do that with
LanguageServerManagerclass, will take a look later.
The lsp console shows you the server status when it is starting, started, stopping stopped. You can see also lsp traces.
Lsp4ij supports 2022.3 to eap (for the moment)
I'm seeing 2023.2 here
If you restart IJ you dont see your ls?
Same problem after restarting :/ any other guess? this is a important step to integrate
The lsp console shows you the server status when it is starting, started, stopping stopped. You can see also lsp traces.
I know, but I found that window too hidden, would be nice to keep current behavior. When server starting or stopped/disabled:
When started and running:
Lsp4ij supports 2022.3 to eap (for the moment)
I'm seeing 2023.2
Ooops sorry you are rigjt. here
If you restart IJ you dont see your ls?
Same problem after restarting :/ any other guess? this is a important step to integrate
If you close the language server view and reopen it?
The lsp console shows you the server status when it is starting, started, stopping stopped. You can see also lsp traces.
I know, but I found that window too hidden, would be nice to keep current behavior. When server starting or stopped/disabled:
When started and running:
If you close the language server view and reopen it?
Nothing, tried multiple things, it's like it's not finding that config in my plugin XML
If you close the language server view and reopen it?
Nothing, tried multiple things, it's like it's not finding that config in my plugin XML
Indeed it is very strange.
If you close the language server view and reopen it?
Nothing, tried multiple things, it's like it's not finding that config in my plugin XML
Indeed it is very strange.
Have you some logs?
@ericdallo please try my suggestion https://github.com/clojure-lsp/clojure-lsp-intellij/pull/60/files#r1921068929
@angelozerr that fixes the problem! sorry for my silly fault 😅
I'll work on the statusbar now, so the only missing important thing for now is the progress notifications not being sent during initialize request, I believe it must be something with those notifications being sent before initialize finish.
I still need to test each feature individually but I believe they should work
@angelozerr that fixes the problem! sorry for my silly fault 😅
Great!
I'll work on the statusbar now, so the only missing important thing for now is the progress notifications not being sent during initialize request, I believe it must be something with those notifications being sent before initialize finish.
You mean $progress from LSP or other progress kind?
I still need to test each feature individually but I believe they should work
As you are using custom PsiFile, you will have to declare some LSP features like:
- https://github.com/redhat-developer/lsp4ij/blob/main/docs/LSPSupport.md#signature-help
- https://github.com/redhat-developer/lsp4ij/blob/main/docs/LSPSupport.md#folding-range
- https://github.com/redhat-developer/lsp4ij/blob/main/docs/LSPSupport.md#document-symbol
- https://github.com/redhat-developer/lsp4ij/blob/main/docs/LSPSupport.md#call-hierarchy
- https://github.com/redhat-developer/lsp4ij/blob/main/docs/LSPSupport.md#type-hierarchy
You mean $progress from LSP or other progress kind?
Yes, those are sent during initialize in server side.
You mean $progress from LSP or other progress kind?
Yes, those are sent during initialize in server side.
Do you see some $progress in the lsp console?
Do you see some $progress in the lsp console?
It's weird, but although server is working, the logs and traces are empty
@angelozerr what's your suggestion to support auto server download before starting it? Currently, we have this logic here to download server and start it automatically