Add support for bingo & golsp language server (#2143) #2158

tohjustin · 2018-11-28T06:52:12Z

Hi @ramya-rao-a, here's my attempt to add support for bingo & golsp language servers to the extension.

This Closes #2143.

Additional Notes

When testing the extension with bingo as the language server & I would receive <MY_PROJECT_DIR>/go.mod does not exist, please use 'go mod init' to create it errors (since bingo only supports Go Module based projects).
Do we want to support any language server specific flags/logic to handle cases like the example above?

msftclas · 2018-11-28T06:52:23Z

All CLA requirements met.

ramya-rao-a · 2018-11-28T07:40:43Z

You can use the isModSupported function to figure out if the current workspace supports modules or not. Based on this, you can then decide whether to use bingo or not.

tohjustin · 2018-11-28T08:06:03Z

You can use the isModSupported function to figure out if the current workspace supports modules or not. Based on this, you can then decide whether to use bingo or not.

Just want to clarify a little more on this, if the user configured their vscode settings to useLanguageServer: 'bingo' and

if isModSupported returns true, we'll use bingo as usual
if isModSupported returns false, we display a message notifying the user that bingo is used since it only supports Go Module based projects & the current project/workspace isn't --> treat the session as useLanguageServer: 'none'?

ramya-rao-a · 2018-11-29T04:48:42Z

Yes, thats right.

tohjustin · 2018-11-29T08:16:16Z

Not sure if there's a better place to check isModSupported when using the bingo language server =S

After adding isModSupported() inside checkLanguageServer, the function is now asynchronous & async/await statements were added.
Another alternative I can think of is to place the isModSupported checks in provideDocumentFormattingEdits & provideCompletionItem instead (possibly affect performance?).

anjmao · 2018-11-30T21:47:26Z

src/goInstallTools.ts

+	if (activeFileUri !== null) {
+		const isModSupportedResult = await isModSupported(activeFileUri);
+		if (languageServer === 'bingo' && !isModSupportedResult) {
+			vscode.window.showInformationMessage('The Go language server (bingo) does not support non-go module projects. Falling back to default behavior.');


Check this commit saibing/bingo@f9f872a
Bingo already supports non-go module projects. I tested it in GOPATH without modules and it was working fine.

Thanks for that info @anjmao!
@saibing Can you confirm that non-go module support is ready for use?

@ramya-rao-a

bingo already supports non-go module project, I have done some manual test cases, it looks like everything is fine, I will add some automation test cases in the future.

@anjmao Thanks for the heads up! Kudos to @saibing for adding support for non-go module projects in such a short period of time 😅

@ramya-rao-a I guess I can remove the isModSupported checks?

@tohjustin Yes, I just tested it out with GOPATH, and it works. So we can remove the isModSupported checks.

ramya-rao-a · 2018-11-30T23:04:21Z

src/goInstallTools.ts

@@ -40,6 +42,8 @@ const _allTools: { [key: string]: string } = {
 	'golangci-lint': 'github.com/golangci/golangci-lint/cmd/golangci-lint',
 	'revive': 'github.com/mgechev/revive',
 	'go-langserver': 'github.com/sourcegraph/go-langserver',
+	'bingo': 'github.com/saibing/bingo',
+	'golsp': 'golang.org/x/tools/cmd/golsp',


@stamblerre Would this be the right import path to use in go get for the language server from your team?

ramya-rao-a · 2018-11-30T23:05:48Z

src/goInstallTools.ts

@@ -183,6 +195,8 @@ export function installAllTools(updateExistingToolsOnly: boolean = false) {
 		'golangci-lint': 'Linter)',
 		'revive': '\t\t(Linter)',
 		'go-langserver': '(Language Server)',
+		'bingo': '(Language Server)',
+		'golsp': '(Language Server)',


To help users differentiate lets add some suffixes here like

Language Server by Sourcegraph

Language Server by Google

Language Server by saibing

ramya-rao-a · 2018-11-30T23:07:51Z

src/goInstallTools.ts

+	if (activeFileUri !== null) {
+		const isModSupportedResult = await isModSupported(activeFileUri);
+		if (languageServer === 'bingo' && !isModSupportedResult) {
+			vscode.window.showInformationMessage('The Go language server (bingo) does not support non-go module projects. Falling back to default behavior.');


Thanks for that info @anjmao!
@saibing Can you confirm that non-go module support is ready for use?

ramya-rao-a · 2018-11-30T23:08:48Z

@tohjustin The README.md would also need an update. There is a section there on the language server usage

ramya-rao-a · 2018-11-30T23:13:57Z

src/goInstallTools.ts

 		tools.push('go-langserver');
 	}

+	if (goConfig['useLanguageServer'] === 'bingo') {


bingo is only supported from Go 1.11 onwards, so we should include that check here

Ah missed that out, will add the check in the following patch.

tohjustin · 2018-12-01T19:36:20Z

@tohjustin The README.md would also need an update. There is a section there on the language server usage

Reworded quite a bit of the language server section (also ran it through Grammarly), please do let me know if you think it still needs more work 😅

tohjustin · 2018-12-07T15:16:57Z

Hi @ramya-rao-a , I saw the issue opened by @stamblerre in saibing/bingo#13 & seems like the plan is to focus on golsp development.

Any updates on this PR? 😅

anjmao · 2018-12-07T19:24:50Z

README.md

+* Changes made to the `go.useLanguageServer` setting requires VS Code to be reloaded to take effect.
+* To collect traces, set `"go.languageServerFlags": ["-trace"]`.
+* To collect errors from the language server in a log file, set `"go.languageServerFlags": ["-trace", "-logfile", "path to a text file that exists"]`.
+* Use the `go.languageServerExperimentalFeatures` setting to opt-in to experimental features such as Code Completion and Code Formatting.


@ramya-rao-a @tohjustin Can we make go.languageServerExperimentalFeatures autocomplete and code formatting to be true by default? If I'm using LSP all I want to set by default is go. useLanguageServer setting and get all the LSP features.

ramya-rao-a · 2018-12-07T22:12:10Z

Can we make go.languageServerExperimentalFeatures autocomplete and code formatting to be true by default?

@anjmao Yes, we can do that

I saw the issue opened by @stamblerre in saibing/bingo#13 & seems like the plan is to focus on golsp development.

@tohjustin Given that there is a good likelihood of all 3 language servers merging into 1 (Sourcegraph plans to use the one from Google, @saibing and Google are planning to work together, I want to avoid changing the schema of the useLanguageServer setting.

Instead, if one wants to use another language server, they can use the go.alternateTools setting as below:

"go.alternateTools": {
     "go-langserver": "bingo"
}

This would need some changes from the extension which I have already made in ecb691c.

@anjmao, @tohjustin Can you try the latest beta version with the above setting and let me know if you see any issues?

ramya-rao-a · 2018-12-07T22:16:53Z

@anjmao On second thoughts, I don't want to enable the formatting feature by the language server by default just yet. This is because the language server doesn't respect the formatFlags or the formalTool settings.

I don't want to enable the auto-completion feature by language server by default, because the language server doesn't support completions for unimported packages yet.

Once these 2 features from the language server has complete parity with what the extension does, I will turn them on by default.

tohjustin · 2018-12-08T04:14:30Z

@ramya-rao-a Really appreciate the update!

Yup the the go.alternateTools setting is working as intended. Got bingo to work with the extension using the following settings (also needed go.useLanguageServer set as true):

  "go.alternateTools": {
    "go-langserver": "bingo",
  },
  "go.languageServerExperimentalFeatures": {
    "format": true,
    "autoComplete": true
  },
  "go.useLanguageServer": true

I guess I'll leave it up to you to close this PR or put it on hold until the new Go language server is ready. 👍

ramya-rao-a · 2018-12-08T21:13:25Z

Yup the the go.alternateTools setting is working as intended.

Thanks for confirming the beta version @tohjustin!

I have updated the wiki on Go modules support in VS Code appropriately.

I guess I'll leave it up to you to close this PR or put it on hold until the new Go language server is ready.

I believe closing this PR is the right thing to do as I want to avoid changes in settings schema as much as possible.

Thanks for all your work on this @tohjustin, it is very much appreciated.

tohjustin force-pushed the issue-2143 branch 2 times, most recently from d62d0d2 to af37c17 Compare November 29, 2018 07:55

tohjustin mentioned this pull request Nov 30, 2018

Support for non-gomod projects? saibing/bingo#5

Closed

anjmao reviewed Nov 30, 2018

View reviewed changes

ramya-rao-a mentioned this pull request Nov 30, 2018

Autocomplete/intellisense <=50% success rate with gocode-gomod #2161

Closed

ramya-rao-a reviewed Nov 30, 2018

View reviewed changes

tohjustin force-pushed the issue-2143 branch 2 times, most recently from 0c0c09d to 5d21bf4 Compare December 1, 2018 07:57

tohjustin force-pushed the issue-2143 branch 3 times, most recently from c0f4d1b to 6d65664 Compare December 2, 2018 23:31

Add support for bingo & golsp language server

835f2a0

tohjustin force-pushed the issue-2143 branch from 6d65664 to 835f2a0 Compare December 6, 2018 07:03

anjmao reviewed Dec 7, 2018

View reviewed changes

ramya-rao-a closed this Dec 8, 2018

ramya-rao-a mentioned this pull request Dec 8, 2018

please support more go langserver tools such as bingo, golsp #2143

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for bingo & golsp language server (#2143) #2158

Add support for bingo & golsp language server (#2143) #2158

tohjustin commented Nov 28, 2018 •

edited

Loading

msftclas commented Nov 28, 2018 •

edited

Loading

ramya-rao-a commented Nov 28, 2018

tohjustin commented Nov 28, 2018 •

edited

Loading

ramya-rao-a commented Nov 29, 2018

tohjustin commented Nov 29, 2018

anjmao Nov 30, 2018

ramya-rao-a Nov 30, 2018

saibing Dec 1, 2018

tohjustin Dec 1, 2018

ramya-rao-a Dec 2, 2018

tohjustin Dec 2, 2018

ramya-rao-a Nov 30, 2018

ramya-rao-a Nov 30, 2018

tohjustin Dec 1, 2018

ramya-rao-a Nov 30, 2018

ramya-rao-a commented Nov 30, 2018

ramya-rao-a Nov 30, 2018

tohjustin Dec 1, 2018 •

edited

Loading

tohjustin Dec 1, 2018

tohjustin commented Dec 1, 2018

tohjustin commented Dec 7, 2018

anjmao Dec 7, 2018

ramya-rao-a commented Dec 7, 2018 •

edited

Loading

ramya-rao-a commented Dec 7, 2018

tohjustin commented Dec 8, 2018

ramya-rao-a commented Dec 8, 2018

Add support for bingo & golsp language server (#2143) #2158

Add support for bingo & golsp language server (#2143) #2158

Conversation

tohjustin commented Nov 28, 2018 • edited Loading

msftclas commented Nov 28, 2018 • edited Loading

ramya-rao-a commented Nov 28, 2018

tohjustin commented Nov 28, 2018 • edited Loading

ramya-rao-a commented Nov 29, 2018

tohjustin commented Nov 29, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ramya-rao-a commented Nov 30, 2018

Choose a reason for hiding this comment

tohjustin Dec 1, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tohjustin commented Dec 1, 2018

tohjustin commented Dec 7, 2018

Choose a reason for hiding this comment

ramya-rao-a commented Dec 7, 2018 • edited Loading

ramya-rao-a commented Dec 7, 2018

tohjustin commented Dec 8, 2018

ramya-rao-a commented Dec 8, 2018

tohjustin commented Nov 28, 2018 •

edited

Loading

msftclas commented Nov 28, 2018 •

edited

Loading

tohjustin commented Nov 28, 2018 •

edited

Loading

tohjustin Dec 1, 2018 •

edited

Loading

ramya-rao-a commented Dec 7, 2018 •

edited

Loading