Go 语言开发

{
    "go.addTags": {
        "tags": "json",
        "options": "json=omitempty",
        "promptForTags": false,
        "transform": "snakecase",
        "template": ""
    }
}

{
    "name": "Launch Package",
    "type": "go",
    "request": "launch",
    "mode": "auto",
    "program": "${workspaceFolder}"
}

VSCode DAP Client ---(dap协议)---> dlv-dap server ------> debugee

VSCode DAP Client ---(dap协议)---> Golang 扩展 JS 实现的 Legacy DAP Server ---(dlv私有协议)---> dlv server ------> debugee

{
    "go.delveConfig": {
        "debugAdapter": "dlv-dap", // 默认为 dlv-dap, 可选值为 dlv-dap, legacy
        // 仅列出两种模式均可用的配置项
        "dlvFlags": [], // dlv help，参见上文调试配置
        "hideSystemGoroutines": false, // 默认为 false，参见上文调试配置
        "logOutput": "debugger", // 默认为 debugger，参见上文调试配置
        "showGlobalVariables": false, // 默认为 false，参见上文调试配置
        "showLog": false, // 默认为 false，参见上文调试配置
        "showRegisters": false, // 默认为 false，参见上文调试配置
        "substitutePath": [], // 参见上文调试配置
    }
}
// 仅 legacy 模式可用配置
{
    "go.delveConfig": {
        "debugAdapter": "legacy",
        "apiVersion": 2, // 可选值为 1, 2 (默认为 2)
        "dlvLoadConfig": {
            "followPointers": true,
            "maxVariableRecurse": 1,
            "maxStringLen": 64,
            "maxArrayValues": 64,
            "maxStructFields": -1
        }
    }
}

# 使用 -gcflags='all=-N -l' 编译出可执行文件
dlv debug /path/to/program --headless --listen=:12345

{
    "name": "Connect to external session",
    "type": "go",
    "debugAdapter": "dlv-dap",
    "request": "attach",
    "mode": "remote",
    "port": 12345, // 远端端口
    "host": "xxx.xxx.xxx.xxx", // 远端 ip 或者 host
    "substitutePath": [
      { "from": "${workspaceFolder}", "to": "/path/to/remote/workspace" },
    //   ...
  ]
}

cd /path/to/remote/workspace # 目的是让 dlv-dap 可以自动编译程序
dlv-dap dap --listen=:12345

{
    "name": "Connect and launch",
    "type": "go",
    "debugAdapter": "dlv-dap",
    "request": "launch",
    "port": 12345, // 远端端口
    "host": "xxx.xxx.xxx.xxx", // 远端 ip 或者 host
    "mode": "exec", // 这种模式需要手动前往 使用 -gcflags='all=-N -l' 编译出可执行文件
                    // 还支持 debug、test 模式，此时远端的 dlv-dap 将会先编译程序在启动调试
    "program": "/absolute/path/to/remote/workspace/program/executable",
    "substitutePath": [
        { "from": "${workspaceFolder}", "to": "/path/to/remote/workspace" },
    ]
}

