How should I set up vscode for contributions?

[GuySartorelli]

@rfay as per #5732 (comment)

please see if you can convince your IDE to use standard gofmt formatting, which is what's generally required. As you point out, it makes a mess and is hard to review when things get changed that aren't relevant to the PR. Happy to chat with you about this, I know the timezones are hard. But it would be cool if you could experiment a bit to see if you can calm it down a bit. What IDE are you using? How do you have it set up? We can discuss in another issue if that's the easiest.

I'm using vscode with this extension - I haven't don't any other configuration related to go.

[rfay]

I guess that's all we do in gitpod setup,

ddev/.gitpod.yml

Lines 30 to 40 in dab6258

	vscode:
	extensions:
	# Go extension
	- golang.go
	# PHP extension
	- felixfbecker.php-debug
	# Bash extensions
	- timonwong.shellcheck
	- rogalmic.bash-debug

I wonder if there's any gofmt-specific stuff to do. Do you have gofmt installed? Homebrew installs it as part of go. It's the definitive style formatter for go in general, and it's what DDEV insists on in the code tests.

[GuySartorelli]

Yup gofmt is installed.

it's what DDEV insists on in the code tests

Code tests or lint tests? The lint test hasn't failed on me since my early contributions so I think maybe that's working as expected?

[rfay]

It's the linting test, and no it won't fail, but I'm hoping that your vscode uses gofmt as "source of truth".

[tyler36]

Do you have gofmt installed?

For others that might be reading this. How can you check that gofmt is install?

[rfay]

which gofmt will show it if it's installed and in your path.

[rfay]

The changes that actually ended up in your PRs weren't a problem, and I'm not sure there's anything we need to do about them. In the past, we've had aggressive things from vscode (rearranging imports without being asked, etc.) but yours don't show that. I think that's done by additional vscode golang extensions.

If you see anything that can be improved in https://github.com/ddev/ddev/tree/master/.vscode it's welcome.

I don't think we have a problem, and thanks for your amazing contributions.

If you see suspect unneeded reformatting in your PRs (beyond what gofmt would do), please poke around to chase it, but again I think it's all fine.

[GuySartorelli]

Sweet, no worries. This is the only project I use go for and I'm still very new to it - it's unlikely I'd notice that formatting doesn't match what gofmt would produce, so if you notice any non-gofmt-compliant formatting creep in please let me know (pointing out the specific formatting in question) and I'll look into it.

[tyler36]

@GuySartorelli

If you haven't already seen it, there was a contributor-training workshop: Setting up a Go Development Environment

It cover some VSCode setup.

Other workshops are list here: https://ddev.com/blog/contributor-training/

[GuySartorelli]

Thanks, I'll give it a look and see if there's something I might want to change based on that.