Dart-code: LSP Known Issues

[DanTup]

When running in LSP mode, the following things are known not to work (or function differently to non-LSP):

• Running "Dart: Sort Members" command fails
• Widget UI Guides don't work https://github.com/Dart-Code/Dart-Code/issues/2425
• Gutter Icons don't work https://github.com/Dart-Code/Dart-Code/issues/2426
• The dart.doNotFormat setting used to exclude files/folders from auto-formatting does not work wontfix
• The dart.analysisExcludedFolders setting does not exclude folders from analysis https://github.com/Dart-Code/Dart-Code/issues/2680
• The dart.enableSdkFormatter setting does not unregister the formatter
• Analysis server plugins do not work
• Find implementations only works on the method name wontfix
• Rename does not work on the import or class keywords wontfix
• Refactor: Extract local variable is not available https://github.com/Dart-Code/Dart-Code/issues/2951
• Refactor: Extract method is not available
• Refactor: Extract widget is not available
• Moving/renaming files do not update references https://github.com/Dart-Code/Dart-Code/issues/2761
• No options for including parens/args in completion https://github.com/Dart-Code/Dart-Code/issues/2823

[ericdallo]

• For some reason the widget guides feature is not available.
• Tests codeLens(Run|Debug) is not available.

@DanTup I'm implementing the Emacs support for dart/flutter on lsp-dart so I'm checking how you did it on this extension and notice the problems above :)

[DanTup]

@ericdallo thanks! I've added UI Guides to the list above. CodeLens is supposed to work, though I can see it failing so I've opened https://github.com/Dart-Code/Dart-Code/issues/2421 - probably will be an easy fix. Thanks!

[ericdallo]

I implemented the both features on lsp-dart, so I think it's easy to fix them on the vscode extension :)

[DanTup]

@ericdallo actually, the reason my code lens didn't work is that I was using an older Dart SDK that wasn't sending the outline notifications. On the most recent nightly the code lens seem to work fine. Do you know what version you were using when you saw it fail?

[ericdallo]

Yeah, me too :sweat_smile: I was using dart dev 2.8.0-10

[DanTup]

Ok great, working as expected then :-) I've fixed up Flutter UI Guides and Gutter icons too.

[ericdallo]

Nice! just a thing to keep in mind, If the next features could be implemented for LSP too, I could implement it on lsp-dart :)
Thanks!

[DanTup]

@ericdallo do you mean specific features, or just in general? Any new features being implemented are very likely to be added to LSP too (some may even only be implemented in LSP) as I'd like to switch Dart-Code over to LSP by default (without losing any significant functionality).

Some of the things mentioned above (like dart.analysisExcludedFolders and dart.doNotFormat) are kinda hacks though, so they might not be carried over (or may be reworked if they are).

[ericdallo]

Nice, good to know!
That's what I wanted to hear, I was afraid that DAS was the focus for new features, not LSP

[Kavantix]

I just tested the lsp preview in vscode and dart-lang/sdk#41195 also happens in vscode.
If you have a file open and add some class to it you cannot auto import it into another file until you close the window or tab the file was opened in.

[Kavantix]

Also, the line length setting for the formatter is ignored

[DanTup]

@Kavantix

I just tested the lsp preview in vscode and dart-lang/sdk#41195 also happens in vscode.

Do you have steps to repro this in VS Code? I just tried following essentially the same instructions, but it didn't seem to happen. If you can grab an analysis server log while doing so, that may help too.

Also, the line length setting for the formatter is ignored

Thanks! Got a fix for this at https://dart-review.googlesource.com/c/sdk/+/154008.

[Kavantix]

I enabled the log file but it stays empty (other than the versions I am using)
Here is a gif showing the issue:

[DanTup]

@Kavantix I reproduced this with Dart 2.8.2 but couldn't reproduce on the current code to try and debug. Could you temporarily try with the latest nightly SDK from http://gsdview.appspot.com/dart-archive/channels/be/raw/latest/sdk/ to see if it still happens for you there?

I enabled the log file but it stays empty (other than the versions I am using)

That doesn't sound right - though VS Code sometimes doesn't update files that are modified correctly unless you close/re-open them - could it be that? Also - can you check you used dart.analyzerLogFile and not dart.analyzerInstrumentationLogFile? Thanks!

[RaviKavaiya]

Thanks! Got a fix for this at https://dart-review.googlesource.com/c/sdk/+/154008.

@DanTup I am using latest beta version of DartCode in LSP mode. How can I set custom line length?

[Kavantix]

@DanTup Also happens with the last version:
"143" alt="image" src="https://user-images.githubusercontent.com/6243755/87850006-2f9f6100-c8ed-11ea-9342-281920f43312.png">

It did however now write some info to the log file
dartlog_import_issue.txt

Btw I was checking the log file using tail -f from the command line ;)

[DanTup]

@RaviKavaiya

@DanTup I am using latest beta version of DartCode in LSP mode. How can I set custom line length?

This fix is in the server, so you need an updated Dart SDK (such as a nightly from http://gsdview.appspot.com/dart-archive/channels/be/raw/latest/sdk/). It should then use the same dart.lineLength setting that the non-LSP implementation uses.

@Kavantix

@DanTup Also happens with the last version:

Thanks - I also managed to hit this again yesterday in the nightly, so it is still there. I'll do some more digging, thanks!

[RaviKavaiya]

@DanTup Sorry, I don't know whether I should ask that here. But, Flutter doesn't allow custom Dart SDKs right? If yes, then I would wait for it. (BTW, I am on Flutter Dev channel)

[DanTup]

@RaviKavaiya correct - for Flutter you need to use the SDK it provides. When you run flutter --version it will show the version of the SDK (eg. Dart 2.9.0 (build 2.9.0-21.0.dev 89fe12b12a)) so once that's higher than the version that includes this change it should work.

[DanTup]

@Kavantix I got to the bottom of the issue - I've got a fix out for review at https://dart-review.googlesource.com/c/sdk/+/154960/. Thanks!

[Kavantix]

@DanTup I can confirm that the fix works, Thanks a lot this will save me quite some headaches using the LSP in vim :)

[DanTup]

@Kavantix excellent, thanks for confirming!

[DanTup]

Most of the issue here are resolved. There are a few outstanding which have their own issues (which I've linked in the description above), which I'm hoping to address fairly soon so that LSP can become the default.

If you encounter any other issues not listed, please file new specific issues. Thanks!