{
    "go.buildOnSave": "package", // 保存时自动构建的范围
    "go.buildFlags": [], // 如 ["-ldflags='-s'"] 在 build-on-save 或者运行测试时编译参数。如果 `gopls.build.buildFlags` 没指定，则使用该参数
    "go.buildTags": [], // 支持 -tags '' （条件编译） ，运行测试时，如果 go.testTags 没指定，则使用该参数。如果 `gopls.build.buildFlags` 没指定，则使用该参数
    "go.testTags": null, // 参见 go.buildTags
    "go.disableConcurrentTests": false, // 使用禁用并发测试，如果该配置为 true，则新的测试运行时，旧的测试将被取消
    "go.installDependenciesWhenBuilding": false, // go build 时传递 -i 参数，非 go mod 模式可能才需要配置
    "go.lintOnSave": "package", // 保存时自动 lint 的范围
    "go.lintTool": "staticcheck", // lint 工具
    "go.lintFlags": [], // lint 工具 flag，如 ["-min_confidence=.8"]
    "go.vetOnSave": "package", // 保存时自动 vet 的范围
    "go.vetFlags": [],  // go tool vet 参数，如 ["-all", "-shadow"]
    "go.gopath": null, // 指定 GOPATH，go.inferGopath 为 true 推导出的 GOPATH 优先级高于该配置（如果该配置在 .vscode/settings.json 中配置，仅当 "Go: Toggle Workspace Trust Flag" 为信任时才生效）
    "go.toolsGopath": null, // 扩展依赖的命令行工具编译安装时使用的 GOPATH，如果没有指定，则使用系统 GOPATH（如果该配置在 .vscode/settings.json 中配置，仅当 "Go: Toggle Workspace Trust Flag" 为信任时才生效）
    "go.goroot": null, // 指定 GOROOT（如果该配置在 .vscode/settings.json 中配置，仅当 "Go: Toggle Workspace Trust Flag" 为信任时才生效）
    "go.testOnSave": false, //	是否在保存时对当前包运行 'go test'
    "go.coverOnSave": false, // 是否在保存时对当前包运行 'go test -coverprofile'
    "go.coverOnTestPackage": true, // 在执行 Go: Test Package 是否计算覆盖度
    "go.coverOnSingleTest": false, // 在执行 Go: Test Function at cursor 时是否计算覆盖度
    "go.coverOnSingleTestFile": false, // 在执行 Go: Test Single File 时是否计算覆盖度
    "go.coverMode":	"default", // 覆盖度模式
    "go.coverShowCounts": false , // 运行覆盖度时，是否在编辑器中显示函数和条件的命中次数如 --374--
    "go.coverageOptions": "showBothCoveredAndUncoveredCode", // 覆盖度结果在编辑器中的显示样式
    "go.coverageDecorator": { // 覆盖度结果显示的样式
        "type": "highlight",
        "coveredHighlightColor": "rgba(64,128,128,0.5)",
        "uncoveredHighlightColor": "rgba(128,64,64,0.25)",
        "coveredBorderColor": "rgba(64,128,128,0.5)",
        "uncoveredBorderColor": "rgba(128,64,64,0.25)",
        "coveredGutterStyle": "blockblue",
        "uncoveredGutterStyle": "slashyellow"
    },
    "go.testTimeout": "30s", // 测试超时时间
    "go.testEnvVars": {}, // 测试运行时的环境变量
    "go.testEnvFile": "", // 测试时环境变量的绝对路径
    "go.testFlags": "", // 构建测试时的 flag，参见 go.buildFlags
    "go.testExplorer.enable": true, // 是否启用测试浏览器
    "go.testExplorer.packageDisplayMode": "flat", // Present packages in the test explorer flat or nested.	flat
    "go.testExplorer.alwaysRunBenchmarks": false, // 运行所有测试时，是否也运行基准测试
    "go.testExplorer.concatenateMessages": true, // Concatenate all test log messages for a given location into a single message
    "go.testExplorer.showDynamicSubtestsInEditor": false,	// 动态发现的子测试是否显示到测试浏览器中
    "go.testExplorer.showOutput": true, // 开始测试运行时打开测试输出终端 
    "go.generateTestsFlags": null, // 生成测试的命令行参数，去 https://github.com/cweill/gotests 查看
    "go.toolsEnvVars": {}, // 运行命令行工具时的环境变量
    "go.useLanguageServer": true, // 启用 gopls
    "go.languageServerFlags": [], // gopls 命令行参数 Flags like -rpc.trace and -logfile to be used while running the language server.	
    "go.languageServerExperimentalFeatures": { "diagnostics": true }, // 临时标志去 enable/disable gopls 的 diagnostics 能力.很快要废弃了. 请看 Issue 50: https://github.com/golang/vscode-go/issues/50
    "go.trace.server": "off", // 跟踪 VS Code 和 Go 语言服务器之间的通信。
    "go.logging.level": "error", // 扩展日志登记
    "go.toolsManagement.checkForUpdates": "proxy", // 指定是否提示新版本的 Go 以及扩展依赖的 Go 工具（目前只有 gopls） 
    "go.toolsManagement.autoUpdate": false, // 自动更新扩展依赖的命令行工具，不提示用户 
    "go.useGoProxyToCheckForToolUpdates": true, // 启用后，扩展程序会自动检查 Go 代理是否有可用于 Go 和它所依赖的 Go 工具（目前只有 gopls）的更新，并相应地提示用户
    "go.enableCodeLens": {
        "references": false, // 函数上的引用次数
        "runtest": true // 测试上面的运行/debug
    }, // 配置 CodeLen
    "go.addTags": {
        "tags": "json",
        "options": "json=omitempty",
        "promptForTags": false,
        "transform": "snakecase",
        "template": ""
    }, // 添加标签命令将使用此处配置的标签和选项将标签添加到结构字段。如果 promptForTags 为 true，则将提示用户输入标签和选项。默认添加json标签。 
    "go.removeTags": {
        "tags": "",
        "options": "",
        "promptForTags": false
    }, // 此处配置的标签和选项将被移除标签命令用于移除结构字段的标签。 如果 promptForTags 为 true，则将提示用户输入标签和选项。 默认情况下，所有标签和选项都将被删除。
    "go.playground": {
        "openbrowser": true,
        "share": true,
        "run": true
    }, // 此处配置的标志将传递给命令 `goplay`
    "go.survey.prompt": true, // 是否展示问卷调查
    "go.editorContextMenuCommands": {
        "toggleTestFile": true,
        "addTags": true,
        "removeTags": false,
        "fillStruct": false,
        "testAtCursor": true,
        "testFile": false,
        "testPackage": false,
        "generateTestForFunction": true,
        "generateTestForFile": false,
        "generateTestForPackage": false,
        "addImport": true,
        "testCoverage": true,
        "playground": true,
        "debugTestAtCursor": true,
        "benchmarkAtCursor": false
    }, // 实验性功能：从编辑器的上下文菜单中启用/禁用条目。
    "go.delveConfig": {}, // dlv 配置
    "go.alternateTools": {}, // 为每一个 go 扩展依赖的外部工具提供绝对路径，比如想包装一下你的工具，如 "gopls": "/path/to/gopls"
    "gopls": { // 配置 gopls，默认值为 {}，详见：https://github.com/golang/tools/blob/master/gopls/doc/settings.md
        // 构建
        "build.buildFlags": [], // 构建标志
        "build.env": {}, // 环境变量
        "build.directoryFilters": ["-node_modules"], // 目录过滤器，配置方法参见： https://github.com/golang/tools/blob/master/gopls/doc/settings.md#directoryfilters-string
        "build.templateExtensions": ["tmpl","gotmpl"], // go template 扩展名
        "build.memoryMode": "Normal", // <实验性> DegradeClosed ，在 DegradeClosed 模式下，gopls 将收集关于没有打开文件的包的较少信息。因此，诸如 Find References 和 Rename 之类的功能将错过此类包中的结果。
        "build.expandWorkspaceToModule": true, //  <实验性> expandWorkspaceToModule 指示 gopls 调整工作区的范围以找到最佳的可用模块根。 gopls 首先在工作区文件夹的任何父目录中查找 go.mod 文件，如果存在，则将范围扩展到该目录。如果找不到可行的父目录，gopls 将检查是否只有一个包含 go.mod 文件的子目录，如果存在，则将范围缩小到该目录。
        "build.experimentalWorkspaceModule": false, // <实验性>  选择用户加入对多模块工作区的实验支持。
        "build.experimentalPackageCacheKey": false, // <实验性> 控制是否对包类型信息使用更粗略的缓存键以增加缓存命中。此设置从缓存键中删除用户的环境、构建标志和工作目录，这应该是一个安全的更改，因为类型检查传递的所有相关输入都已散列到键中。这是由实验暂时保护的，因为缓存行为是微妙的，难以全面测试。
        "build.allowModfileModifications": false, // <实验性> 禁用 -mod=readonly，允许从范围外模块导入。此选项最终将被删除。
        "build.allowImplicitNetworkAccess": false, // <实验性> 禁用 GOPROXY=off，允许隐式模块下载而不需要用户操作。此选项最终将被删除。
        "build.experimentalUseInvalidMetadata": false, // <实验性> 如果 go 命令由于某种原因（例如无效的 go.mod 文件）无法加载包，则 ExperimentUseInvalidMetadata 使 gopls 能够回退到过时的包元数据以提供编辑器功能。这最终将成为默认行为，并且此设置将被删除。

        // 格式化
        "formatting.local": "", // local 相当于 goimports -local 标志，它将以该字符串开头的导入放在第三方包之后。它应该是导入应该单独分组的导入路径的前缀。
        "formatting.gofumpt": false, // gofumpt 指示我们是否应该运行 gofumpt 格式化。gofumpt 是比 go fmt 更严格的规范，https://github.com/mvdan/gofumpt

        // UI
        "ui.codelenses": { // 参见 https://github.com/golang/tools/blob/master/gopls/doc/settings.md#code-lenses
            "gc_details": false,
            "generate": true,
            "regenerate_cgo": true,
            "tidy": true,
            "upgrade_dependency": true,
            "vendor": true
        },
        "ui.semanticTokens": false, // 是否 gopls 把语义化令牌发到 UI 上，开启后，有更好的高亮效果
        "ui.completion.usePlaceholders": false, // 函数调用的自动完成是否填充参数列表
        "ui.completion.completionBudget": "100ms", // 此设置仅用于调试目的。完成请求的耗时预算。大多数请求在几毫秒内完成，但在某些情况下，深度完成可能需要更长的时间。当我们用完预算时，我们会动态缩小搜索范围，以确保及时返回结果。零意味着无限。
        "ui.completion.matcher": "Fuzzy", // 匹配算法，可以是 Fuzzy、CaseSensitive、CaseInsensitive
        "ui.completion.experimentalPostfixCompletions": true, // <实验性> 启用后缀补全，例如 "someSlice.sort!"
        "ui.diagnostic.analyses": {
            // 再次记录没有默认开启的分析器
            "fieldalignment": true, // 结构体排序检查，那种排列内存占用更小，但是没有提供自动修复的功能，不建议开启
            "nilness": true, // 对于 nil 的一些检查
            "shadow": true, // 检查变量覆盖
            "unusedparams": true, // 未使用的参数
            "unusedwrite": true, // 未使用的写入
        }, // 分析器配置，参见 https://github.com/golang/tools/blob/master/gopls/doc/analyzers.md
        "ui.diagnostic.staticcheck": false, // 启用 staticcheck 分析器，让 lint 在 gopls 中执行
        "ui.diagnostic.annotations": {"bounds":true,"escape":true,"inline":true,"nil":true}, // 注释指定应由 gc_details 命令报告的各种优化诊断。
        "ui.diagnostic.diagnosticsDelay": "250ms", // 参见 https://github.com/golang/tools/blob/master/gopls/doc/settings.md#diagnosticsdelay-timeduration
        "ui.diagnostic.experimentalWatchedFileDelay": "0s", // <实验性> 参见 https://github.com/golang/tools/blob/master/gopls/doc/settings.md#experimentalwatchedfiledelay-timeduration
        "ui.documentation.hoverKind": "FullDocumentation",  // hover 种类
        "ui.documentation.linkTarget": "pkg.go.dev", // link 目标
        "ui.documentation.linksInHover": true, // 在 hover 中显示链接
        "ui.navigation.importShortcut": "Both", // 导入块执行调转到定义的方式，可以是 Both、Definition、Link
        "ui.navigation.symbolMatcher": "Fuzzy", // 设置查找工作区符号时使用的算法，可以是 Fuzzy、FastFuzzy、CaseSensitive、CaseInsensitive
        "ui.navigation.symbolStyle": "Dynamic", // 控制符号唯一表示非风格，可以是 Dynamic、Full、Package
        "verboseOutput": false, // 输出 gopls 的详细信息
    },
}
// 非 gopls 模式才生效的配置
{
    "go.formatTool": "default", //  格式化工具
    "go.formatFlags": [], // Flags to pass to format tool (e.g. ["-s"])
    "go.inferGopath": false, // 从工作空间推断 gopath，优先级高于 go.gopath（如果该配置在 .vscode/settings.json 中配置，仅当 "Go: Toggle Workspace Trust Flag" 为信任时才生效）
    "go.gocodeFlags": null, //	gocode 命令行参数 如-builtin,-ignore-case,-unimported-packages
    "go.gocodeAutoBuild": false, //	Enable gocode's autobuild feature
    "go.gocodePackageLookupMode": "go", // Used to determine the Go package lookup rules for completions by gocode. Latest versions of the Go extension uses mdempsky/gocode by default.
    "go.useCodeSnippetsOnFunctionSuggest": false, // Complete functions with their parameter signature, including the variable type.
    "go.useCodeSnippetsOnFunctionSuggestWithoutType": false, // 完成函数的建议列表时，填充函数参数（不包括类型） 如果是 gopls，使用 `gopls.usePlaceholders` 可进行配置。
    "go.autocompleteUnimportedPackages": false, // 在自动完成建议中包含未导入的包 
    "go.docsTool": "godoc", //	选择 'godoc' or 'gogetdoc' 获取文档
    "go.gotoSymbol.includeImports": false, // If false, the import statements will be excluded while using the Go to Symbol in File feature.
    "go.gotoSymbol.includeGoroot": false, // If false, the standard library located at $GOROOT will be excluded while using the Go to Symbol in File feature.
    "go.liveErrors": {
        "enabled": false,
        "delay": 500
    }, // Use gotype on the file currently being edited and report any semantic or syntactic errors found after configured delay.
    "go.gotoSymbol.ignoreFolders": [], // Folder names (not paths) to ignore while using Go to Symbol in Workspace feature.
}

