Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve documentation about the go tools installed by the extension #95

Closed
Kur-Ich opened this issue May 26, 2020 · 2 comments
Closed

Comments

@Kur-Ich
Copy link

Kur-Ich commented May 26, 2020

I'm getting daily notifications that I'm missing some add-ons for Go. It would be nice if you could select in Settings which add-ons you want to use and which ones not, I really don't want to use formatting type add-ons for example which auto format the code in a certain way. Also an explanation would be nice of what the add-on exactly does so that it would be easy to select which ones you want. Currently a lot of Go extensions got automatically installed on my VSCode and it is not clear to me what they do.

@hyangah
Copy link
Contributor

hyangah commented May 26, 2020

About what each tool is doing:
https://github.com/golang/vscode-go/blob/master/docs/tools.md

We need better documentation and improve the installation process.

About formatting: formatting can be disabled with "editors.formatOnSave", for example,

"[go]": {
   "editors.formatOnSave": false
}

But, go has its own formatting rule from the very beginning of the language, and
the formatting tool is an essential part of the Go code writing that helps keeping the code style consistent among Go developers. Skipping formatting and applying different formatting rules is not recommended in general.

If you use gopls, many of them are unnecessary, and the extension shouldn't suggest installation of those tools - please update #51 if you find any questionable tools that were recommended when using gopls.

@hyangah hyangah changed the title Extensions docs: improve documentation about the go tools installed by the extension May 26, 2020
@hyangah
Copy link
Contributor

hyangah commented Feb 14, 2021

Recently we updated our tools documentation and also the minimal list of the required tools as we enabled gopls by default. Please file a new issue if the documentation is still ambiguous or if the extension requires you to install more tools than necessary.

@hyangah hyangah closed this as completed Feb 14, 2021
@golang golang locked and limited conversation to collaborators Feb 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants