Add `go.toolCommands` which specifies alternate command locations #1297

ikedam · 2017-10-21T08:24:55Z

Appengine Go SDK provides goapp command which wraps go command.

I need to create a symbolic link go to goapp to develop Appengine Go applications with vscode-go.
But I don't want to do that as it masks the original go command. I want to use both goapp in the Appengine Go SDK and go of of the Appengine Go SDK.

This request enables to configure alternate command for go like:

    "go.toolCommands": {
        "go": "goapp.exe"
    },

You can also provide absolute path:

    "go.toolCommands": {
        "go": "/home/ikedam/go_wrap.sh"
    },

You can also configure alternate command for other tool:

    "go.toolCommands": {
        "godoc": "C:\\Users\\ikedam\\godoc_with_options.bat"
    },

msftclas · 2017-10-21T08:25:04Z

All CLA requirements met.

ramya-rao-a

@ikedam Thanks for this PR and I apologize for not getting to this earlier.

I found 1 issue due to which this will not work in Windows and another due to which debugging will not work.

I will push a commit to fix both, can you help with testing?

ramya-rao-a · 2018-05-17T23:55:29Z

src/goPath.ts


 let binPathCache: { [bin: string]: string; } = {};
 let runtimePathCache: string = '';

 export function getBinPathFromEnvVar(toolName: string, envVarValue: string, appendBinToPath: boolean): string {
-	toolName = correctBinname(toolName);
+	let binname = correctBinname(toolName);


correctBinName gets run twice resulting in strings like golint.exe.exe in Windows

ramya-rao-a · 2018-05-17T23:56:11Z

src/goPath.ts

@@ -11,16 +11,21 @@
 import fs = require('fs');
 import path = require('path');
 import os = require('os');
+import vscode = require('vscode');


This file is used by the debug adapter via the goDebug.ts file. The debug adapter runs in a different process than the extension host and so will not have access to vscode

ramya-rao-a · 2018-05-18T00:06:36Z

To test this feature, do the following:

Download https://github.com/ikedam/vscode-go/blob/feature/toolCommands/Go-latest.vsix
Run code --install-extension Go-latest.vsix
If the above fails with Error: end of central directory record signature not found, then clone this repo and use the Go-latest.vsix file from the cloned repo
Reload VS Code

Add the setting go.toolCommands as described up above

jlindsey · 2018-05-18T13:33:32Z

Downloaded and installed this from the .vsix file.

It seems to be doing what it says on the tin: When I add the following to my settings.json:

{
    "go.toolCommands": {
        "go": "wgo"
    }
}

Then looking in the Output tab I see the tool being replaced properly in my project:

/Users/jl2243/projects/terraform/tools/nagios/rpc/src/tf_nagios_api>Finished running tool: /Users/jl2243/projects/go/bin/wgo build -i -o /var/folders/3_/8n0lrvq17qb3rkdwd4dfgr_80000gp/T/go-code-check tf_nagios_api

However: when I intentionally break my code by adding an unused import, I do not get any error report. In the terminal, running this manually I get:

/Users/jl2243/projects/go/bin/wgo build -i -o /var/folders/3_/8n0lrvq17qb3rkdwd4dfgr_80000gp/T/go-code-check tf_nagios_api
# tf_nagios_api
src/tf_nagios_api/service.go:6:2: imported and not used: "encoding/json"

But no output in VSCode or the Problems tab. I don't know if this is a separate issue or not.

ikedam · 2018-05-19T13:31:34Z

@ramya-rao-a
I reproduced the issue that you pointed in my environment. Sorry.
And your fix worked perfect, thanks!

ikedam · 2018-05-19T13:33:04Z

@jlindsey Would you tell me what is wgo?

In my environment, error reports are shown as expected by using goapp instead of go.

The issue may be caused for what wgo does.

jlindsey · 2018-05-19T14:22:48Z

@ikedam https://github.com/skelterjohn/wgo

It is similar to gb in that it aims to bypass $GOPATH nonsense and enable the creation of "self-contained" Go project directories. Instead of replacing the go tool like gb does, wgo wraps it while manipulating paths and config options.

jlindsey · 2018-05-19T14:34:25Z

@ikedam @ramya-rao-a After doing some more tests on my end, I believe my results were caused by old configs in my global User settings. After removing all the go.*settings from there and running more tests on a few codebases, everything behaves as expected.

LGTM now. 👍

ramya-rao-a · 2018-05-22T04:42:44Z

Thanks for verifying @ikedam and @jlindsey

On second thoughts, I am wondering if there are really any benefits of having this customization feature for other tools (not go, but other tools like godoc, gorename, goformat etc)

This feature provides 2 benefits. One is the ability to use a totally different tool, the other is to use the same tool from a different location.

Each of these tools take in very specific input parameters. What are the chances of having another tool that takes in exact same parameters? The benefit of different location is available even today. If you have the tool under the PATH variable, then it will get picked up.

I propose to have this customization feature just for go.

Thoughts?

jlindsey · 2018-05-22T13:24:27Z

I propose to have this customization feature just for go.

This is fine with me and it's all I personally need. However, one benefit of wgo is its wgo exec method, which wraps whatever command you pass it in the $GOPATHand environment variables that wgo generates. This could potentially be useful for the other tools you mentioned.

mbenkmann · 2018-05-22T15:46:57Z

Correct me if I'm wrong, but right now the feature seems to be completely generic. It's a mapping that just works for all tools. Would limiting it to "go" not require adding extra checks just to take away features?

As for the usefulness for other tools, one issue I've run into several times already is that to figure out why something wasn't working (most recently why gogetdoc wasn't finding the docs for a symbol) I introduced a wrapper script that would log the parameters the tool was called with and its output. This feature would make this much easier and cleaner. Adding a script with the same name as a standard tool to a directory in the PATH is a clutch. With this feature I could do such testing in workspace settings so it wouldn't interfere with anything.

And then there is the case of my goformat tool. Before it was added to the valid list of values for go.formatTool, I had to rename it to gofmt to avoid the error. Again, this mapping feature would have provided a cleaner solution.

Right now I'm toying with the idea of developing an alternative to gogetdoc that works without compiling, so it would be faster. This mapping feature would make testing this tool easier because I could override gogetdoc in the workspace settings as opposed to fiddling with my PATH.

To put it simply: There are a lot of fringe uses for a generic mapping feature like this. If it doesn't make the code worse, I would keep the ability to remap all tools.

mbenkmann · 2018-05-22T15:52:39Z

Speaking of my use cases, if this doesn't work already, please add the ability to use the ${workspaceFolder} variable in the mapping for a tool, so that I can have mappings in my workspace settings together with the tools they refer to.

ikedam · 2018-05-22T22:07:54Z

@ramya-rao-a
+1 and -1 for having this feature only for go:

+1 as

I'm happy even with switching only go for my current usecase.
- I don't have actual usecases for switching other tools.
vscode-go handles the path for go and those for other tools in different ways (getGoRuntimePath() and getBinPathWithPreferredGopath()), and it can easily cause bugs to switching paths in the same way, just like I did. It makes sense to apply this feature only to go for now, and then introduce a feature for other tools in another day.

-1 as

I believe the feature for other tools is still useful as @mbenkmann pointed:
- Useful for per-workspace settings.
- Wrapping a tool to change the tool behavior (e.g. add a option switch when launching).

So how about going in this way?:

Close this request.
Create a new request to generalize and unite getGoRuntimePath() and getBinPathWithPreferredGopath().
- I plan getBinPath(toolName, searchPaths, defaultPaths).
Create a new request remaking this request.

I think I can work for that in June.

ikedam · 2018-05-23T13:14:31Z

I worry that we lose the chance to generalize getGoRuntimePath() and getBinPathWithPreferredGopath() forever if we apply this feature only to go here.

ramya-rao-a · 2018-05-24T03:36:49Z

I'll have to go back in history to see why the two were implemented differently to begin with :) So that we dont regress anything

ramya-rao-a · 2018-06-11T22:37:51Z

This is merged in master. Please give it a try by following the below steps and share any feedback you have.

Download https://github.com/Microsoft/vscode-go/blob/master/Go-latest.vsix
Run code --install-extension Go-latest.vsix
If the above fails with Error: end of central directory record signature not found, then clone this repo and use the Go-latest.vsix file from the cloned repo
Reload VS Code
Use the setting go.alternateTools for your needs of mapping the tools as needed

jlindsey · 2018-06-12T12:52:13Z

@ramya-rao-a Downloaded and installed successfully. Switched my config above for the new setting name. Everything still works fine and as expected.

Thanks for your hard work on this!

ramya-rao-a · 2018-06-15T21:18:47Z

This feature is now available in the latest update to the Go extension (0.6.83)

ikedam · 2018-06-18T23:33:14Z

@ramya-rao-a I tried 0.6.83-beta-1 (and 0.6.83, sorry for my late response).
It worked perfectly. I can use goapp in my project.
Thanks for all the work!

ramya-rao-a · 2018-06-19T05:35:44Z

Thanks to you too @ikedam!

Add go.toolCommands which specifies alternate command locations

f0013b9

ramya-rao-a force-pushed the master branch 3 times, most recently from 89e20b7 to 3d8a1f0 Compare November 4, 2017 19:44

ramya-rao-a force-pushed the master branch 2 times, most recently from 7d591f1 to a8a68e2 Compare November 19, 2017 17:39

ramya-rao-a force-pushed the master branch from bbfe8ba to e0e5d56 Compare January 23, 2018 22:31

jlindsey mentioned this pull request May 16, 2018

When using gb, extension should not rely on go to build or regular gopath #1679

Closed

Merge remote-tracking branch 'origin/master' into feature/toolCommands

c9a4138

ramya-rao-a suggested changes May 17, 2018

View reviewed changes

ramya-rao-a added 2 commits May 17, 2018 17:02

gopath shldnt have dependency on vscode, fixing for Windows

b273fd5

vsix for testing

42a4c40

ramya-rao-a mentioned this pull request Jun 4, 2018

Support gometalinter 2.0 #1393

Closed

ramya-rao-a added 3 commits June 10, 2018 11:54

Merge remote-tracking branch 'origin/master' into feature/toolCommands

a6481e3

Better name for setting

f138531

Combine getGoRuntimePathInternal into getBinPathWithPreferredGopath

e78b476

ramya-rao-a added 3 commits June 10, 2018 15:24

Update config description

69bc71c

Add top used tools to alternate tools setting

d21f4b8

If absolute alternate path doesnt exist, ignore it

a52239b

ramya-rao-a approved these changes Jun 10, 2018

View reviewed changes

ramya-rao-a merged commit e882fb2 into microsoft:master Jun 11, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `go.toolCommands` which specifies alternate command locations #1297

Add `go.toolCommands` which specifies alternate command locations #1297

ikedam commented Oct 21, 2017

msftclas commented Oct 21, 2017 •

edited

Loading

ramya-rao-a left a comment

ramya-rao-a May 17, 2018

ramya-rao-a May 17, 2018

ramya-rao-a commented May 18, 2018 •

edited

Loading

jlindsey commented May 18, 2018

ikedam commented May 19, 2018

ikedam commented May 19, 2018 •

edited

Loading

jlindsey commented May 19, 2018

jlindsey commented May 19, 2018

ramya-rao-a commented May 22, 2018

jlindsey commented May 22, 2018

mbenkmann commented May 22, 2018

mbenkmann commented May 22, 2018

ikedam commented May 22, 2018

ikedam commented May 23, 2018 •

edited

Loading

ramya-rao-a commented May 24, 2018

ramya-rao-a commented Jun 11, 2018

jlindsey commented Jun 12, 2018

ramya-rao-a commented Jun 15, 2018

ikedam commented Jun 18, 2018

ramya-rao-a commented Jun 19, 2018

Add go.toolCommands which specifies alternate command locations #1297

Add go.toolCommands which specifies alternate command locations #1297

Conversation

ikedam commented Oct 21, 2017

msftclas commented Oct 21, 2017 • edited Loading

ramya-rao-a left a comment

Choose a reason for hiding this comment

ramya-rao-a May 17, 2018

Choose a reason for hiding this comment

ramya-rao-a May 17, 2018

Choose a reason for hiding this comment

ramya-rao-a commented May 18, 2018 • edited Loading

jlindsey commented May 18, 2018

ikedam commented May 19, 2018

ikedam commented May 19, 2018 • edited Loading

jlindsey commented May 19, 2018

jlindsey commented May 19, 2018

ramya-rao-a commented May 22, 2018

jlindsey commented May 22, 2018

mbenkmann commented May 22, 2018

mbenkmann commented May 22, 2018

ikedam commented May 22, 2018

ikedam commented May 23, 2018 • edited Loading

ramya-rao-a commented May 24, 2018

ramya-rao-a commented Jun 11, 2018

jlindsey commented Jun 12, 2018

ramya-rao-a commented Jun 15, 2018

ikedam commented Jun 18, 2018

ramya-rao-a commented Jun 19, 2018

Add `go.toolCommands` which specifies alternate command locations #1297

Add `go.toolCommands` which specifies alternate command locations #1297

msftclas commented Oct 21, 2017 •

edited

Loading

ramya-rao-a commented May 18, 2018 •

edited

Loading

ikedam commented May 19, 2018 •

edited

Loading

ikedam commented May 23, 2018 •

edited

Loading