{
    "go.disableConcurrentTests": true, // 禁用并发测试
    "go.testFlags": [
        "-v" // 测试打印标准输出
    ],
    "go.vetFlags": [
        "-all" // vet 执行所有规则
    ],
    "go.testTimeout": "30s", // 测试超时时间
    "go.testExplorer.showDynamicSubtestsInEditor": true, // 动态发现的子测试是否显示到测试浏览器中
    "go.toolsManagement.autoUpdate": true, // 自动更新扩展依赖的命令行工具，不提示用户 
    "go.enableCodeLens": { // 显示的 lens
        "references": true,
        "runtest": true
    },
    "go.addTags": { // 配置 add Tags 命令
        "tags": "json,yaml",
        "options": "json=omitempty",
        "promptForTags": true, // 询问添加的 tag
        "transform": "snakecase",
        "template": ""
    },
    "go.removeTags": { // 配置 remove Tags 命令
        "tags": "",
        "options": "",
        "promptForTags": true // 询问删除的 tag
    },
    // "go.delveConfig": { // dlv 配置，如果特殊场景需要看比较长的字符串时，可以打开该注释，启用该配置
    //     "debugAdapter": "legacy",
    //     "dlvLoadConfig": {
    //         "followPointers": true,
    //         "maxVariableRecurse": 1,
    //         "maxStringLen": 1000000,
    //         "maxArrayValues": 64,
    //         "maxStructFields": -1
    //     }
    // },
    "gopls": {
        "build.experimentalWorkspaceModule": true, // <实验性> 工作空间多模块支持（MonoRepo）
        "build.directoryFilters": ["-node_modules", "-output"], // 构建排除的目录，合理配置可以节省资源
        "formatting.gofumpt": true, // 使用 gofumpt 格式化代码
        "ui.semanticTokens": true,  // 是否 gopls 把语义化令牌发到 UI 上，开启后，有更好的高亮效果
        "ui.completion.usePlaceholders": true,  // 函数调用的自动完成是否填充参数列表
        "ui.diagnostic.analyses": { // 开启默认没有开启的且误报较少的分析器，参见 https://github.com/golang/tools/blob/master/gopls/doc/analyzers.md
            "nilness": true,
            "shadow": true,
            "unusedparams": true,
            "unusedwrite": true,
        },
    },
}

