From 77ee861ca208fd7f5a674ac0c442f92009ae42d7 Mon Sep 17 00:00:00 2001 From: Jaana Burcu Dogan Date: Wed, 14 Jun 2017 12:41:14 -0700 Subject: doc: add an editor guide The Go ecosystem provides many tools to make Go development more productive and seamless. Document the availability of the editor plugins and IDEs, add an overview of feature support and screencasts. Updates #20398. Updates #20402. Updates #20399. Updates #20401. Updates #20569. Change-Id: I0c6cb48eb4e3848807aaad78390493e14f097916 Reviewed-on: https://go-review.googlesource.com/45772 Reviewed-by: Steve Francia --- doc/docs.html | 6 ++ doc/editors.html | 210 +++++++++++++++++++++++++++++++++++++++++++++++ doc/editors/gogland.png | Bin 0 -> 9430 bytes doc/editors/vimgo.png | Bin 0 -> 7591 bytes doc/editors/vscodego.png | Bin 0 -> 3373 bytes 5 files changed, 216 insertions(+) create mode 100644 doc/editors.html create mode 100644 doc/editors/gogland.png create mode 100644 doc/editors/vimgo.png create mode 100644 doc/editors/vscodego.png diff --git a/doc/docs.html b/doc/docs.html index 1ccd1f3fe7..92392e2596 100644 --- a/doc/docs.html +++ b/doc/docs.html @@ -57,6 +57,12 @@ explains how to use the go command to fetch, build, and install packages, commands, and run tests.

+

Editor plugins and IDEs

+

+A document that summarizes commonly used editor plugins and IDEs with +Go support. +

+

Effective Go

A document that gives tips for writing clear, idiomatic Go code. diff --git a/doc/editors.html b/doc/editors.html new file mode 100644 index 0000000000..dd74446d7b --- /dev/null +++ b/doc/editors.html @@ -0,0 +1,210 @@ + + +

Introduction

+ +

+ This document lists commonly used editor plugins and IDEs from the Go ecosystem + that makes Go development more productive and seamless. + A comphensive list of editor support and IDEs for Go development is available on + the wiki. +

+ +

Options

+

+The Go ecosystem provides a variety of editor plugins and IDEs to enhance your day-to-day +editing, navigation, testing, and debugging experience. +

+ + + +

+Note that these are only a few top solutions, a more comphensive +community maintained list of +IDEs and text editor plugins +is available at the wiki. +

+ +

+Each development environment provides a large variety of static and dynamic tool integrations. +The following feature matrix lists and compares the most significant features. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Vim Go
Visual Studio Code Go
Gogland
Editing features
Build and run from the editor/IDEYesYesYes
Autocompletion of identifers (variable, method, and function names)YesYesYes
Autocompletion based on typeNoNoYes
Rename identifiersYesYesYes
Auto format, build, vet, and lint on saveYesYesYes1
Auto insert import paths and remove unused on saveYesYesYes2
Auto generate JSON, XML tags for struct fieldsYesYesYes
Navigation features
Display documentation inline, or open godoc in browserYesYesYes
Switch between *.go and *_test.go fileYesYesYes
Jump to definition and refereesYesYesYes
Look up for interface implementationsYesYesYes
Search for callers and calleesYesYesYes
Testing and debugging features
Debugger supportNoYesYes
Run a single test case, all tests from file, or all tests from a packageYesYesYes
Auto generate tests for packages, files and identifiersNoYesNo
Debug testsNoYesYes
Display test coverageYesYesYes
InstallInstallInstall
+ +

+1: Possible when enabled via Settings > Go > On Save, go vet and golint are available via plugins. Also runs tests on save if configured. +
+2: Additionally, user input can disambiguate when two or more options are available. +

+ + + + + + \ No newline at end of file diff --git a/doc/editors/gogland.png b/doc/editors/gogland.png new file mode 100644 index 0000000000..842f089e4a Binary files /dev/null and b/doc/editors/gogland.png differ diff --git a/doc/editors/vimgo.png b/doc/editors/vimgo.png new file mode 100644 index 0000000000..cf317eff32 Binary files /dev/null and b/doc/editors/vimgo.png differ diff --git a/doc/editors/vscodego.png b/doc/editors/vscodego.png new file mode 100644 index 0000000000..4e6c7b8047 Binary files /dev/null and b/doc/editors/vscodego.png differ -- cgit v1.2.3-54-g00ecf