• Stars
    star
    3,810
  • Rank 11,553 (Top 0.3 %)
  • Language
    TypeScript
  • License
    Other
  • Created over 4 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Go extension for Visual Studio Code

Go for Visual Studio Code

Slack

The VS Code Go extension provides rich language support for the Go programming language.

Requirements

  • Visual Studio Code 1.75 or newer (or editors compatible with VS Code 1.75+ APIs)
  • Go 1.18 or newer

Quick Start

Welcome! 👋🏻
Whether you are new to Go or an experienced Go developer, we hope this extension fits your needs and enhances your development experience.

  1. Install Go 1.18 or newer if you haven't already.

  2. Install the VS Code Go extension.

  3. Open any Go file or go.mod file to automatically activate the extension. The Go status bar appears in the bottom right corner of the window and displays your Go version.

  4. The extension depends on go, gopls (the Go language server), and optional tools depending on your settings. If gopls is missing, the extension will try to install it. The ⚡ sign next to the Go version indicates the language server is running, and you are ready to go.


(Install Missing Tools)

You are ready to Go :-)    🎉🎉🎉

What's next

If you are new to Go, this article provides the overview on Go code organization and basic go commands. Watch "Getting started with VS Code Go" for an explanation of how to build your first Go application using VS Code Go.

Feature highlights

  • IntelliSense - Results appear for symbols as you type.
  • Code navigation - Jump to or peek at a symbol's declaration.
  • Code editing - Support for saved snippets, formatting and code organization, and automatic organization of imports.
  • Diagnostics - Build, vet, and lint errors shown as you type or on save.
  • Enhanced support for testing and debugging

See the full feature breakdown for more details.


(Code completion and Signature Help)

In addition to integrated editing features, the extension provides several commands for working with Go files. You can access any of these by opening the Command Palette (Ctrl+Shift+P on Linux/Windows and Cmd+Shift+P on Mac), and then typing in the command name. See the full list of commands provided by this extension.


(Toggle Test File)

⚠️ Note: the default syntax highlighting for Go files is provided by a TextMate rule embedded in VS Code, not by this extension.

For better syntax highlighting, we recommend enabling semantic highlighting by turning on Gopls' ui.semanticTokens setting. "gopls": { "ui.semanticTokens": true }

Setting up your workspace

The VS Code Go extension supports both GOPATH and Go modules modes.

Go modules are used to manage dependencies in recent versions of Go. Modules replace the GOPATH-based approach to specifying which source files are used in a given build, and they are the default build mode in go1.16+. We highly recommend Go development in module mode. If you are working on existing projects, please consider migrating to modules.

Unlike the traditional GOPATH mode, module mode does not require the workspace to be located under GOPATH nor to use a specific structure. A module is defined by a directory tree of Go source files with a go.mod file in the tree's root directory.

Your project may involve one or more modules. If you are working with multiple modules or uncommon project layouts, you will need to configure your workspace by using Workspace Folders. See the Supported workspace layouts documentation for more information.

Preview version

If you'd like to get early access to new features and bug fixes, you can use the nightly build of this extension. Learn how to install it in by reading the Go Nightly documentation.

Telemetry

VS Code Go extension relies on the Go Telemetry to learn insights about the performance and stability of the extension and the language server (gopls). Go Telemetry data uploading is disabled by default and can be enabled with the following command:

go run golang.org/x/telemetry/cmd/gotelemetry@latest on

After telemetry is enabled, the language server will upload metrics and stack traces to telemetry.go.dev. You can inspect what data is collected and can be uploaded by running:

go run golang.org/x/telemetry/cmd/gotelemetry@latest view

If we get enough adoption, this data can significantly advance the pace of the Go extension development, and help us meet a higher standard of reliability. For example:

  • Even with semi-automated crash reports in VS Code, we've seen several crashers go unreported for weeks or months.
  • Even with a suite of benchmarks, some performance regressions don't show up in our benchmark environment (such as the completion bug mentioned below!).
  • Even with lots of great ideas for how to improve gopls, we have limited resources. Telemetry can help us identify which new features are most important, and which existing features aren't being used or aren't working well.

These are just a few ways that telemetry can improve gopls. The telemetry blog post series contains many more.

Go telemetry is designed to be transparent and privacy-preserving. Learn more at https://go.dev/doc/telemetry.

Contributing

We welcome your contributions and thank you for working to improve the Go development experience in VS Code. If you would like to help work on the VS Code Go extension, see our contribution guide to learn how to build and run the VS Code Go extension locally and contribute to the project.