{
    "gopls": {
        "build.directoryFilters": ["-node_modules", "-output"], // 将工作空间不是 Go 代码的目录排除出去，配置方法参见： https://github.com/golang/tools/blob/master/gopls/doc/settings.md#directoryfilters-string
        "build.experimentalPackageCacheKey": true, // <实验性> 控制是否对包类型信息使用更粗略的缓存键以增加缓存命中。此设置从缓存键中删除用户的环境、构建标志和工作目录，这应该是一个安全的更改，因为类型检查传递的所有相关输入都已散列到键中。这是由实验暂时保护的，因为缓存行为是微妙的，难以全面测试。

        // 下方配置功能有损
        "build.memoryMode": "DegradeClosed", // <实验性> DegradeClosed ，在 DegradeClosed 模式下，gopls 将收集关于没有打开文件的包的较少信息。因此，诸如 Find References 和 Rename 之类的功能将错过此类包中的结果。
    }
}

{
    "name": "Launch with symlinks",
    "type": "go",
    "request": "launch",
    "mode": "debug",
    "program": "/path/to/actual/helloWorld",
    "substitutePath": [
		{
			"from": "/link/to/helloWorld",
			"to": "/path/to/actual/helloWorld",
		},
	],
}

{
    "go.delveConfig": {
        "debugAdapter": "legacy",
        "dlvLoadConfig": {
            "followPointers": true,
            "maxVariableRecurse": 1,
            "maxStringLen": 1000000,
            "maxArrayValues": 64,
            "maxStructFields": -1
        }
    }
}

// .vscode/launch.json
{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Launch external builded binary",
            "type": "go",
            "request": "launch",
            "mode": "exec",
            "preLaunchTask": "make debug",
            "program": "${workspaceRoot}/path/to/debug-binary",
        }
    ]
}
// .vscode/tasks.json
{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "make debug",
            "type": "shell",
            "command": "make debug"
        }
    ]
}

package main

import (
	"fmt"
	"time"
)

func main() {
	a := 1
	fmt.Println(a)

	// ctrl + \
	time.Sleep(1 * time.Hour)

	b := 2

	fmt.Println(b)
}

go build -gcflags='all=-N -l' -o main ./

GOTRACEBACK=crash ./main

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Launch core dump",
            "type": "go",
            "request": "launch",
            "mode": "core",
            "coreFilePath": "上一步获取到 core dump 文件路径",
            "program": "${workspaceFolder}/main"
        }
    ]
}

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Server",
      // ...
    },
    {
      "name": "Client",
      // ...
    }
  ],
  "compounds": [
    {
      "name": "Server/Client",
      "configurations": ["Server", "Client"],
      "preLaunchTask": "${defaultBuildTask}"
    }
  ]
}

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Launch: server",
            "type": "go",
            "request": "attach",
            "host": "127.0.0.1",
            "port": 2345,
            "debugAdapter":"legacy",
        }
    ]
}

{
    "gopls": {
        "experimentalWorkspaceModule": true
    }
}

{
    "gopls": {
        "build.env": {
            "GOOS": "linux",
            "GOARCH": "amd64"
        },
    },
}