Code of Conduct

This project follows the Go Community Code of Conduct. If you encounter a conduct-related issue, please mail [email protected].

License

MIT

More Repositories

1

go

The Go programming language
Go
121,832
star
2

groupcache

groupcache is a caching and cache-filling library, intended as a replacement for memcached in many cases.
Go
12,859
star
3

dep

Go dependency management tool experiment (deprecated)
Go
12,857
star
4

protobuf

Go support for Google's protocol buffers
Go
9,676
star
5

mock

GoMock is a mocking framework for the Go programming language.
Go
9,286
star
6

tools

[mirror] Go Tools
Go
7,321
star
7

mobile

[mirror] Go on Mobile
Go
5,768
star
8

oauth2

Go OAuth2
Go
5,270
star
9

lint

[mirror] This is a linter for Go source code. (deprecated)
Go
3,974
star
10

glog

Leveled execution logs for Go
Go
3,520
star
11

proposal

Go Project Design Documents
Go
3,312
star
12

crypto

[mirror] Go supplementary cryptography libraries
Go
2,982
star
13

net

[mirror] Go supplementary network libraries
Go
2,846
star
14

example

Go example projects
Go
2,526
star
15

geo

S2 geometry library in Go
Go
1,655
star
16

tour

[mirror] A Tour of Go
Go
1,543
star
17

vgo

[mirror] Versioned Go Prototype
Go
1,519
star
18

snappy

The Snappy compression format in the Go programming language.
Go
1,512
star
19

sys

[mirror] Go packages for low-level interaction with the operating system
Go
1,253
star
20

pkgsite

[mirror] Home of the pkg.go.dev website
Go
1,148
star
21

leveldb

The LevelDB key-value database in the Go programming language.
Go
1,145
star
22

gddo

Go Doc Dot Org
Go
1,104
star
23

gofrontend

Go compiler frontend (gccgo)
Go
852
star
24

sync

[mirror] concurrency primitives
Go
848
star
25

exp

[mirror] Experimental and deprecated packages
Go
838
star
26

freetype

The Freetype font rasterizer in the Go programming language.
Go
783
star
27

text

[mirror] Go text processing support
Go
745
star
28

playground

[mirror] The Go Playground
Go
741
star
29

talks

Go talks
694
star
30

appengine

Go App Engine packages
Go
669
star
31

build

[mirror] Go's continuous build and release infrastructure (no stability promises)
Go
627
star
32

vulndb

[mirror] The Go Vulnerability Database
Go
555
star
33

image

[mirror] Go supplementary image libraries
Go
522
star
34

blog

[mirror] Go Blog (obsolete)
389
star
35

time

[mirror] Go supplementary time packages
Go
383
star
36

vuln

[mirror] the database client and tools for the Go vulnerability database
Go
376
star
37

perf

[mirror] Performance measurement, storage, and analysis.
Go
375
star
38

website

[mirror] Home of the go.dev and golang.org websites
HTML
373
star
39

sublime-build

The official Sublime Text package for Go build system integration.
Python
343
star
40

xerrors

Go
277
star
41

term

Go terminal and console support
Go
272
star
42

debug

[mirror] debugging tools
Go
230
star
43

dl

[mirror] go install golang.org/dl/go1.N@latest
Go
189
star
44

mod

[mirror] Go module mechanics libraries
Go
187
star
45

benchmarks

Benchmarks for the perf dashboard
Go
181
star
46

arch

[mirror] architecture code
Go
145
star
47

review

[mirror] Tool for working with Gerrit code reviews
Go
143
star
48

cwg

Community outreach Working Group
132
star
49

oscar

[mirror] Open source contributor agent architecture repo.
Go
90
star
50

govulncheck-action

[mirror] GitHub action for govulncheck
89
star
51

sublime-config

A library for Go environment configuration in Sublime Text
Python
85
star
52

winstrap

Bootstrapping tools for windows builders
Go
48
star
53

telemetry

[mirror] Go Telemetry services and libraries
Go
36
star
54

wiki

[mirror] Go Wiki
29
star
55

scratch

[mirror] repository used for testing
Go
28
star
56

pkgsite-metrics

Code to serve pkg.go.dev/metrics [mirror]
Go
13
star
57

go-get-issue-15410

go-get-issue-15410
Go
4
star
58

.github

2
star
59

.allstar

2
star