Documentation ¶
Overview ¶
Package source provides core features for use by Go editors and tools.
Index ¶
- Constants
- Variables
- func AddImport(ctx context.Context, snapshot Snapshot, fh VersionedFileHandle, ...) ([]protocol.TextEdit, error)
- func Analyze(ctx context.Context, snapshot Snapshot, pkg Package, includeConvenience bool) (map[span.URI][]*Diagnostic, error)
- func ApplyFix(ctx context.Context, fix string, snapshot Snapshot, fh VersionedFileHandle, ...) ([]protocol.TextDocumentEdit, error)
- func BuildLink(target, path, anchor string) string
- func CanExtractFunction(fset *token.FileSet, rng span.Range, src []byte, file *ast.File) (*fnExtractParams, bool, bool, error)
- func CanExtractVariable(rng span.Range, file *ast.File) (ast.Expr, []ast.Node, bool, error)
- func CollectScopes(info *types.Info, path []ast.Node, pos token.Pos) []*types.Scope
- func CommentToMarkdown(text string) string
- func CompareDiagnostic(a, b *Diagnostic) int
- func CompareURI(left, right span.URI) int
- func ComputeOneImportFixEdits(snapshot Snapshot, pgf *ParsedGoFile, fix *imports.ImportFix) ([]protocol.TextEdit, error)
- func Deref(typ types.Type) types.Type
- func DocumentSymbols(ctx context.Context, snapshot Snapshot, fh FileHandle) ([]protocol.DocumentSymbol, error)
- func FileDiagnostics(ctx context.Context, snapshot Snapshot, uri span.URI) (VersionedFileIdentity, []*Diagnostic, error)
- func FiltersDisallow(path string, filters []string) bool
- func Format(ctx context.Context, snapshot Snapshot, fh FileHandle) ([]protocol.TextEdit, error)
- func FormatHover(h *HoverInformation, options *Options) (string, error)
- func FormatNode(fset *token.FileSet, n ast.Node) string
- func FormatType(typ types.Type, qf types.Qualifier) (detail string, kind protocol.CompletionItemKind)
- func FormatVarType(ctx context.Context, snapshot Snapshot, srcpkg Package, obj *types.Var, ...) string
- func FromProtocolEdits(m *protocol.ColumnMapper, edits []protocol.TextEdit) ([]diff.TextEdit, error)
- func GCOptimizationDetails(ctx context.Context, snapshot Snapshot, pkg Package) (map[VersionedFileIdentity][]*Diagnostic, error)
- func GetParsedFile(ctx context.Context, snapshot Snapshot, fh FileHandle, pkgPolicy PackageFilter) (Package, *ParsedGoFile, error)
- func Highlight(ctx context.Context, snapshot Snapshot, fh FileHandle, pos protocol.Position) ([]protocol.Range, error)
- func Hover(ctx context.Context, snapshot Snapshot, fh FileHandle, ...) (*protocol.Hover, error)
- func Implementation(ctx context.Context, snapshot Snapshot, f FileHandle, pp protocol.Position) ([]protocol.Location, error)
- func ImportPath(s *ast.ImportSpec) string
- func InDir(dir, path string) bool
- func InRange(tok *token.File, pos token.Pos) bool
- func IncomingCalls(ctx context.Context, snapshot Snapshot, fh FileHandle, pos protocol.Position) ([]protocol.CallHierarchyIncomingCall, error)
- func IsCommandLineArguments(s string) bool
- func IsGenerated(ctx context.Context, snapshot Snapshot, uri span.URI) bool
- func IsInterface(T types.Type) bool
- func IsNonFatalGoModError(err error) bool
- func IsValidImport(pkgPath, importPkgPath string) bool
- func IsWorkspaceModuleVersion(version string) bool
- func KnownPackages(ctx context.Context, snapshot Snapshot, fh VersionedFileHandle) ([]string, error)
- func LensFuncs() map[command.Command]LensFunc
- func NewBuiltinSignature(ctx context.Context, s Snapshot, name string) (*signature, error)
- func NewSignature(ctx context.Context, s Snapshot, pkg Package, sig *types.Signature, ...) *signature
- func NodeContains(n ast.Node, pos token.Pos) bool
- func Offset(tok *token.File, pos token.Pos) (int, error)
- func OutgoingCalls(ctx context.Context, snapshot Snapshot, fh FileHandle, pos protocol.Position) ([]protocol.CallHierarchyOutgoingCall, error)
- func PrepareCallHierarchy(ctx context.Context, snapshot Snapshot, fh FileHandle, pos protocol.Position) ([]protocol.CallHierarchyItem, error)
- func ProtocolEditsFromSource(src []byte, edits []diff.TextEdit, converter span.Converter) ([]protocol.TextEdit, error)
- func Qualifier(f *ast.File, pkg *types.Package, info *types.Info) types.Qualifier
- func Rename(ctx context.Context, s Snapshot, f FileHandle, pp protocol.Position, ...) (map[span.URI][]protocol.TextEdit, error)
- func SignatureHelp(ctx context.Context, snapshot Snapshot, fh FileHandle, pos protocol.Position) (*protocol.SignatureInformation, int, error)
- func SortDiagnostics(d []*Diagnostic)
- func TestsAndBenchmarks(ctx context.Context, snapshot Snapshot, fh FileHandle) (testFns, error)
- func ToProtocolEdits(m *protocol.ColumnMapper, edits []diff.TextEdit) ([]protocol.TextEdit, error)
- func WorkspaceModuleVersion(majorVersion string) string
- func WorkspaceSymbols(ctx context.Context, matcherType SymbolMatcher, style SymbolStyle, ...) ([]protocol.SymbolInformation, error)
- type APIJSON
- type Analyzer
- type AnalyzerJSON
- type Annotation
- type BuildOptions
- type ClientOptions
- type CommandJSON
- type CompletionOptions
- type CriticalError
- type Declaration
- type Diagnostic
- type DiagnosticOptions
- type DiagnosticSource
- type DocumentationOptions
- type EnumKey
- type EnumKeys
- type EnumValue
- type FileAction
- type FileHandle
- type FileIdentity
- type FileKind
- type FileModification
- type FileSource
- type FoldingRangeInfo
- type FormattingOptions
- type Hooks
- type HoverInformation
- type HoverKind
- type IdentifierInfo
- type ImportFix
- type ImportShortcut
- type InternalOptions
- type InvocationFlags
- type LensFunc
- type LensJSON
- type LinkTarget
- type MappedRange
- type Matcher
- type MemoryMode
- type Metadata
- type NavigationOptions
- type OptionJSON
- type OptionResult
- type OptionResults
- type OptionState
- type Options
- type Overlay
- type Package
- type PackageFilter
- type ParseMode
- type ParsedGoFile
- type ParsedModule
- type PrepareItem
- type ReferenceInfo
- type RelatedInformation
- type ServerOptions
- type Session
- type Snapshot
- type SuggestedFix
- type SuggestedFixFunc
- type Symbol
- type SymbolMatcher
- type SymbolStyle
- type TidiedModule
- type TypecheckMode
- type UIOptions
- type UserOptions
- type VersionedFileHandle
- type VersionedFileIdentity
- type View
Constants ¶
const ( FillStruct = "fill_struct" UndeclaredName = "undeclared_name" ExtractVariable = "extract_variable" ExtractFunction = "extract_function" ExtractMethod = "extract_method" )
const ( OptionHandled = OptionState(iota) OptionDeprecated OptionUnexpected )
const ( UnknownFileAction = FileAction(iota) Open Change Close Save Create Delete InvalidateMetadata )
const ( // UnknownKind is a file type we don't know about. UnknownKind = FileKind(iota) // Go is a normal go source file. Go // Mod is a go.mod file. Mod // Sum is a go.sum file. Sum // Tmpl is a template file. Tmpl )
Variables ¶
var ErrNoIdentFound = errors.New("no identifier found")
ErrNoIdentFound is error returned when no identifer is found at a particular position
var ErrNoModOnDisk = errors.New("go.mod file is not on disk")
var ErrNoRuneFound = errors.New("no rune found")
ErrNoRuneFound is the error returned when no rune is found at a particular position.
var ErrNotAType = errors.New("not a type name or method")
var ErrTmpModfileUnsupported = errors.New("-modfile is unsupported for this Go version")
var ErrViewExists = errors.New("view already exists for session")
var GeneratedAPIJSON = &APIJSON{ Options: map[string][]*OptionJSON{ "User": { { Name: "buildFlags", Type: "[]string", Doc: "buildFlags is the set of flags passed on to the build system when invoked.\nIt is applied to queries like `go list`, which is used when discovering files.\nThe most common use is to set `-tags`.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "[]", Status: "", Hierarchy: "build", }, { Name: "env", Type: "map[string]string", Doc: "env adds environment variables to external commands run by `gopls`, most notably `go list`.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "{}", Status: "", Hierarchy: "build", }, { Name: "directoryFilters", Type: "[]string", Doc: "directoryFilters can be used to exclude unwanted directories from the\nworkspace. By default, all directories are included. Filters are an\noperator, `+` to include and `-` to exclude, followed by a path prefix\nrelative to the workspace folder. They are evaluated in order, and\nthe last filter that applies to a path controls whether it is included.\nThe path prefix can be empty, so an initial `-` excludes everything.\n\nExamples:\n\nExclude node_modules: `-node_modules`\n\nInclude only project_a: `-` (exclude everything), `+project_a`\n\nInclude only project_a, but not node_modules inside it: `-`, `+project_a`, `-project_a/node_modules`\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "[\"-node_modules\"]", Status: "", Hierarchy: "build", }, { Name: "templateSupport", Type: "bool", Doc: "templateSupport can be used to turn off support for template files.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "true", Status: "", Hierarchy: "build", }, { Name: "templateExtensions", Type: "[]string", Doc: "templateExtensions gives the extensions of file names that are treateed\nas template files. (The extension\nis the part of the file name after the final dot.)\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "[\"tmpl\",\"gotmpl\"]", Status: "", Hierarchy: "build", }, { Name: "memoryMode", Type: "enum", Doc: "memoryMode controls the tradeoff `gopls` makes between memory usage and\ncorrectness.\n\nValues other than `Normal` are untested and may break in surprising ways.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: []EnumValue{ { Value: "\"DegradeClosed\"", Doc: "`\"DegradeClosed\"`: In DegradeClosed mode, `gopls` will collect less information about\npackages without open files. As a result, features like Find\nReferences and Rename will miss results in such packages.\n", }, { Value: "\"Normal\"", Doc: "", }, }, Default: "\"Normal\"", Status: "experimental", Hierarchy: "build", }, { Name: "expandWorkspaceToModule", Type: "bool", Doc: "expandWorkspaceToModule instructs `gopls` to adjust the scope of the\nworkspace to find the best available module root. `gopls` first looks for\na go.mod file in any parent directory of the workspace folder, expanding\nthe scope to that directory if it exists. If no viable parent directory is\nfound, gopls will check if there is exactly one child directory containing\na go.mod file, narrowing the scope to that directory if it exists.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "true", Status: "experimental", Hierarchy: "build", }, { Name: "experimentalWorkspaceModule", Type: "bool", Doc: "experimentalWorkspaceModule opts a user into the experimental support\nfor multi-module workspaces.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "false", Status: "experimental", Hierarchy: "build", }, { Name: "experimentalPackageCacheKey", Type: "bool", Doc: "experimentalPackageCacheKey controls whether to use a coarser cache key\nfor package type information to increase cache hits. This setting removes\nthe user's environment, build flags, and working directory from the cache\nkey, which should be a safe change as all relevant inputs into the type\nchecking pass are already hashed into the key. This is temporarily guarded\nby an experiment because caching behavior is subtle and difficult to\ncomprehensively test.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "true", Status: "experimental", Hierarchy: "build", }, { Name: "allowModfileModifications", Type: "bool", Doc: "allowModfileModifications disables -mod=readonly, allowing imports from\nout-of-scope modules. This option will eventually be removed.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "false", Status: "experimental", Hierarchy: "build", }, { Name: "allowImplicitNetworkAccess", Type: "bool", Doc: "allowImplicitNetworkAccess disables GOPROXY=off, allowing implicit module\ndownloads rather than requiring user action. This option will eventually\nbe removed.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "false", Status: "experimental", Hierarchy: "build", }, { Name: "experimentalUseInvalidMetadata", Type: "bool", Doc: "experimentalUseInvalidMetadata enables gopls to fall back on outdated\npackage metadata to provide editor features if the go command fails to\nload packages for some reason (like an invalid go.mod file). This will\neventually be the default behavior, and this setting will be removed.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "false", Status: "experimental", Hierarchy: "build", }, { Name: "hoverKind", Type: "enum", Doc: "hoverKind controls the information that appears in the hover text.\nSingleLine and Structured are intended for use only by authors of editor plugins.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: []EnumValue{ { Value: "\"FullDocumentation\"", Doc: "", }, { Value: "\"NoDocumentation\"", Doc: "", }, { Value: "\"SingleLine\"", Doc: "", }, { Value: "\"Structured\"", Doc: "`\"Structured\"` is an experimental setting that returns a structured hover format.\nThis format separates the signature from the documentation, so that the client\ncan do more manipulation of these fields.\n\nThis should only be used by clients that support this behavior.\n", }, { Value: "\"SynopsisDocumentation\"", Doc: "", }, }, Default: "\"FullDocumentation\"", Status: "", Hierarchy: "ui.documentation", }, { Name: "linkTarget", Type: "string", Doc: "linkTarget controls where documentation links go.\nIt might be one of:\n\n* `\"godoc.org\"`\n* `\"pkg.go.dev\"`\n\nIf company chooses to use its own `godoc.org`, its address can be used as well.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "\"pkg.go.dev\"", Status: "", Hierarchy: "ui.documentation", }, { Name: "linksInHover", Type: "bool", Doc: "linksInHover toggles the presence of links to documentation in hover.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "true", Status: "", Hierarchy: "ui.documentation", }, { Name: "usePlaceholders", Type: "bool", Doc: "placeholders enables placeholders for function parameters or struct\nfields in completion responses.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "false", Status: "", Hierarchy: "ui.completion", }, { Name: "completionBudget", Type: "time.Duration", Doc: "completionBudget is the soft latency goal for completion requests. Most\nrequests finish in a couple milliseconds, but in some cases deep\ncompletions can take much longer. As we use up our budget we\ndynamically reduce the search scope to ensure we return timely\nresults. Zero means unlimited.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "\"100ms\"", Status: "debug", Hierarchy: "ui.completion", }, { Name: "matcher", Type: "enum", Doc: "matcher sets the algorithm that is used when calculating completion\ncandidates.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: []EnumValue{ { Value: "\"CaseInsensitive\"", Doc: "", }, { Value: "\"CaseSensitive\"", Doc: "", }, { Value: "\"Fuzzy\"", Doc: "", }, }, Default: "\"Fuzzy\"", Status: "advanced", Hierarchy: "ui.completion", }, { Name: "experimentalPostfixCompletions", Type: "bool", Doc: "experimentalPostfixCompletions enables artifical method snippets\nsuch as \"someSlice.sort!\".\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "true", Status: "experimental", Hierarchy: "ui.completion", }, { Name: "importShortcut", Type: "enum", Doc: "importShortcut specifies whether import statements should link to\ndocumentation or go to definitions.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: []EnumValue{ { Value: "\"Both\"", Doc: "", }, { Value: "\"Definition\"", Doc: "", }, { Value: "\"Link\"", Doc: "", }, }, Default: "\"Both\"", Status: "", Hierarchy: "ui.navigation", }, { Name: "symbolMatcher", Type: "enum", Doc: "symbolMatcher sets the algorithm that is used when finding workspace symbols.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: []EnumValue{ { Value: "\"CaseInsensitive\"", Doc: "", }, { Value: "\"CaseSensitive\"", Doc: "", }, { Value: "\"FastFuzzy\"", Doc: "", }, { Value: "\"Fuzzy\"", Doc: "", }, }, Default: "\"Fuzzy\"", Status: "advanced", Hierarchy: "ui.navigation", }, { Name: "symbolStyle", Type: "enum", Doc: "symbolStyle controls how symbols are qualified in symbol responses.\n\nExample Usage:\n\n```json5\n\"gopls\": {\n...\n \"symbolStyle\": \"Dynamic\",\n...\n}\n```\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: []EnumValue{ { Value: "\"Dynamic\"", Doc: "`\"Dynamic\"` uses whichever qualifier results in the highest scoring\nmatch for the given symbol query. Here a \"qualifier\" is any \"/\" or \".\"\ndelimited suffix of the fully qualified symbol. i.e. \"to/pkg.Foo.Field\" or\njust \"Foo.Field\".\n", }, { Value: "\"Full\"", Doc: "`\"Full\"` is fully qualified symbols, i.e.\n\"path/to/pkg.Foo.Field\".\n", }, { Value: "\"Package\"", Doc: "`\"Package\"` is package qualified symbols i.e.\n\"pkg.Foo.Field\".\n", }, }, Default: "\"Dynamic\"", Status: "advanced", Hierarchy: "ui.navigation", }, { Name: "analyses", Type: "map[string]bool", Doc: "analyses specify analyses that the user would like to enable or disable.\nA map of the names of analysis passes that should be enabled/disabled.\nA full list of analyzers that gopls uses can be found\n[here](https://github.com/golang/tools/blob/master/gopls/doc/analyzers.md).\n\nExample Usage:\n\n```json5\n...\n\"analyses\": {\n \"unreachable\": false, // Disable the unreachable analyzer.\n \"unusedparams\": true // Enable the unusedparams analyzer.\n}\n...\n```\n", EnumKeys: EnumKeys{ ValueType: "bool", Keys: []EnumKey{ { Name: "\"asmdecl\"", Doc: "report mismatches between assembly files and Go declarations", Default: "true", }, { Name: "\"assign\"", Doc: "check for useless assignments\n\nThis checker reports assignments of the form x = x or a[i] = a[i].\nThese are almost always useless, and even when they aren't they are\nusually a mistake.", Default: "true", }, { Name: "\"atomic\"", Doc: "check for common mistakes using the sync/atomic package\n\nThe atomic checker looks for assignment statements of the form:\n\n\tx = atomic.AddUint64(&x, 1)\n\nwhich are not atomic.", Default: "true", }, { Name: "\"atomicalign\"", Doc: "check for non-64-bits-aligned arguments to sync/atomic functions", Default: "true", }, { Name: "\"bools\"", Doc: "check for common mistakes involving boolean operators", Default: "true", }, { Name: "\"buildtag\"", Doc: "check that +build tags are well-formed and correctly located", Default: "true", }, { Name: "\"cgocall\"", Doc: "detect some violations of the cgo pointer passing rules\n\nCheck for invalid cgo pointer passing.\nThis looks for code that uses cgo to call C code passing values\nwhose types are almost always invalid according to the cgo pointer\nsharing rules.\nSpecifically, it warns about attempts to pass a Go chan, map, func,\nor slice to C, either directly, or via a pointer, array, or struct.", Default: "true", }, { Name: "\"composites\"", Doc: "check for unkeyed composite literals\n\nThis analyzer reports a diagnostic for composite literals of struct\ntypes imported from another package that do not use the field-keyed\nsyntax. Such literals are fragile because the addition of a new field\n(even if unexported) to the struct will cause compilation to fail.\n\nAs an example,\n\n\terr = &net.DNSConfigError{err}\n\nshould be replaced by:\n\n\terr = &net.DNSConfigError{Err: err}\n", Default: "true", }, { Name: "\"copylocks\"", Doc: "check for locks erroneously passed by value\n\nInadvertently copying a value containing a lock, such as sync.Mutex or\nsync.WaitGroup, may cause both copies to malfunction. Generally such\nvalues should be referred to through a pointer.", Default: "true", }, { Name: "\"deepequalerrors\"", Doc: "check for calls of reflect.DeepEqual on error values\n\nThe deepequalerrors checker looks for calls of the form:\n\n reflect.DeepEqual(err1, err2)\n\nwhere err1 and err2 are errors. Using reflect.DeepEqual to compare\nerrors is discouraged.", Default: "true", }, { Name: "\"errorsas\"", Doc: "report passing non-pointer or non-error values to errors.As\n\nThe errorsas analysis reports calls to errors.As where the type\nof the second argument is not a pointer to a type implementing error.", Default: "true", }, { Name: "\"fieldalignment\"", Doc: "find structs that would use less memory if their fields were sorted\n\nThis analyzer find structs that can be rearranged to use less memory, and provides\na suggested edit with the optimal order.\n\nNote that there are two different diagnostics reported. One checks struct size,\nand the other reports \"pointer bytes\" used. Pointer bytes is how many bytes of the\nobject that the garbage collector has to potentially scan for pointers, for example:\n\n\tstruct { uint32; string }\n\nhave 16 pointer bytes because the garbage collector has to scan up through the string's\ninner pointer.\n\n\tstruct { string; *uint32 }\n\nhas 24 pointer bytes because it has to scan further through the *uint32.\n\n\tstruct { string; uint32 }\n\nhas 8 because it can stop immediately after the string pointer.\n", Default: "false", }, { Name: "\"httpresponse\"", Doc: "check for mistakes using HTTP responses\n\nA common mistake when using the net/http package is to defer a function\ncall to close the http.Response Body before checking the error that\ndetermines whether the response is valid:\n\n\tresp, err := http.Head(url)\n\tdefer resp.Body.Close()\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\t// (defer statement belongs here)\n\nThis checker helps uncover latent nil dereference bugs by reporting a\ndiagnostic for such mistakes.", Default: "true", }, { Name: "\"ifaceassert\"", Doc: "detect impossible interface-to-interface type assertions\n\nThis checker flags type assertions v.(T) and corresponding type-switch cases\nin which the static type V of v is an interface that cannot possibly implement\nthe target interface T. This occurs when V and T contain methods with the same\nname but different signatures. Example:\n\n\tvar v interface {\n\t\tRead()\n\t}\n\t_ = v.(io.Reader)\n\nThe Read method in v has a different signature than the Read method in\nio.Reader, so this assertion cannot succeed.\n", Default: "true", }, { Name: "\"infertypeargs\"", Doc: "check for unnecessary type arguments in call expressions\n\nExplicit type arguments may be omitted from call expressions if they can be\ninferred from function arguments, or from other type arguments:\n\nfunc f[T any](T) {}\n\nfunc _() {\n\tf[string](\"foo\") // string could be inferred\n}\n", Default: "true", }, { Name: "\"loopclosure\"", Doc: "check references to loop variables from within nested functions\n\nThis analyzer checks for references to loop variables from within a\nfunction literal inside the loop body. It checks only instances where\nthe function literal is called in a defer or go statement that is the\nlast statement in the loop body, as otherwise we would need whole\nprogram analysis.\n\nFor example:\n\n\tfor i, v := range s {\n\t\tgo func() {\n\t\t\tprintln(i, v) // not what you might expect\n\t\t}()\n\t}\n\nSee: https://golang.org/doc/go_faq.html#closures_and_goroutines", Default: "true", }, { Name: "\"lostcancel\"", Doc: "check cancel func returned by context.WithCancel is called\n\nThe cancellation function returned by context.WithCancel, WithTimeout,\nand WithDeadline must be called or the new context will remain live\nuntil its parent context is cancelled.\n(The background context is never cancelled.)", Default: "true", }, { Name: "\"nilfunc\"", Doc: "check for useless comparisons between functions and nil\n\nA useless comparison is one like f == nil as opposed to f() == nil.", Default: "true", }, { Name: "\"nilness\"", Doc: "check for redundant or impossible nil comparisons\n\nThe nilness checker inspects the control-flow graph of each function in\na package and reports nil pointer dereferences, degenerate nil\npointers, and panics with nil values. A degenerate comparison is of the form\nx==nil or x!=nil where x is statically known to be nil or non-nil. These are\noften a mistake, especially in control flow related to errors. Panics with nil\nvalues are checked because they are not detectable by\n\n\tif r := recover(); r != nil {\n\nThis check reports conditions such as:\n\n\tif f == nil { // impossible condition (f is a function)\n\t}\n\nand:\n\n\tp := &v\n\t...\n\tif p != nil { // tautological condition\n\t}\n\nand:\n\n\tif p == nil {\n\t\tprint(*p) // nil dereference\n\t}\n\nand:\n\n\tif p == nil {\n\t\tpanic(p)\n\t}\n", Default: "false", }, { Name: "\"printf\"", Doc: "check consistency of Printf format strings and arguments\n\nThe check applies to known functions (for example, those in package fmt)\nas well as any detected wrappers of known functions.\n\nA function that wants to avail itself of printf checking but is not\nfound by this analyzer's heuristics (for example, due to use of\ndynamic calls) can insert a bogus call:\n\n\tif false {\n\t\t_ = fmt.Sprintf(format, args...) // enable printf checking\n\t}\n\nThe -funcs flag specifies a comma-separated list of names of additional\nknown formatting functions or methods. If the name contains a period,\nit must denote a specific function using one of the following forms:\n\n\tdir/pkg.Function\n\tdir/pkg.Type.Method\n\t(*dir/pkg.Type).Method\n\nOtherwise the name is interpreted as a case-insensitive unqualified\nidentifier such as \"errorf\". Either way, if a listed name ends in f, the\nfunction is assumed to be Printf-like, taking a format string before the\nargument list. Otherwise it is assumed to be Print-like, taking a list\nof arguments with no format string.\n", Default: "true", }, { Name: "\"shadow\"", Doc: "check for possible unintended shadowing of variables\n\nThis analyzer check for shadowed variables.\nA shadowed variable is a variable declared in an inner scope\nwith the same name and type as a variable in an outer scope,\nand where the outer variable is mentioned after the inner one\nis declared.\n\n(This definition can be refined; the module generates too many\nfalse positives and is not yet enabled by default.)\n\nFor example:\n\n\tfunc BadRead(f *os.File, buf []byte) error {\n\t\tvar err error\n\t\tfor {\n\t\t\tn, err := f.Read(buf) // shadows the function variable 'err'\n\t\t\tif err != nil {\n\t\t\t\tbreak // causes return of wrong value\n\t\t\t}\n\t\t\tfoo(buf)\n\t\t}\n\t\treturn err\n\t}\n", Default: "false", }, { Name: "\"shift\"", Doc: "check for shifts that equal or exceed the width of the integer", Default: "true", }, { Name: "\"simplifycompositelit\"", Doc: "check for composite literal simplifications\n\nAn array, slice, or map composite literal of the form:\n\t[]T{T{}, T{}}\nwill be simplified to:\n\t[]T{{}, {}}\n\nThis is one of the simplifications that \"gofmt -s\" applies.", Default: "true", }, { Name: "\"simplifyrange\"", Doc: "check for range statement simplifications\n\nA range of the form:\n\tfor x, _ = range v {...}\nwill be simplified to:\n\tfor x = range v {...}\n\nA range of the form:\n\tfor _ = range v {...}\nwill be simplified to:\n\tfor range v {...}\n\nThis is one of the simplifications that \"gofmt -s\" applies.", Default: "true", }, { Name: "\"simplifyslice\"", Doc: "check for slice simplifications\n\nA slice expression of the form:\n\ts[a:len(s)]\nwill be simplified to:\n\ts[a:]\n\nThis is one of the simplifications that \"gofmt -s\" applies.", Default: "true", }, { Name: "\"sortslice\"", Doc: "check the argument type of sort.Slice\n\nsort.Slice requires an argument of a slice type. Check that\nthe interface{} value passed to sort.Slice is actually a slice.", Default: "true", }, { Name: "\"stdmethods\"", Doc: "check signature of methods of well-known interfaces\n\nSometimes a type may be intended to satisfy an interface but may fail to\ndo so because of a mistake in its method signature.\nFor example, the result of this WriteTo method should be (int64, error),\nnot error, to satisfy io.WriterTo:\n\n\ttype myWriterTo struct{...}\n func (myWriterTo) WriteTo(w io.Writer) error { ... }\n\nThis check ensures that each method whose name matches one of several\nwell-known interface methods from the standard library has the correct\nsignature for that interface.\n\nChecked method names include:\n\tFormat GobEncode GobDecode MarshalJSON MarshalXML\n\tPeek ReadByte ReadFrom ReadRune Scan Seek\n\tUnmarshalJSON UnreadByte UnreadRune WriteByte\n\tWriteTo\n", Default: "true", }, { Name: "\"stringintconv\"", Doc: "check for string(int) conversions\n\nThis checker flags conversions of the form string(x) where x is an integer\n(but not byte or rune) type. Such conversions are discouraged because they\nreturn the UTF-8 representation of the Unicode code point x, and not a decimal\nstring representation of x as one might expect. Furthermore, if x denotes an\ninvalid code point, the conversion cannot be statically rejected.\n\nFor conversions that intend on using the code point, consider replacing them\nwith string(rune(x)). Otherwise, strconv.Itoa and its equivalents return the\nstring representation of the value in the desired base.\n", Default: "true", }, { Name: "\"structtag\"", Doc: "check that struct field tags conform to reflect.StructTag.Get\n\nAlso report certain struct tags (json, xml) used with unexported fields.", Default: "true", }, { Name: "\"testinggoroutine\"", Doc: "report calls to (*testing.T).Fatal from goroutines started by a test.\n\nFunctions that abruptly terminate a test, such as the Fatal, Fatalf, FailNow, and\nSkip{,f,Now} methods of *testing.T, must be called from the test goroutine itself.\nThis checker detects calls to these functions that occur within a goroutine\nstarted by the test. For example:\n\nfunc TestFoo(t *testing.T) {\n go func() {\n t.Fatal(\"oops\") // error: (*T).Fatal called from non-test goroutine\n }()\n}\n", Default: "true", }, { Name: "\"tests\"", Doc: "check for common mistaken usages of tests and examples\n\nThe tests checker walks Test, Benchmark and Example functions checking\nmalformed names, wrong signatures and examples documenting non-existent\nidentifiers.\n\nPlease see the documentation for package testing in golang.org/pkg/testing\nfor the conventions that are enforced for Tests, Benchmarks, and Examples.", Default: "true", }, { Name: "\"unmarshal\"", Doc: "report passing non-pointer or non-interface values to unmarshal\n\nThe unmarshal analysis reports calls to functions such as json.Unmarshal\nin which the argument type is not a pointer or an interface.", Default: "true", }, { Name: "\"unreachable\"", Doc: "check for unreachable code\n\nThe unreachable analyzer finds statements that execution can never reach\nbecause they are preceded by an return statement, a call to panic, an\ninfinite loop, or similar constructs.", Default: "true", }, { Name: "\"unsafeptr\"", Doc: "check for invalid conversions of uintptr to unsafe.Pointer\n\nThe unsafeptr analyzer reports likely incorrect uses of unsafe.Pointer\nto convert integers to pointers. A conversion from uintptr to\nunsafe.Pointer is invalid if it implies that there is a uintptr-typed\nword in memory that holds a pointer value, because that word will be\ninvisible to stack copying and to the garbage collector.", Default: "true", }, { Name: "\"unusedparams\"", Doc: "check for unused parameters of functions\n\nThe unusedparams analyzer checks functions to see if there are\nany parameters that are not being used.\n\nTo reduce false positives it ignores:\n- methods\n- parameters that do not have a name or are underscored\n- functions in test files\n- functions with empty bodies or those with just a return stmt", Default: "false", }, { Name: "\"unusedresult\"", Doc: "check for unused results of calls to some functions\n\nSome functions like fmt.Errorf return a result and have no side effects,\nso it is always a mistake to discard the result. This analyzer reports\ncalls to certain functions in which the result of the call is ignored.\n\nThe set of functions may be controlled using flags.", Default: "true", }, { Name: "\"unusedwrite\"", Doc: "checks for unused writes\n\nThe analyzer reports instances of writes to struct fields and\narrays that are never read. Specifically, when a struct object\nor an array is copied, its elements are copied implicitly by\nthe compiler, and any element write to this copy does nothing\nwith the original object.\n\nFor example:\n\n\ttype T struct { x int }\n\tfunc f(input []T) {\n\t\tfor i, v := range input { // v is a copy\n\t\t\tv.x = i // unused write to field x\n\t\t}\n\t}\n\nAnother example is about non-pointer receiver:\n\n\ttype T struct { x int }\n\tfunc (t T) f() { // t is a copy\n\t\tt.x = i // unused write to field x\n\t}\n", Default: "false", }, { Name: "\"useany\"", Doc: "check for constraints that could be simplified to \"any\"", Default: "true", }, { Name: "\"fillreturns\"", Doc: "suggested fixes for \"wrong number of return values (want %d, got %d)\"\n\nThis checker provides suggested fixes for type errors of the\ntype \"wrong number of return values (want %d, got %d)\". For example:\n\tfunc m() (int, string, *bool, error) {\n\t\treturn\n\t}\nwill turn into\n\tfunc m() (int, string, *bool, error) {\n\t\treturn 0, \"\", nil, nil\n\t}\n\nThis functionality is similar to https://github.com/sqs/goreturns.\n", Default: "true", }, { Name: "\"nonewvars\"", Doc: "suggested fixes for \"no new vars on left side of :=\"\n\nThis checker provides suggested fixes for type errors of the\ntype \"no new vars on left side of :=\". For example:\n\tz := 1\n\tz := 2\nwill turn into\n\tz := 1\n\tz = 2\n", Default: "true", }, { Name: "\"noresultvalues\"", Doc: "suggested fixes for \"no result values expected\"\n\nThis checker provides suggested fixes for type errors of the\ntype \"no result values expected\". For example:\n\tfunc z() { return nil }\nwill turn into\n\tfunc z() { return }\n", Default: "true", }, { Name: "\"undeclaredname\"", Doc: "suggested fixes for \"undeclared name: <>\"\n\nThis checker provides suggested fixes for type errors of the\ntype \"undeclared name: <>\". It will either insert a new statement,\nsuch as:\n\n\"<> := \"\n\nor a new function declaration, such as:\n\nfunc <>(inferred parameters) {\n\tpanic(\"implement me!\")\n}\n", Default: "true", }, { Name: "\"fillstruct\"", Doc: "note incomplete struct initializations\n\nThis analyzer provides diagnostics for any struct literals that do not have\nany fields initialized. Because the suggested fix for this analysis is\nexpensive to compute, callers should compute it separately, using the\nSuggestedFix function below.\n", Default: "true", }, }, }, EnumValues: nil, Default: "{}", Status: "", Hierarchy: "ui.diagnostic", }, { Name: "staticcheck", Type: "bool", Doc: "staticcheck enables additional analyses from staticcheck.io.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "false", Status: "experimental", Hierarchy: "ui.diagnostic", }, { Name: "annotations", Type: "map[string]bool", Doc: "annotations specifies the various kinds of optimization diagnostics\nthat should be reported by the gc_details command.\n", EnumKeys: EnumKeys{ ValueType: "bool", Keys: []EnumKey{ { Name: "\"bounds\"", Doc: "`\"bounds\"` controls bounds checking diagnostics.\n", Default: "true", }, { Name: "\"escape\"", Doc: "`\"escape\"` controls diagnostics about escape choices.\n", Default: "true", }, { Name: "\"inline\"", Doc: "`\"inline\"` controls diagnostics about inlining choices.\n", Default: "true", }, { Name: "\"nil\"", Doc: "`\"nil\"` controls nil checks.\n", Default: "true", }, }, }, EnumValues: nil, Default: "{\"bounds\":true,\"escape\":true,\"inline\":true,\"nil\":true}", Status: "experimental", Hierarchy: "ui.diagnostic", }, { Name: "diagnosticsDelay", Type: "time.Duration", Doc: "diagnosticsDelay controls the amount of time that gopls waits\nafter the most recent file modification before computing deep diagnostics.\nSimple diagnostics (parsing and type-checking) are always run immediately\non recently modified packages.\n\nThis option must be set to a valid duration string, for example `\"250ms\"`.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "\"250ms\"", Status: "advanced", Hierarchy: "ui.diagnostic", }, { Name: "experimentalWatchedFileDelay", Type: "time.Duration", Doc: "experimentalWatchedFileDelay controls the amount of time that gopls waits\nfor additional workspace/didChangeWatchedFiles notifications to arrive,\nbefore processing all such notifications in a single batch. This is\nintended for use by LSP clients that don't support their own batching of\nfile system notifications.\n\nThis option must be set to a valid duration string, for example `\"100ms\"`.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "\"0s\"", Status: "experimental", Hierarchy: "ui.diagnostic", }, { Name: "codelenses", Type: "map[string]bool", Doc: "codelenses overrides the enabled/disabled state of code lenses. See the\n\"Code Lenses\" section of the\n[Settings page](https://github.com/golang/tools/blob/master/gopls/doc/settings.md)\nfor the list of supported lenses.\n\nExample Usage:\n\n```json5\n\"gopls\": {\n...\n \"codelenses\": {\n \"generate\": false, // Don't show the `go generate` lens.\n \"gc_details\": true // Show a code lens toggling the display of gc's choices.\n }\n...\n}\n```\n", EnumKeys: EnumKeys{ ValueType: "bool", Keys: []EnumKey{ { Name: "\"gc_details\"", Doc: "Toggle the calculation of gc annotations.", Default: "false", }, { Name: "\"generate\"", Doc: "Runs `go generate` for a given directory.", Default: "true", }, { Name: "\"regenerate_cgo\"", Doc: "Regenerates cgo definitions.", Default: "true", }, { Name: "\"test\"", Doc: "Runs `go test` for a specific set of test or benchmark functions.", Default: "false", }, { Name: "\"tidy\"", Doc: "Runs `go mod tidy` for a module.", Default: "true", }, { Name: "\"upgrade_dependency\"", Doc: "Upgrades a dependency in the go.mod file for a module.", Default: "true", }, { Name: "\"vendor\"", Doc: "Runs `go mod vendor` for a module.", Default: "true", }, }, }, EnumValues: nil, Default: "{\"gc_details\":false,\"generate\":true,\"regenerate_cgo\":true,\"tidy\":true,\"upgrade_dependency\":true,\"vendor\":true}", Status: "", Hierarchy: "ui", }, { Name: "semanticTokens", Type: "bool", Doc: "semanticTokens controls whether the LSP server will send\nsemantic tokens to the client.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "false", Status: "experimental", Hierarchy: "ui", }, { Name: "local", Type: "string", Doc: "local is the equivalent of the `goimports -local` flag, which puts\nimports beginning with this string after third-party packages. It should\nbe the prefix of the import path whose imports should be grouped\nseparately.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "\"\"", Status: "", Hierarchy: "formatting", }, { Name: "gofumpt", Type: "bool", Doc: "gofumpt indicates if we should run gofumpt formatting.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "false", Status: "", Hierarchy: "formatting", }, { Name: "verboseOutput", Type: "bool", Doc: "verboseOutput enables additional debug logging.\n", EnumKeys: EnumKeys{ ValueType: "", Keys: nil, }, EnumValues: nil, Default: "false", Status: "debug", Hierarchy: "", }, }, }, Commands: []*CommandJSON{ { Command: "gopls.add_dependency", Title: "Add a dependency", Doc: "Adds a dependency to the go.mod file for a module.", ArgDoc: "{\n\t// The go.mod file URI.\n\t\"URI\": string,\n\t// Additional args to pass to the go command.\n\t\"GoCmdArgs\": []string,\n\t// Whether to add a require directive.\n\t\"AddRequire\": bool,\n}", ResultDoc: "", }, { Command: "gopls.add_import", Title: "Add an import", Doc: "Ask the server to add an import path to a given Go file. The method will\ncall applyEdit on the client so that clients don't have to apply the edit\nthemselves.", ArgDoc: "{\n\t// ImportPath is the target import path that should\n\t// be added to the URI file\n\t\"ImportPath\": string,\n\t// URI is the file that the ImportPath should be\n\t// added to\n\t\"URI\": string,\n}", ResultDoc: "", }, { Command: "gopls.apply_fix", Title: "Apply a fix", Doc: "Applies a fix to a region of source code.", ArgDoc: "{\n\t// The fix to apply.\n\t\"Fix\": string,\n\t// The file URI for the document to fix.\n\t\"URI\": string,\n\t// The document range to scan for fixes.\n\t\"Range\": {\n\t\t\"start\": {\n\t\t\t\"line\": uint32,\n\t\t\t\"character\": uint32,\n\t\t},\n\t\t\"end\": {\n\t\t\t\"line\": uint32,\n\t\t\t\"character\": uint32,\n\t\t},\n\t},\n}", ResultDoc: "", }, { Command: "gopls.check_upgrades", Title: "Check for upgrades", Doc: "Checks for module upgrades.", ArgDoc: "{\n\t// The go.mod file URI.\n\t\"URI\": string,\n\t// The modules to check.\n\t\"Modules\": []string,\n}", ResultDoc: "", }, { Command: "gopls.gc_details", Title: "Toggle gc_details", Doc: "Toggle the calculation of gc annotations.", ArgDoc: "string", ResultDoc: "", }, { Command: "gopls.generate", Title: "Run go generate", Doc: "Runs `go generate` for a given directory.", ArgDoc: "{\n\t// URI for the directory to generate.\n\t\"Dir\": string,\n\t// Whether to generate recursively (go generate ./...)\n\t\"Recursive\": bool,\n}", ResultDoc: "", }, { Command: "gopls.generate_gopls_mod", Title: "Generate gopls.mod", Doc: "(Re)generate the gopls.mod file for a workspace.", ArgDoc: "{\n\t// The file URI.\n\t\"URI\": string,\n}", ResultDoc: "", }, { Command: "gopls.go_get_package", Title: "go get a package", Doc: "Runs `go get` to fetch a package.", ArgDoc: "{\n\t// Any document URI within the relevant module.\n\t\"URI\": string,\n\t// The package to go get.\n\t\"Pkg\": string,\n\t\"AddRequire\": bool,\n}", ResultDoc: "", }, { Command: "gopls.list_known_packages", Title: "List known packages", Doc: "Retrieve a list of packages that are importable from the given URI.", ArgDoc: "{\n\t// The file URI.\n\t\"URI\": string,\n}", ResultDoc: "{\n\t// Packages is a list of packages relative\n\t// to the URIArg passed by the command request.\n\t// In other words, it omits paths that are already\n\t// imported or cannot be imported due to compiler\n\t// restrictions.\n\t\"Packages\": []string,\n}", }, { Command: "gopls.regenerate_cgo", Title: "Regenerate cgo", Doc: "Regenerates cgo definitions.", ArgDoc: "{\n\t// The file URI.\n\t\"URI\": string,\n}", ResultDoc: "", }, { Command: "gopls.remove_dependency", Title: "Remove a dependency", Doc: "Removes a dependency from the go.mod file of a module.", ArgDoc: "{\n\t// The go.mod file URI.\n\t\"URI\": string,\n\t// The module path to remove.\n\t\"ModulePath\": string,\n\t\"OnlyDiagnostic\": bool,\n}", ResultDoc: "", }, { Command: "gopls.run_tests", Title: "Run test(s)", Doc: "Runs `go test` for a specific set of test or benchmark functions.", ArgDoc: "{\n\t// The test file containing the tests to run.\n\t\"URI\": string,\n\t// Specific test names to run, e.g. TestFoo.\n\t\"Tests\": []string,\n\t// Specific benchmarks to run, e.g. BenchmarkFoo.\n\t\"Benchmarks\": []string,\n}", ResultDoc: "", }, { Command: "gopls.start_debugging", Title: "Start the gopls debug server", Doc: "Start the gopls debug server if it isn't running, and return the debug\naddress.", ArgDoc: "{\n\t// Optional: the address (including port) for the debug server to listen on.\n\t// If not provided, the debug server will bind to \"localhost:0\", and the\n\t// full debug URL will be contained in the result.\n\t// \n\t// If there is more than one gopls instance along the serving path (i.e. you\n\t// are using a daemon), each gopls instance will attempt to start debugging.\n\t// If Addr specifies a port, only the daemon will be able to bind to that\n\t// port, and each intermediate gopls instance will fail to start debugging.\n\t// For this reason it is recommended not to specify a port (or equivalently,\n\t// to specify \":0\").\n\t// \n\t// If the server was already debugging this field has no effect, and the\n\t// result will contain the previously configured debug URL(s).\n\t\"Addr\": string,\n}", ResultDoc: "{\n\t// The URLs to use to access the debug servers, for all gopls instances in\n\t// the serving path. For the common case of a single gopls instance (i.e. no\n\t// daemon), this will be exactly one address.\n\t// \n\t// In the case of one or more gopls instances forwarding the LSP to a daemon,\n\t// URLs will contain debug addresses for each server in the serving path, in\n\t// serving order. The daemon debug address will be the last entry in the\n\t// slice. If any intermediate gopls instance fails to start debugging, no\n\t// error will be returned but the debug URL for that server in the URLs slice\n\t// will be empty.\n\t\"URLs\": []string,\n}", }, { Command: "gopls.test", Title: "Run test(s) (legacy)", Doc: "Runs `go test` for a specific set of test or benchmark functions.", ArgDoc: "string,\n[]string,\n[]string", ResultDoc: "", }, { Command: "gopls.tidy", Title: "Run go mod tidy", Doc: "Runs `go mod tidy` for a module.", ArgDoc: "{\n\t// The file URIs.\n\t\"URIs\": []string,\n}", ResultDoc: "", }, { Command: "gopls.toggle_gc_details", Title: "Toggle gc_details", Doc: "Toggle the calculation of gc annotations.", ArgDoc: "{\n\t// The file URI.\n\t\"URI\": string,\n}", ResultDoc: "", }, { Command: "gopls.update_go_sum", Title: "Update go.sum", Doc: "Updates the go.sum file for a module.", ArgDoc: "{\n\t// The file URIs.\n\t\"URIs\": []string,\n}", ResultDoc: "", }, { Command: "gopls.upgrade_dependency", Title: "Upgrade a dependency", Doc: "Upgrades a dependency in the go.mod file for a module.", ArgDoc: "{\n\t// The go.mod file URI.\n\t\"URI\": string,\n\t// Additional args to pass to the go command.\n\t\"GoCmdArgs\": []string,\n\t// Whether to add a require directive.\n\t\"AddRequire\": bool,\n}", ResultDoc: "", }, { Command: "gopls.vendor", Title: "Run go mod vendor", Doc: "Runs `go mod vendor` for a module.", ArgDoc: "{\n\t// The file URI.\n\t\"URI\": string,\n}", ResultDoc: "", }, { Command: "gopls.workspace_metadata", Title: "Query workspace metadata", Doc: "Query the server for information about active workspaces.", ArgDoc: "", ResultDoc: "{\n\t// All workspaces for this session.\n\t\"Workspaces\": []{\n\t\t\"Name\": string,\n\t\t\"ModuleDir\": string,\n\t},\n}", }, }, Lenses: []*LensJSON{ { Lens: "gc_details", Title: "Toggle gc_details", Doc: "Toggle the calculation of gc annotations.", }, { Lens: "generate", Title: "Run go generate", Doc: "Runs `go generate` for a given directory.", }, { Lens: "regenerate_cgo", Title: "Regenerate cgo", Doc: "Regenerates cgo definitions.", }, { Lens: "test", Title: "Run test(s) (legacy)", Doc: "Runs `go test` for a specific set of test or benchmark functions.", }, { Lens: "tidy", Title: "Run go mod tidy", Doc: "Runs `go mod tidy` for a module.", }, { Lens: "upgrade_dependency", Title: "Upgrade a dependency", Doc: "Upgrades a dependency in the go.mod file for a module.", }, { Lens: "vendor", Title: "Run go mod vendor", Doc: "Runs `go mod vendor` for a module.", }, }, Analyzers: []*AnalyzerJSON{ { Name: "asmdecl", Doc: "report mismatches between assembly files and Go declarations", Default: true, }, { Name: "assign", Doc: "check for useless assignments\n\nThis checker reports assignments of the form x = x or a[i] = a[i].\nThese are almost always useless, and even when they aren't they are\nusually a mistake.", Default: true, }, { Name: "atomic", Doc: "check for common mistakes using the sync/atomic package\n\nThe atomic checker looks for assignment statements of the form:\n\n\tx = atomic.AddUint64(&x, 1)\n\nwhich are not atomic.", Default: true, }, { Name: "atomicalign", Doc: "check for non-64-bits-aligned arguments to sync/atomic functions", Default: true, }, { Name: "bools", Doc: "check for common mistakes involving boolean operators", Default: true, }, { Name: "buildtag", Doc: "check that +build tags are well-formed and correctly located", Default: true, }, { Name: "cgocall", Doc: "detect some violations of the cgo pointer passing rules\n\nCheck for invalid cgo pointer passing.\nThis looks for code that uses cgo to call C code passing values\nwhose types are almost always invalid according to the cgo pointer\nsharing rules.\nSpecifically, it warns about attempts to pass a Go chan, map, func,\nor slice to C, either directly, or via a pointer, array, or struct.", Default: true, }, { Name: "composites", Doc: "check for unkeyed composite literals\n\nThis analyzer reports a diagnostic for composite literals of struct\ntypes imported from another package that do not use the field-keyed\nsyntax. Such literals are fragile because the addition of a new field\n(even if unexported) to the struct will cause compilation to fail.\n\nAs an example,\n\n\terr = &net.DNSConfigError{err}\n\nshould be replaced by:\n\n\terr = &net.DNSConfigError{Err: err}\n", Default: true, }, { Name: "copylocks", Doc: "check for locks erroneously passed by value\n\nInadvertently copying a value containing a lock, such as sync.Mutex or\nsync.WaitGroup, may cause both copies to malfunction. Generally such\nvalues should be referred to through a pointer.", Default: true, }, { Name: "deepequalerrors", Doc: "check for calls of reflect.DeepEqual on error values\n\nThe deepequalerrors checker looks for calls of the form:\n\n reflect.DeepEqual(err1, err2)\n\nwhere err1 and err2 are errors. Using reflect.DeepEqual to compare\nerrors is discouraged.", Default: true, }, { Name: "errorsas", Doc: "report passing non-pointer or non-error values to errors.As\n\nThe errorsas analysis reports calls to errors.As where the type\nof the second argument is not a pointer to a type implementing error.", Default: true, }, { Name: "fieldalignment", Doc: "find structs that would use less memory if their fields were sorted\n\nThis analyzer find structs that can be rearranged to use less memory, and provides\na suggested edit with the optimal order.\n\nNote that there are two different diagnostics reported. One checks struct size,\nand the other reports \"pointer bytes\" used. Pointer bytes is how many bytes of the\nobject that the garbage collector has to potentially scan for pointers, for example:\n\n\tstruct { uint32; string }\n\nhave 16 pointer bytes because the garbage collector has to scan up through the string's\ninner pointer.\n\n\tstruct { string; *uint32 }\n\nhas 24 pointer bytes because it has to scan further through the *uint32.\n\n\tstruct { string; uint32 }\n\nhas 8 because it can stop immediately after the string pointer.\n", Default: false, }, { Name: "httpresponse", Doc: "check for mistakes using HTTP responses\n\nA common mistake when using the net/http package is to defer a function\ncall to close the http.Response Body before checking the error that\ndetermines whether the response is valid:\n\n\tresp, err := http.Head(url)\n\tdefer resp.Body.Close()\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\t// (defer statement belongs here)\n\nThis checker helps uncover latent nil dereference bugs by reporting a\ndiagnostic for such mistakes.", Default: true, }, { Name: "ifaceassert", Doc: "detect impossible interface-to-interface type assertions\n\nThis checker flags type assertions v.(T) and corresponding type-switch cases\nin which the static type V of v is an interface that cannot possibly implement\nthe target interface T. This occurs when V and T contain methods with the same\nname but different signatures. Example:\n\n\tvar v interface {\n\t\tRead()\n\t}\n\t_ = v.(io.Reader)\n\nThe Read method in v has a different signature than the Read method in\nio.Reader, so this assertion cannot succeed.\n", Default: true, }, { Name: "infertypeargs", Doc: "check for unnecessary type arguments in call expressions\n\nExplicit type arguments may be omitted from call expressions if they can be\ninferred from function arguments, or from other type arguments:\n\nfunc f[T any](T) {}\n\nfunc _() {\n\tf[string](\"foo\") // string could be inferred\n}\n", Default: true, }, { Name: "loopclosure", Doc: "check references to loop variables from within nested functions\n\nThis analyzer checks for references to loop variables from within a\nfunction literal inside the loop body. It checks only instances where\nthe function literal is called in a defer or go statement that is the\nlast statement in the loop body, as otherwise we would need whole\nprogram analysis.\n\nFor example:\n\n\tfor i, v := range s {\n\t\tgo func() {\n\t\t\tprintln(i, v) // not what you might expect\n\t\t}()\n\t}\n\nSee: https://golang.org/doc/go_faq.html#closures_and_goroutines", Default: true, }, { Name: "lostcancel", Doc: "check cancel func returned by context.WithCancel is called\n\nThe cancellation function returned by context.WithCancel, WithTimeout,\nand WithDeadline must be called or the new context will remain live\nuntil its parent context is cancelled.\n(The background context is never cancelled.)", Default: true, }, { Name: "nilfunc", Doc: "check for useless comparisons between functions and nil\n\nA useless comparison is one like f == nil as opposed to f() == nil.", Default: true, }, { Name: "nilness", Doc: "check for redundant or impossible nil comparisons\n\nThe nilness checker inspects the control-flow graph of each function in\na package and reports nil pointer dereferences, degenerate nil\npointers, and panics with nil values. A degenerate comparison is of the form\nx==nil or x!=nil where x is statically known to be nil or non-nil. These are\noften a mistake, especially in control flow related to errors. Panics with nil\nvalues are checked because they are not detectable by\n\n\tif r := recover(); r != nil {\n\nThis check reports conditions such as:\n\n\tif f == nil { // impossible condition (f is a function)\n\t}\n\nand:\n\n\tp := &v\n\t...\n\tif p != nil { // tautological condition\n\t}\n\nand:\n\n\tif p == nil {\n\t\tprint(*p) // nil dereference\n\t}\n\nand:\n\n\tif p == nil {\n\t\tpanic(p)\n\t}\n", Default: false, }, { Name: "printf", Doc: "check consistency of Printf format strings and arguments\n\nThe check applies to known functions (for example, those in package fmt)\nas well as any detected wrappers of known functions.\n\nA function that wants to avail itself of printf checking but is not\nfound by this analyzer's heuristics (for example, due to use of\ndynamic calls) can insert a bogus call:\n\n\tif false {\n\t\t_ = fmt.Sprintf(format, args...) // enable printf checking\n\t}\n\nThe -funcs flag specifies a comma-separated list of names of additional\nknown formatting functions or methods. If the name contains a period,\nit must denote a specific function using one of the following forms:\n\n\tdir/pkg.Function\n\tdir/pkg.Type.Method\n\t(*dir/pkg.Type).Method\n\nOtherwise the name is interpreted as a case-insensitive unqualified\nidentifier such as \"errorf\". Either way, if a listed name ends in f, the\nfunction is assumed to be Printf-like, taking a format string before the\nargument list. Otherwise it is assumed to be Print-like, taking a list\nof arguments with no format string.\n", Default: true, }, { Name: "shadow", Doc: "check for possible unintended shadowing of variables\n\nThis analyzer check for shadowed variables.\nA shadowed variable is a variable declared in an inner scope\nwith the same name and type as a variable in an outer scope,\nand where the outer variable is mentioned after the inner one\nis declared.\n\n(This definition can be refined; the module generates too many\nfalse positives and is not yet enabled by default.)\n\nFor example:\n\n\tfunc BadRead(f *os.File, buf []byte) error {\n\t\tvar err error\n\t\tfor {\n\t\t\tn, err := f.Read(buf) // shadows the function variable 'err'\n\t\t\tif err != nil {\n\t\t\t\tbreak // causes return of wrong value\n\t\t\t}\n\t\t\tfoo(buf)\n\t\t}\n\t\treturn err\n\t}\n", Default: false, }, { Name: "shift", Doc: "check for shifts that equal or exceed the width of the integer", Default: true, }, { Name: "simplifycompositelit", Doc: "check for composite literal simplifications\n\nAn array, slice, or map composite literal of the form:\n\t[]T{T{}, T{}}\nwill be simplified to:\n\t[]T{{}, {}}\n\nThis is one of the simplifications that \"gofmt -s\" applies.", Default: true, }, { Name: "simplifyrange", Doc: "check for range statement simplifications\n\nA range of the form:\n\tfor x, _ = range v {...}\nwill be simplified to:\n\tfor x = range v {...}\n\nA range of the form:\n\tfor _ = range v {...}\nwill be simplified to:\n\tfor range v {...}\n\nThis is one of the simplifications that \"gofmt -s\" applies.", Default: true, }, { Name: "simplifyslice", Doc: "check for slice simplifications\n\nA slice expression of the form:\n\ts[a:len(s)]\nwill be simplified to:\n\ts[a:]\n\nThis is one of the simplifications that \"gofmt -s\" applies.", Default: true, }, { Name: "sortslice", Doc: "check the argument type of sort.Slice\n\nsort.Slice requires an argument of a slice type. Check that\nthe interface{} value passed to sort.Slice is actually a slice.", Default: true, }, { Name: "stdmethods", Doc: "check signature of methods of well-known interfaces\n\nSometimes a type may be intended to satisfy an interface but may fail to\ndo so because of a mistake in its method signature.\nFor example, the result of this WriteTo method should be (int64, error),\nnot error, to satisfy io.WriterTo:\n\n\ttype myWriterTo struct{...}\n func (myWriterTo) WriteTo(w io.Writer) error { ... }\n\nThis check ensures that each method whose name matches one of several\nwell-known interface methods from the standard library has the correct\nsignature for that interface.\n\nChecked method names include:\n\tFormat GobEncode GobDecode MarshalJSON MarshalXML\n\tPeek ReadByte ReadFrom ReadRune Scan Seek\n\tUnmarshalJSON UnreadByte UnreadRune WriteByte\n\tWriteTo\n", Default: true, }, { Name: "stringintconv", Doc: "check for string(int) conversions\n\nThis checker flags conversions of the form string(x) where x is an integer\n(but not byte or rune) type. Such conversions are discouraged because they\nreturn the UTF-8 representation of the Unicode code point x, and not a decimal\nstring representation of x as one might expect. Furthermore, if x denotes an\ninvalid code point, the conversion cannot be statically rejected.\n\nFor conversions that intend on using the code point, consider replacing them\nwith string(rune(x)). Otherwise, strconv.Itoa and its equivalents return the\nstring representation of the value in the desired base.\n", Default: true, }, { Name: "structtag", Doc: "check that struct field tags conform to reflect.StructTag.Get\n\nAlso report certain struct tags (json, xml) used with unexported fields.", Default: true, }, { Name: "testinggoroutine", Doc: "report calls to (*testing.T).Fatal from goroutines started by a test.\n\nFunctions that abruptly terminate a test, such as the Fatal, Fatalf, FailNow, and\nSkip{,f,Now} methods of *testing.T, must be called from the test goroutine itself.\nThis checker detects calls to these functions that occur within a goroutine\nstarted by the test. For example:\n\nfunc TestFoo(t *testing.T) {\n go func() {\n t.Fatal(\"oops\") // error: (*T).Fatal called from non-test goroutine\n }()\n}\n", Default: true, }, { Name: "tests", Doc: "check for common mistaken usages of tests and examples\n\nThe tests checker walks Test, Benchmark and Example functions checking\nmalformed names, wrong signatures and examples documenting non-existent\nidentifiers.\n\nPlease see the documentation for package testing in golang.org/pkg/testing\nfor the conventions that are enforced for Tests, Benchmarks, and Examples.", Default: true, }, { Name: "unmarshal", Doc: "report passing non-pointer or non-interface values to unmarshal\n\nThe unmarshal analysis reports calls to functions such as json.Unmarshal\nin which the argument type is not a pointer or an interface.", Default: true, }, { Name: "unreachable", Doc: "check for unreachable code\n\nThe unreachable analyzer finds statements that execution can never reach\nbecause they are preceded by an return statement, a call to panic, an\ninfinite loop, or similar constructs.", Default: true, }, { Name: "unsafeptr", Doc: "check for invalid conversions of uintptr to unsafe.Pointer\n\nThe unsafeptr analyzer reports likely incorrect uses of unsafe.Pointer\nto convert integers to pointers. A conversion from uintptr to\nunsafe.Pointer is invalid if it implies that there is a uintptr-typed\nword in memory that holds a pointer value, because that word will be\ninvisible to stack copying and to the garbage collector.", Default: true, }, { Name: "unusedparams", Doc: "check for unused parameters of functions\n\nThe unusedparams analyzer checks functions to see if there are\nany parameters that are not being used.\n\nTo reduce false positives it ignores:\n- methods\n- parameters that do not have a name or are underscored\n- functions in test files\n- functions with empty bodies or those with just a return stmt", Default: false, }, { Name: "unusedresult", Doc: "check for unused results of calls to some functions\n\nSome functions like fmt.Errorf return a result and have no side effects,\nso it is always a mistake to discard the result. This analyzer reports\ncalls to certain functions in which the result of the call is ignored.\n\nThe set of functions may be controlled using flags.", Default: true, }, { Name: "unusedwrite", Doc: "checks for unused writes\n\nThe analyzer reports instances of writes to struct fields and\narrays that are never read. Specifically, when a struct object\nor an array is copied, its elements are copied implicitly by\nthe compiler, and any element write to this copy does nothing\nwith the original object.\n\nFor example:\n\n\ttype T struct { x int }\n\tfunc f(input []T) {\n\t\tfor i, v := range input { // v is a copy\n\t\t\tv.x = i // unused write to field x\n\t\t}\n\t}\n\nAnother example is about non-pointer receiver:\n\n\ttype T struct { x int }\n\tfunc (t T) f() { // t is a copy\n\t\tt.x = i // unused write to field x\n\t}\n", Default: false, }, { Name: "useany", Doc: "check for constraints that could be simplified to \"any\"", Default: true, }, { Name: "fillreturns", Doc: "suggested fixes for \"wrong number of return values (want %d, got %d)\"\n\nThis checker provides suggested fixes for type errors of the\ntype \"wrong number of return values (want %d, got %d)\". For example:\n\tfunc m() (int, string, *bool, error) {\n\t\treturn\n\t}\nwill turn into\n\tfunc m() (int, string, *bool, error) {\n\t\treturn 0, \"\", nil, nil\n\t}\n\nThis functionality is similar to https://github.com/sqs/goreturns.\n", Default: true, }, { Name: "nonewvars", Doc: "suggested fixes for \"no new vars on left side of :=\"\n\nThis checker provides suggested fixes for type errors of the\ntype \"no new vars on left side of :=\". For example:\n\tz := 1\n\tz := 2\nwill turn into\n\tz := 1\n\tz = 2\n", Default: true, }, { Name: "noresultvalues", Doc: "suggested fixes for \"no result values expected\"\n\nThis checker provides suggested fixes for type errors of the\ntype \"no result values expected\". For example:\n\tfunc z() { return nil }\nwill turn into\n\tfunc z() { return }\n", Default: true, }, { Name: "undeclaredname", Doc: "suggested fixes for \"undeclared name: <>\"\n\nThis checker provides suggested fixes for type errors of the\ntype \"undeclared name: <>\". It will either insert a new statement,\nsuch as:\n\n\"<> := \"\n\nor a new function declaration, such as:\n\nfunc <>(inferred parameters) {\n\tpanic(\"implement me!\")\n}\n", Default: true, }, { Name: "fillstruct", Doc: "note incomplete struct initializations\n\nThis analyzer provides diagnostics for any struct literals that do not have\nany fields initialized. Because the suggested fix for this analysis is\nexpensive to compute, callers should compute it separately, using the\nSuggestedFix function below.\n", Default: true, }, }, }
var (
PackagesLoadError = errors.New("packages.Load error")
)
Functions ¶
func AddImport ¶
func AddImport(ctx context.Context, snapshot Snapshot, fh VersionedFileHandle, importPath string) ([]protocol.TextEdit, error)
AddImport adds a single import statement to the given file
func ApplyFix ¶
func ApplyFix(ctx context.Context, fix string, snapshot Snapshot, fh VersionedFileHandle, pRng protocol.Range) ([]protocol.TextDocumentEdit, error)
ApplyFix applies the command's suggested fix to the given file and range, returning the resulting edits.
func CanExtractFunction ¶
func CanExtractFunction(fset *token.FileSet, rng span.Range, src []byte, file *ast.File) (*fnExtractParams, bool, bool, error)
CanExtractFunction reports whether the code in the given range can be extracted to a function.
func CanExtractVariable ¶
CanExtractVariable reports whether the code in the given range can be extracted to a variable.
func CollectScopes ¶
CollectScopes returns all scopes in an ast path, ordered as innermost scope first.
func CommentToMarkdown ¶
CommentToMarkdown converts comment text to formatted markdown. The comment was prepared by DocReader, so it is known not to have leading, trailing blank lines nor to have trailing spaces at the end of lines. The comment markers have already been removed.
Each line is converted into a markdown line and empty lines are just converted to newlines. Heading are prefixed with `### ` to make it a markdown heading.
A span of indented lines retains a 4 space prefix block, with the common indent prefix removed unless empty, in which case it will be converted to a newline.
URLs in the comment text are converted into links.
func CompareDiagnostic ¶
func CompareDiagnostic(a, b *Diagnostic) int
func CompareURI ¶
func ComputeOneImportFixEdits ¶
func ComputeOneImportFixEdits(snapshot Snapshot, pgf *ParsedGoFile, fix *imports.ImportFix) ([]protocol.TextEdit, error)
ComputeOneImportFixEdits returns text edits for a single import fix.
func Deref ¶
Deref returns a pointer's element type, traversing as many levels as needed. Otherwise it returns typ.
It can return a pointer type for cyclic types (see golang/go#45510).
func DocumentSymbols ¶
func DocumentSymbols(ctx context.Context, snapshot Snapshot, fh FileHandle) ([]protocol.DocumentSymbol, error)
func FileDiagnostics ¶
func FileDiagnostics(ctx context.Context, snapshot Snapshot, uri span.URI) (VersionedFileIdentity, []*Diagnostic, error)
func FiltersDisallow ¶
FilterDisallow is code from the body of cache.pathExcludedByFilter in cache/view.go Exporting and using that function would cause an import cycle. Moving it here and exporting it would leave behind view_test.go. (This code is exported and used in the body of cache.pathExcludedByFilter)
func FormatHover ¶
func FormatHover(h *HoverInformation, options *Options) (string, error)
func FormatNode ¶
FormatNode returns the "pretty-print" output for an ast node.
func FormatType ¶
func FormatType(typ types.Type, qf types.Qualifier) (detail string, kind protocol.CompletionItemKind)
FormatType returns the detail and kind for a types.Type.
func FormatVarType ¶
func FormatVarType(ctx context.Context, snapshot Snapshot, srcpkg Package, obj *types.Var, qf types.Qualifier) string
FormatVarType formats a *types.Var, accounting for type aliases. To do this, it looks in the AST of the file in which the object is declared. On any errors, it always fallbacks back to types.TypeString.
func FromProtocolEdits ¶
func GCOptimizationDetails ¶
func GCOptimizationDetails(ctx context.Context, snapshot Snapshot, pkg Package) (map[VersionedFileIdentity][]*Diagnostic, error)
func GetParsedFile ¶
func GetParsedFile(ctx context.Context, snapshot Snapshot, fh FileHandle, pkgPolicy PackageFilter) (Package, *ParsedGoFile, error)
GetParsedFile is a convenience function that extracts the Package and ParsedGoFile for a file in a Snapshot. pkgPolicy is one of NarrowestPackage/ WidestPackage.
func Implementation ¶
func ImportPath ¶
func ImportPath(s *ast.ImportSpec) string
ImportPath returns the unquoted import path of s, or "" if the path is not properly quoted.
func InDir ¶
InDir checks whether path is in the file tree rooted at dir. InDir makes some effort to succeed even in the presence of symbolic links.
Copied and slightly adjusted from go/src/cmd/go/internal/search/search.go.
func IncomingCalls ¶
func IncomingCalls(ctx context.Context, snapshot Snapshot, fh FileHandle, pos protocol.Position) ([]protocol.CallHierarchyIncomingCall, error)
IncomingCalls returns an array of CallHierarchyIncomingCall for a file and the position within the file.
func IsCommandLineArguments ¶
IsCommandLineArguments reports whether a given value denotes "command-line-arguments" package, which is a package with an unknown ID created by the go command. It can have a test variant, which is why callers should not check that a value equals "command-line-arguments" directly.
func IsInterface ¶
IsInterface returns if a types.Type is an interface
func IsNonFatalGoModError ¶
func IsValidImport ¶
IsValidImport returns whether importPkgPath is importable by pkgPath
func KnownPackages ¶
func KnownPackages(ctx context.Context, snapshot Snapshot, fh VersionedFileHandle) ([]string, error)
KnownPackages returns a list of all known packages in the package graph that could potentially be imported by the given file.
func NewBuiltinSignature ¶
NewBuiltinSignature returns signature for the builtin object with a given name, if a builtin object with the name exists.
func NewSignature ¶
func NewSignature(ctx context.Context, s Snapshot, pkg Package, sig *types.Signature, comment *ast.CommentGroup, qf types.Qualifier) *signature
NewSignature returns formatted signature for a types.Signature struct.
func NodeContains ¶
NodeContains returns true if a node encloses a given position pos.
func Offset ¶
Offset returns tok.Offset(pos), but it also checks that the pos is in range for the given file.
func OutgoingCalls ¶
func OutgoingCalls(ctx context.Context, snapshot Snapshot, fh FileHandle, pos protocol.Position) ([]protocol.CallHierarchyOutgoingCall, error)
OutgoingCalls returns an array of CallHierarchyOutgoingCall for a file and the position within the file.
func PrepareCallHierarchy ¶
func PrepareCallHierarchy(ctx context.Context, snapshot Snapshot, fh FileHandle, pos protocol.Position) ([]protocol.CallHierarchyItem, error)
PrepareCallHierarchy returns an array of CallHierarchyItem for a file and the position within the file.
func ProtocolEditsFromSource ¶
func ProtocolEditsFromSource(src []byte, edits []diff.TextEdit, converter span.Converter) ([]protocol.TextEdit, error)
ProtocolEditsFromSource converts text edits to LSP edits using the original source.
func Qualifier ¶
Qualifier returns a function that appropriately formats a types.PkgName appearing in a *ast.File.
func Rename ¶
func Rename(ctx context.Context, s Snapshot, f FileHandle, pp protocol.Position, newName string) (map[span.URI][]protocol.TextEdit, error)
Rename returns a map of TextEdits for each file modified when renaming a given identifier within a package.
func SignatureHelp ¶
func SignatureHelp(ctx context.Context, snapshot Snapshot, fh FileHandle, pos protocol.Position) (*protocol.SignatureInformation, int, error)
func SortDiagnostics ¶
func SortDiagnostics(d []*Diagnostic)
func TestsAndBenchmarks ¶
func TestsAndBenchmarks(ctx context.Context, snapshot Snapshot, fh FileHandle) (testFns, error)
func ToProtocolEdits ¶
func WorkspaceModuleVersion ¶
func WorkspaceSymbols ¶
func WorkspaceSymbols(ctx context.Context, matcherType SymbolMatcher, style SymbolStyle, views []View, query string) ([]protocol.SymbolInformation, error)
WorkspaceSymbols matches symbols across all views using the given query, according to the match semantics parameterized by matcherType and style.
The workspace symbol method is defined in the spec as follows:
The workspace symbol request is sent from the client to the server to list project-wide symbols matching the query string.
It is unclear what "project-wide" means here, but given the parameters of workspace/symbol do not include any workspace identifier, then it has to be assumed that "project-wide" means "across all workspaces". Hence why WorkspaceSymbols receives the views []View.
However, it then becomes unclear what it would mean to call WorkspaceSymbols with a different configured SymbolMatcher per View. Therefore we assume that Session level configuration will define the SymbolMatcher to be used for the WorkspaceSymbols method.
Types ¶
type APIJSON ¶
type APIJSON struct { Options map[string][]*OptionJSON Commands []*CommandJSON Lenses []*LensJSON Analyzers []*AnalyzerJSON }
type Analyzer ¶
type Analyzer struct { Analyzer *analysis.Analyzer // Enabled reports whether the analyzer is enabled. This value can be // configured per-analysis in user settings. For staticcheck analyzers, // the value of the Staticcheck setting overrides this field. Enabled bool // Fix is the name of the suggested fix name used to invoke the suggested // fixes for the analyzer. It is non-empty if we expect this analyzer to // provide its fix separately from its diagnostics. That is, we should apply // the analyzer's suggested fixes through a Command, not a TextEdit. Fix string // ActionKind is the kind of code action this analyzer produces. If // unspecified the type defaults to quickfix. ActionKind []protocol.CodeActionKind // Severity is the severity set for diagnostics reported by this // analyzer. If left unset it defaults to Warning. Severity protocol.DiagnosticSeverity }
Analyzer represents a go/analysis analyzer with some boolean properties that let the user know how to use the analyzer.
func EnabledAnalyzers ¶
EnabledAnalyzers returns all of the analyzers enabled for the given snapshot.
type AnalyzerJSON ¶
func (*AnalyzerJSON) String ¶
func (a *AnalyzerJSON) String() string
func (*AnalyzerJSON) Write ¶
func (a *AnalyzerJSON) Write(w io.Writer)
type Annotation ¶
type Annotation string
const ( // Nil controls nil checks. Nil Annotation = "nil" // Escape controls diagnostics about escape choices. Escape Annotation = "escape" // Inline controls diagnostics about inlining choices. Inline Annotation = "inline" // Bounds controls bounds checking diagnostics. Bounds Annotation = "bounds" )
type BuildOptions ¶
type BuildOptions struct { // BuildFlags is the set of flags passed on to the build system when invoked. // It is applied to queries like `go list`, which is used when discovering files. // The most common use is to set `-tags`. BuildFlags []string // Env adds environment variables to external commands run by `gopls`, most notably `go list`. Env map[string]string // DirectoryFilters can be used to exclude unwanted directories from the // workspace. By default, all directories are included. Filters are an // operator, `+` to include and `-` to exclude, followed by a path prefix // relative to the workspace folder. They are evaluated in order, and // the last filter that applies to a path controls whether it is included. // The path prefix can be empty, so an initial `-` excludes everything. // // Examples: // // Exclude node_modules: `-node_modules` // // Include only project_a: `-` (exclude everything), `+project_a` // // Include only project_a, but not node_modules inside it: `-`, `+project_a`, `-project_a/node_modules` DirectoryFilters []string // TemplateSupport can be used to turn off support for template files. TemplateSupport bool // TemplateExtensions gives the extensions of file names that are treateed // as template files. (The extension // is the part of the file name after the final dot.) TemplateExtensions []string // MemoryMode controls the tradeoff `gopls` makes between memory usage and // correctness. // // Values other than `Normal` are untested and may break in surprising ways. MemoryMode MemoryMode `status:"experimental"` // ExpandWorkspaceToModule instructs `gopls` to adjust the scope of the // workspace to find the best available module root. `gopls` first looks for // a go.mod file in any parent directory of the workspace folder, expanding // the scope to that directory if it exists. If no viable parent directory is // found, gopls will check if there is exactly one child directory containing // a go.mod file, narrowing the scope to that directory if it exists. ExpandWorkspaceToModule bool `status:"experimental"` // ExperimentalWorkspaceModule opts a user into the experimental support // for multi-module workspaces. ExperimentalWorkspaceModule bool `status:"experimental"` // ExperimentalPackageCacheKey controls whether to use a coarser cache key // for package type information to increase cache hits. This setting removes // the user's environment, build flags, and working directory from the cache // key, which should be a safe change as all relevant inputs into the type // checking pass are already hashed into the key. This is temporarily guarded // by an experiment because caching behavior is subtle and difficult to // comprehensively test. ExperimentalPackageCacheKey bool `status:"experimental"` // AllowModfileModifications disables -mod=readonly, allowing imports from // out-of-scope modules. This option will eventually be removed. AllowModfileModifications bool `status:"experimental"` // AllowImplicitNetworkAccess disables GOPROXY=off, allowing implicit module // downloads rather than requiring user action. This option will eventually // be removed. AllowImplicitNetworkAccess bool `status:"experimental"` // ExperimentalUseInvalidMetadata enables gopls to fall back on outdated // package metadata to provide editor features if the go command fails to // load packages for some reason (like an invalid go.mod file). This will // eventually be the default behavior, and this setting will be removed. ExperimentalUseInvalidMetadata bool `status:"experimental"` }
type ClientOptions ¶
type ClientOptions struct { InsertTextFormat protocol.InsertTextFormat ConfigurationSupported bool DynamicConfigurationSupported bool DynamicRegistrationSemanticTokensSupported bool DynamicWatchedFilesSupported bool PreferredContentFormat protocol.MarkupKind LineFoldingOnly bool HierarchicalDocumentSymbolSupport bool SemanticTypes []string SemanticMods []string RelatedInformationSupported bool CompletionTags bool CompletionDeprecated bool }
ClientOptions holds LSP-specific configuration that is provided by the client.
type CommandJSON ¶
func (*CommandJSON) String ¶
func (c *CommandJSON) String() string
func (*CommandJSON) Write ¶
func (c *CommandJSON) Write(w io.Writer)
type CompletionOptions ¶
type CompletionOptions struct { // Placeholders enables placeholders for function parameters or struct // fields in completion responses. UsePlaceholders bool // CompletionBudget is the soft latency goal for completion requests. Most // requests finish in a couple milliseconds, but in some cases deep // completions can take much longer. As we use up our budget we // dynamically reduce the search scope to ensure we return timely // results. Zero means unlimited. CompletionBudget time.Duration `status:"debug"` // Matcher sets the algorithm that is used when calculating completion // candidates. Matcher Matcher `status:"advanced"` // ExperimentalPostfixCompletions enables artifical method snippets // such as "someSlice.sort!". ExperimentalPostfixCompletions bool `status:"experimental"` }
type CriticalError ¶
type CriticalError struct { // MainError is the primary error. Must be non-nil. MainError error // DiagList contains any supplemental (structured) diagnostics. DiagList []*Diagnostic }
type Declaration ¶
type Declaration struct { MappedRange []MappedRange // contains filtered or unexported fields }
type Diagnostic ¶
type Diagnostic struct { URI span.URI Range protocol.Range Severity protocol.DiagnosticSeverity Code string CodeHref string // Source is a human-readable description of the source of the error. // Diagnostics generated by an analysis.Analyzer set it to Analyzer.Name. Source DiagnosticSource Message string Tags []protocol.DiagnosticTag Related []RelatedInformation // Fields below are used internally to generate quick fixes. They aren't // part of the LSP spec and don't leave the server. SuggestedFixes []SuggestedFix Analyzer *Analyzer }
An Diagnostic corresponds to an LSP Diagnostic. https://microsoft.github.io/language-server-protocol/specification#diagnostic
type DiagnosticOptions ¶
type DiagnosticOptions struct { // Analyses specify analyses that the user would like to enable or disable. // A map of the names of analysis passes that should be enabled/disabled. // A full list of analyzers that gopls uses can be found // [here](https://github.com/golang/tools/blob/master/gopls/doc/analyzers.md). // // Example Usage: // // “`json5 // ... // "analyses": { // "unreachable": false, // Disable the unreachable analyzer. // "unusedparams": true // Enable the unusedparams analyzer. // } // ... // “` Analyses map[string]bool // Staticcheck enables additional analyses from staticcheck.io. Staticcheck bool `status:"experimental"` // Annotations specifies the various kinds of optimization diagnostics // that should be reported by the gc_details command. Annotations map[Annotation]bool `status:"experimental"` // DiagnosticsDelay controls the amount of time that gopls waits // after the most recent file modification before computing deep diagnostics. // Simple diagnostics (parsing and type-checking) are always run immediately // on recently modified packages. // // This option must be set to a valid duration string, for example `"250ms"`. DiagnosticsDelay time.Duration `status:"advanced"` // ExperimentalWatchedFileDelay controls the amount of time that gopls waits // for additional workspace/didChangeWatchedFiles notifications to arrive, // before processing all such notifications in a single batch. This is // intended for use by LSP clients that don't support their own batching of // file system notifications. // // This option must be set to a valid duration string, for example `"100ms"`. ExperimentalWatchedFileDelay time.Duration `status:"experimental"` }
type DiagnosticSource ¶
type DiagnosticSource string
const ( UnknownError DiagnosticSource = "<Unknown source>" ListError DiagnosticSource = "go list" ParseError DiagnosticSource = "syntax" TypeError DiagnosticSource = "compiler" ModTidyError DiagnosticSource = "go mod tidy" OptimizationDetailsError DiagnosticSource = "optimizer details" UpgradeNotification DiagnosticSource = "upgrade available" )
func AnalyzerErrorKind ¶
func AnalyzerErrorKind(name string) DiagnosticSource
type DocumentationOptions ¶
type DocumentationOptions struct { // HoverKind controls the information that appears in the hover text. // SingleLine and Structured are intended for use only by authors of editor plugins. HoverKind HoverKind // LinkTarget controls where documentation links go. // It might be one of: // // * `"godoc.org"` // * `"pkg.go.dev"` // // If company chooses to use its own `godoc.org`, its address can be used as well. LinkTarget string // LinksInHover toggles the presence of links to documentation in hover. LinksInHover bool }
type FileAction ¶
type FileAction int
func (FileAction) String ¶
func (a FileAction) String() string
type FileHandle ¶
type FileHandle interface { URI() span.URI Kind() FileKind // FileIdentity returns a FileIdentity for the file, even if there was an // error reading it. FileIdentity() FileIdentity // Read reads the contents of a file. // If the file is not available, returns a nil slice and an error. Read() ([]byte, error) // Saved reports whether the file has the same content on disk. Saved() bool }
FileHandle represents a handle to a specific version of a single file.
type FileIdentity ¶
type FileIdentity struct { URI span.URI // Identifier represents a unique identifier for the file's content. Hash string // Kind is the file's kind. Kind FileKind }
FileIdentity uniquely identifies a file at a version from a FileSystem.
func (FileIdentity) String ¶
func (id FileIdentity) String() string
type FileKind ¶
type FileKind int
FileKind describes the kind of the file in question. It can be one of Go, mod, or sum.
func DetectLanguage ¶
type FileModification ¶
type FileModification struct { URI span.URI Action FileAction // OnDisk is true if a watched file is changed on disk. // If true, Version will be -1 and Text will be nil. OnDisk bool // Version will be -1 and Text will be nil when they are not supplied, // specifically on textDocument/didClose and for on-disk changes. Version int32 Text []byte // LanguageID is only sent from the language client on textDocument/didOpen. LanguageID string }
FileModification represents a modification to a file.
type FileSource ¶
type FileSource interface { // GetFile returns the FileHandle for a given URI. GetFile(ctx context.Context, uri span.URI) (FileHandle, error) }
A FileSource maps uris to FileHandles. This abstraction exists both for testability, and so that algorithms can be run equally on session and snapshot files.
type FoldingRangeInfo ¶
type FoldingRangeInfo struct { MappedRange Kind protocol.FoldingRangeKind }
FoldingRangeInfo holds range and kind info of folding for an ast.Node
func FoldingRange ¶
func FoldingRange(ctx context.Context, snapshot Snapshot, fh FileHandle, lineFoldingOnly bool) (ranges []*FoldingRangeInfo, err error)
FoldingRange gets all of the folding range for f.
type FormattingOptions ¶
type FormattingOptions struct { // Local is the equivalent of the `goimports -local` flag, which puts // imports beginning with this string after third-party packages. It should // be the prefix of the import path whose imports should be grouped // separately. Local string // Gofumpt indicates if we should run gofumpt formatting. Gofumpt bool }
type Hooks ¶
type Hooks struct { LicensesText string GoDiff bool ComputeEdits diff.ComputeEdits URLRegexp *regexp.Regexp GofumptFormat func(ctx context.Context, src []byte) ([]byte, error) DefaultAnalyzers map[string]*Analyzer TypeErrorAnalyzers map[string]*Analyzer ConvenienceAnalyzers map[string]*Analyzer StaticcheckAnalyzers map[string]*Analyzer }
Hooks contains configuration that is provided to the Gopls command by the main package.
type HoverInformation ¶
type HoverInformation struct { // Signature is the symbol's signature. Signature string `json:"signature"` // SingleLine is a single line describing the symbol. // This is recommended only for use in clients that show a single line for hover. SingleLine string `json:"singleLine"` // Synopsis is a single sentence synopsis of the symbol's documentation. Synopsis string `json:"synopsis"` // FullDocumentation is the symbol's full documentation. FullDocumentation string `json:"fullDocumentation"` // LinkPath is the pkg.go.dev link for the given symbol. // For example, the "go/ast" part of "pkg.go.dev/go/ast#Node". LinkPath string `json:"linkPath"` // LinkAnchor is the pkg.go.dev link anchor for the given symbol. // For example, the "Node" part of "pkg.go.dev/go/ast#Node". LinkAnchor string `json:"linkAnchor"` // contains filtered or unexported fields }
func HoverIdentifier ¶
func HoverIdentifier(ctx context.Context, i *IdentifierInfo) (*HoverInformation, error)
func HoverInfo ¶
func HoverInfo(ctx context.Context, s Snapshot, pkg Package, obj types.Object, pkgNode ast.Node, fullDecl ast.Decl) (*HoverInformation, error)
HoverInfo returns a HoverInformation struct for an ast node and its type object. node should be the actual node used in type checking, while fullNode could be a separate node with more complete syntactic information.
type HoverKind ¶
type HoverKind string
const ( SingleLine HoverKind = "SingleLine" NoDocumentation HoverKind = "NoDocumentation" SynopsisDocumentation HoverKind = "SynopsisDocumentation" FullDocumentation HoverKind = "FullDocumentation" // Structured is an experimental setting that returns a structured hover format. // This format separates the signature from the documentation, so that the client // can do more manipulation of these fields. // // This should only be used by clients that support this behavior. Structured HoverKind = "Structured" )
type IdentifierInfo ¶
type IdentifierInfo struct { Name string Snapshot Snapshot MappedRange Type struct { MappedRange Object types.Object } Inferred *types.Signature Declaration Declaration // contains filtered or unexported fields }
IdentifierInfo holds information about an identifier in Go source.
func Identifier ¶
func Identifier(ctx context.Context, snapshot Snapshot, fh FileHandle, pos protocol.Position) (*IdentifierInfo, error)
Identifier returns identifier information for a position in a file, accounting for a potentially incomplete selector.
func (*IdentifierInfo) IsImport ¶
func (i *IdentifierInfo) IsImport() bool
type ImportFix ¶
func AllImportsFixes ¶
func AllImportsFixes(ctx context.Context, snapshot Snapshot, fh FileHandle) (allFixEdits []protocol.TextEdit, editsPerFix []*ImportFix, err error)
AllImportsFixes formats f for each possible fix to the imports. In addition to returning the result of applying all edits, it returns a list of fixes that could be applied to the file, with the corresponding TextEdits that would be needed to apply that fix.
type ImportShortcut ¶
type ImportShortcut string
const ( Both ImportShortcut = "Both" Link ImportShortcut = "Link" Definition ImportShortcut = "Definition" )
func (ImportShortcut) ShowDefinition ¶
func (s ImportShortcut) ShowDefinition() bool
func (ImportShortcut) ShowLinks ¶
func (s ImportShortcut) ShowLinks() bool
type InternalOptions ¶
type InternalOptions struct { // LiteralCompletions controls whether literal candidates such as // "&someStruct{}" are offered. Tests disable this flag to simplify // their expected values. LiteralCompletions bool // VerboseWorkDoneProgress controls whether the LSP server should send // progress reports for all work done outside the scope of an RPC. // Used by the regression tests. VerboseWorkDoneProgress bool // CompletionDocumentation enables documentation with completion results. CompletionDocumentation bool // CompleteUnimported enables completion for packages that you do not // currently import. CompleteUnimported bool // DeepCompletion enables the ability to return completions from deep // inside relevant entities, rather than just the locally accessible ones. // // Consider this example: // // “`go // package main // // import "fmt" // // type wrapString struct { // str string // } // // func main() { // x := wrapString{"hello world"} // fmt.Printf(<>) // } // “` // // At the location of the `<>` in this program, deep completion would suggest the result `x.str`. DeepCompletion bool // TempModfile controls the use of the -modfile flag in Go 1.14. TempModfile bool }
InternalOptions contains settings that are not intended for use by the average user. These may be settings used by tests or outdated settings that will soon be deprecated. Some of these settings may not even be configurable by the user.
type InvocationFlags ¶
type InvocationFlags int
InvocationFlags represents the settings of a particular go command invocation. It is a mode, plus a set of flag bits.
const ( // Normal is appropriate for commands that might be run by a user and don't // deliberately modify go.mod files, e.g. `go test`. Normal InvocationFlags = iota // UpdateUserModFile is for commands that intend to update the user's real // go.mod file, e.g. `go mod tidy` in response to a user's request to tidy. UpdateUserModFile // WriteTemporaryModFile is for commands that need information from a // modified version of the user's go.mod file, e.g. `go mod tidy` used to // generate diagnostics. WriteTemporaryModFile // LoadWorkspace is for packages.Load, and other operations that should // consider the whole workspace at once. LoadWorkspace // AllowNetwork is a flag bit that indicates the invocation should be // allowed to access the network. AllowNetwork InvocationFlags = 1 << 10 )
func (InvocationFlags) AllowNetwork ¶
func (m InvocationFlags) AllowNetwork() bool
func (InvocationFlags) Mode ¶
func (m InvocationFlags) Mode() InvocationFlags
type LinkTarget ¶
type LinkTarget string
type MappedRange ¶
type MappedRange struct {
// contains filtered or unexported fields
}
MappedRange provides mapped protocol.Range for a span.Range, accounting for UTF-16 code points.
func NewMappedRange ¶
func NewMappedRange(fset *token.FileSet, m *protocol.ColumnMapper, start, end token.Pos) MappedRange
NewMappedRange returns a MappedRange for the given start and end token.Pos.
func (MappedRange) SpanRange ¶
func (s MappedRange) SpanRange() span.Range
func (MappedRange) URI ¶
func (s MappedRange) URI() span.URI
type MemoryMode ¶
type MemoryMode string
const ( ModeNormal MemoryMode = "Normal" // In DegradeClosed mode, `gopls` will collect less information about // packages without open files. As a result, features like Find // References and Rename will miss results in such packages. ModeDegradeClosed MemoryMode = "DegradeClosed" )
type Metadata ¶
type Metadata interface { // PackageName is the package name. PackageName() string // PackagePath is the package path. PackagePath() string }
Metadata represents package metadata retrieved from go/packages.
type NavigationOptions ¶
type NavigationOptions struct { // documentation or go to definitions. ImportShortcut ImportShortcut SymbolMatcher SymbolMatcher `status:"advanced"` // // Example Usage: // // “`json5 // "gopls": { // ... // "symbolStyle": "Dynamic", // ... // } // “` SymbolStyle SymbolStyle `status:"advanced"` }
type OptionJSON ¶
type OptionJSON struct { Name string Type string Doc string EnumKeys EnumKeys EnumValues []EnumValue Default string Status string Hierarchy string }
func (*OptionJSON) String ¶
func (o *OptionJSON) String() string
func (*OptionJSON) Write ¶
func (o *OptionJSON) Write(w io.Writer)
type OptionResult ¶
type OptionResult struct { Name string Value interface{} Error error State OptionState Replacement string }
type OptionResults ¶
type OptionResults []OptionResult
func SetOptions ¶
func SetOptions(options *Options, opts interface{}) OptionResults
type OptionState ¶
type OptionState int
type Options ¶
type Options struct { ClientOptions ServerOptions UserOptions InternalOptions Hooks }
Options holds various configuration that affects Gopls execution, organized by the nature or origin of the settings.
func DefaultOptions ¶
func DefaultOptions() *Options
DefaultOptions is the options that are used for Gopls execution independent of any externally provided configuration (LSP initialization, command invocation, etc.).
func (*Options) AddStaticcheckAnalyzer ¶
func (*Options) EnableAllExperiments ¶
func (o *Options) EnableAllExperiments()
EnableAllExperiments turns on all of the experimental "off-by-default" features offered by gopls. Any experimental features specified in maps should be enabled in enableAllExperimentMaps.
func (*Options) ForClientCapabilities ¶
func (o *Options) ForClientCapabilities(caps protocol.ClientCapabilities)
type Overlay ¶
type Overlay interface { VersionedFileHandle }
Overlay is the type for a file held in memory on a session.
type Package ¶
type Package interface { ID() string Name() string PkgPath() string CompiledGoFiles() []*ParsedGoFile File(uri span.URI) (*ParsedGoFile, error) GetSyntax() []*ast.File GetTypes() *types.Package GetTypesInfo() *types.Info GetTypesSizes() types.Sizes IsIllTyped() bool ForTest() string GetImport(pkgPath string) (Package, error) MissingDependencies() []string Imports() []Package Version() *module.Version HasListOrParseErrors() bool HasTypeErrors() bool ParseMode() ParseMode }
Package represents a Go package that has been type-checked. It maintains only the relevant fields of a *go/packages.Package.
type PackageFilter ¶
type PackageFilter int
PackageFilter sets how a package is filtered out from a set of packages containing a given file.
const ( // NarrowestPackage picks the "narrowest" package for a given file. // By "narrowest" package, we mean the package with the fewest number of // files that includes the given file. This solves the problem of test // variants, as the test will have more files than the non-test package. NarrowestPackage PackageFilter = iota // WidestPackage returns the Package containing the most files. // This is useful for something like diagnostics, where we'd prefer to // offer diagnostics for as many files as possible. WidestPackage )
type ParseMode ¶
type ParseMode int
ParseMode controls the content of the AST produced when parsing a source file.
const ( // ParseHeader specifies that the main package declaration and imports are needed. // This is the mode used when attempting to examine the package graph structure. ParseHeader ParseMode = iota // ParseExported specifies that the package is used only as a dependency, // and only its exported declarations are needed. More may be included if // necessary to avoid type errors. ParseExported // ParseFull specifies the full AST is needed. // This is used for files of direct interest where the entire contents must // be considered. ParseFull )
type ParsedGoFile ¶
type ParsedGoFile struct { URI span.URI Mode ParseMode File *ast.File Tok *token.File // Source code used to build the AST. It may be different from the // actual content of the file if we have fixed the AST. Src []byte Mapper *protocol.ColumnMapper ParseErr scanner.ErrorList }
A ParsedGoFile contains the results of parsing a Go file.
type ParsedModule ¶
type ParsedModule struct { URI span.URI File *modfile.File Mapper *protocol.ColumnMapper ParseErrors []*Diagnostic }
A ParsedModule contains the results of parsing a go.mod file.
type PrepareItem ¶
func PrepareRename ¶
func PrepareRename(ctx context.Context, snapshot Snapshot, f FileHandle, pp protocol.Position) (_ *PrepareItem, usererr, err error)
PrepareRename searches for a valid renaming at position pp.
The returned usererr is intended to be displayed to the user to explain why the prepare fails. Probably we could eliminate the redundancy in returning two errors, but for now this is done defensively.
type ReferenceInfo ¶
type ReferenceInfo struct { Name string MappedRange // contains filtered or unexported fields }
ReferenceInfo holds information about reference to an identifier in Go source.
func References ¶
func References(ctx context.Context, s Snapshot, f FileHandle, pp protocol.Position, includeDeclaration bool) ([]*ReferenceInfo, error)
References returns a list of references for a given identifier within the packages containing i.File. Declarations appear first in the result.
type RelatedInformation ¶
type ServerOptions ¶
type ServerOptions struct { SupportedCodeActions map[FileKind]map[protocol.CodeActionKind]bool SupportedCommands []string }
ServerOptions holds LSP-specific configuration that is provided by the server.
type Session ¶
type Session interface { // ID returns the unique identifier for this session on this server. ID() string // NewView creates a new View, returning it and its first snapshot. If a // non-empty tempWorkspace directory is provided, the View will record a copy // of its gopls workspace module in that directory, so that client tooling // can execute in the same main module. NewView(ctx context.Context, name string, folder, tempWorkspace span.URI, options *Options) (View, Snapshot, func(), error) // Cache returns the cache that created this session, for debugging only. Cache() interface{} // View returns a view with a matching name, if the session has one. View(name string) View // ViewOf returns a view corresponding to the given URI. ViewOf(uri span.URI) (View, error) // Views returns the set of active views built by this session. Views() []View // Shutdown the session and all views it has created. Shutdown(ctx context.Context) // GetFile returns a handle for the specified file. GetFile(ctx context.Context, uri span.URI) (FileHandle, error) // DidModifyFile reports a file modification to the session. It returns // the new snapshots after the modifications have been applied, paired with // the affected file URIs for those snapshots. DidModifyFiles(ctx context.Context, changes []FileModification) (map[Snapshot][]span.URI, []func(), error) // ExpandModificationsToDirectories returns the set of changes with the // directory changes removed and expanded to include all of the files in // the directory. ExpandModificationsToDirectories(ctx context.Context, changes []FileModification) []FileModification // Overlays returns a slice of file overlays for the session. Overlays() []Overlay // Options returns a copy of the SessionOptions for this session. Options() *Options // SetOptions sets the options of this session to new values. SetOptions(*Options) // FileWatchingGlobPatterns returns glob patterns to watch every directory // known by the view. For views within a module, this is the module root, // any directory in the module root, and any replace targets. FileWatchingGlobPatterns(ctx context.Context) map[string]struct{} // SetProgressTracker sets the progress tracker for the session. SetProgressTracker(tracker *progress.Tracker) }
Session represents a single connection from a client. This is the level at which things like open files are maintained on behalf of the client. A session may have many active views at any given time.
type Snapshot ¶
type Snapshot interface { ID() uint64 // View returns the View associated with this snapshot. View() View // BackgroundContext returns a context used for all background processing // on behalf of this snapshot. BackgroundContext() context.Context // Fileset returns the Fileset used to parse all the Go files in this snapshot. FileSet() *token.FileSet // ValidBuildConfiguration returns true if there is some error in the // user's workspace. In particular, if they are both outside of a module // and their GOPATH. ValidBuildConfiguration() bool // WriteEnv writes the view-specific environment to the io.Writer. WriteEnv(ctx context.Context, w io.Writer) error // FindFile returns the FileHandle for the given URI, if it is already // in the given snapshot. FindFile(uri span.URI) VersionedFileHandle // GetVersionedFile returns the VersionedFileHandle for a given URI, // initializing it if it is not already part of the snapshot. GetVersionedFile(ctx context.Context, uri span.URI) (VersionedFileHandle, error) // GetFile returns the FileHandle for a given URI, initializing it if it is // not already part of the snapshot. GetFile(ctx context.Context, uri span.URI) (FileHandle, error) // AwaitInitialized waits until the snapshot's view is initialized. AwaitInitialized(ctx context.Context) // IsOpen returns whether the editor currently has a file open. IsOpen(uri span.URI) bool // IgnoredFile reports if a file would be ignored by a `go list` of the whole // workspace. IgnoredFile(uri span.URI) bool // Templates returns the .tmpl files Templates() map[span.URI]VersionedFileHandle // ParseGo returns the parsed AST for the file. // If the file is not available, returns nil and an error. ParseGo(ctx context.Context, fh FileHandle, mode ParseMode) (*ParsedGoFile, error) // PosToField is a cache of *ast.Fields by token.Pos. This allows us // to quickly find corresponding *ast.Field node given a *types.Var. // We must refer to the AST to render type aliases properly when // formatting signatures and other types. PosToField(ctx context.Context, pkg Package, pos token.Pos) (*ast.Field, error) // PosToDecl maps certain objects' positions to their surrounding // ast.Decl. This mapping is used when building the documentation // string for the objects. PosToDecl(ctx context.Context, pkg Package, pos token.Pos) (ast.Decl, error) // DiagnosePackage returns basic diagnostics, including list, parse, and type errors // for pkg, grouped by file. DiagnosePackage(ctx context.Context, pkg Package) (map[span.URI][]*Diagnostic, error) // Analyze runs the analyses for the given package at this snapshot. Analyze(ctx context.Context, pkgID string, analyzers []*Analyzer) ([]*Diagnostic, error) // RunGoCommandPiped runs the given `go` command, writing its output // to stdout and stderr. Verb, Args, and WorkingDir must be specified. RunGoCommandPiped(ctx context.Context, mode InvocationFlags, inv *gocommand.Invocation, stdout, stderr io.Writer) error // RunGoCommandDirect runs the given `go` command. Verb, Args, and // WorkingDir must be specified. RunGoCommandDirect(ctx context.Context, mode InvocationFlags, inv *gocommand.Invocation) (*bytes.Buffer, error) // RunGoCommands runs a series of `go` commands that updates the go.mod // and go.sum file for wd, and returns their updated contents. RunGoCommands(ctx context.Context, allowNetwork bool, wd string, run func(invoke func(...string) (*bytes.Buffer, error)) error) (bool, []byte, []byte, error) // RunProcessEnvFunc runs fn with the process env for this snapshot's view. // Note: the process env contains cached module and filesystem state. RunProcessEnvFunc(ctx context.Context, fn func(*imports.Options) error) error // ModFiles are the go.mod files enclosed in the snapshot's view and known // to the snapshot. ModFiles() []span.URI // ParseMod is used to parse go.mod files. ParseMod(ctx context.Context, fh FileHandle) (*ParsedModule, error) // ModWhy returns the results of `go mod why` for the module specified by // the given go.mod file. ModWhy(ctx context.Context, fh FileHandle) (map[string]string, error) // ModTidy returns the results of `go mod tidy` for the module specified by // the given go.mod file. ModTidy(ctx context.Context, pm *ParsedModule) (*TidiedModule, error) // GoModForFile returns the URI of the go.mod file for the given URI. GoModForFile(uri span.URI) span.URI // BuiltinFile returns information about the special builtin package. BuiltinFile(ctx context.Context) (*ParsedGoFile, error) // IsBuiltin reports whether uri is part of the builtin package. IsBuiltin(ctx context.Context, uri span.URI) bool // PackagesForFile returns the packages that this file belongs to, checked // in mode. PackagesForFile(ctx context.Context, uri span.URI, mode TypecheckMode, includeTestVariants bool) ([]Package, error) // PackageForFile returns a single package that this file belongs to, // checked in mode and filtered by the package policy. PackageForFile(ctx context.Context, uri span.URI, mode TypecheckMode, selectPackage PackageFilter) (Package, error) // GetActiveReverseDeps returns the active files belonging to the reverse // dependencies of this file's package, checked in TypecheckWorkspace mode. GetReverseDependencies(ctx context.Context, id string) ([]Package, error) // CachedImportPaths returns all the imported packages loaded in this // snapshot, indexed by their import path and checked in TypecheckWorkspace // mode. CachedImportPaths(ctx context.Context) (map[string]Package, error) // KnownPackages returns all the packages loaded in this snapshot, checked // in TypecheckWorkspace mode. KnownPackages(ctx context.Context) ([]Package, error) // ActivePackages returns the packages considered 'active' in the workspace. // // In normal memory mode, this is all workspace packages. In degraded memory // mode, this is just the reverse transitive closure of open packages. ActivePackages(ctx context.Context) ([]Package, error) // Symbols returns all symbols in the snapshot. Symbols(ctx context.Context) (map[span.URI][]Symbol, error) // Metadata returns package metadata associated with the given file URI. MetadataForFile(ctx context.Context, uri span.URI) ([]Metadata, error) // GetCriticalError returns any critical errors in the workspace. GetCriticalError(ctx context.Context) *CriticalError // BuildGoplsMod generates a go.mod file for all modules in the workspace. // It bypasses any existing gopls.mod. BuildGoplsMod(ctx context.Context) (*modfile.File, error) }
Snapshot represents the current state for the given view.
type SuggestedFix ¶
type SuggestedFix struct { Title string Edits map[span.URI][]protocol.TextEdit Command *protocol.Command ActionKind protocol.CodeActionKind }
func SuggestedFixFromCommand ¶
func SuggestedFixFromCommand(cmd protocol.Command, kind protocol.CodeActionKind) SuggestedFix
type SuggestedFixFunc ¶
type SuggestedFixFunc func(ctx context.Context, snapshot Snapshot, fh VersionedFileHandle, pRng protocol.Range) (*analysis.SuggestedFix, error)
SuggestedFixFunc is a function used to get the suggested fixes for a given gopls command, some of which are provided by go/analysis.Analyzers. Some of the analyzers in internal/lsp/analysis are not efficient enough to include suggested fixes with their diagnostics, so we have to compute them separately. Such analyzers should provide a function with a signature of SuggestedFixFunc.
type Symbol ¶
type Symbol struct { Name string Kind protocol.SymbolKind Range protocol.Range }
Symbol holds a precomputed symbol value. Note: we avoid using the protocol.SymbolInformation struct here in order to reduce the size of each symbol.
type SymbolMatcher ¶
type SymbolMatcher string
const ( SymbolFuzzy SymbolMatcher = "Fuzzy" SymbolFastFuzzy SymbolMatcher = "FastFuzzy" SymbolCaseInsensitive SymbolMatcher = "CaseInsensitive" SymbolCaseSensitive SymbolMatcher = "CaseSensitive" )
type SymbolStyle ¶
type SymbolStyle string
const ( // PackageQualifiedSymbols is package qualified symbols i.e. // "pkg.Foo.Field". PackageQualifiedSymbols SymbolStyle = "Package" // FullyQualifiedSymbols is fully qualified symbols, i.e. // "path/to/pkg.Foo.Field". FullyQualifiedSymbols SymbolStyle = "Full" // DynamicSymbols uses whichever qualifier results in the highest scoring // match for the given symbol query. Here a "qualifier" is any "/" or "." // delimited suffix of the fully qualified symbol. i.e. "to/pkg.Foo.Field" or // just "Foo.Field". DynamicSymbols SymbolStyle = "Dynamic" )
type TidiedModule ¶
type TidiedModule struct { // Diagnostics representing changes made by `go mod tidy`. Diagnostics []*Diagnostic // The bytes of the go.mod file after it was tidied. TidiedContent []byte }
A TidiedModule contains the results of running `go mod tidy` on a module.
type TypecheckMode ¶
type TypecheckMode int
TypecheckMode controls what kind of parsing should be done (see ParseMode) while type checking a package.
const ( // Invalid default value. TypecheckUnknown TypecheckMode = iota // TypecheckFull means to use ParseFull. TypecheckFull // TypecheckWorkspace means to use ParseFull for workspace packages, and // ParseExported for others. TypecheckWorkspace // TypecheckAll means ParseFull for workspace packages, and both Full and // Exported for others. Only valid for some functions. TypecheckAll )
type UIOptions ¶
type UIOptions struct { DocumentationOptions CompletionOptions DiagnosticOptions // Codelenses overrides the enabled/disabled state of code lenses. See the // "Code Lenses" section of the // [Settings page](https://github.com/golang/tools/blob/master/gopls/doc/settings.md) // for the list of supported lenses. // // Example Usage: // // “`json5 // "gopls": { // ... // "codelenses": { // "generate": false, // Don't show the `go generate` lens. // "gc_details": true // Show a code lens toggling the display of gc's choices. // } // ... // } // “` Codelenses map[string]bool // SemanticTokens controls whether the LSP server will send // semantic tokens to the client. SemanticTokens bool `status:"experimental"` }
type UserOptions ¶
type UserOptions struct { BuildOptions UIOptions FormattingOptions // VerboseOutput enables additional debug logging. VerboseOutput bool `status:"debug"` }
UserOptions holds custom Gopls configuration (not part of the LSP) that is modified by the client.
func (*UserOptions) EnvSlice ¶
func (u *UserOptions) EnvSlice() []string
EnvSlice returns Env as a slice of k=v strings.
func (*UserOptions) SetEnvSlice ¶
func (u *UserOptions) SetEnvSlice(env []string)
SetEnvSlice sets Env from a slice of k=v strings.
type VersionedFileHandle ¶
type VersionedFileHandle interface { FileHandle Version() int32 Session() string // LSPIdentity returns the version identity of a file. VersionedFileIdentity() VersionedFileIdentity }
type VersionedFileIdentity ¶
type View ¶
type View interface { // Name returns the name this view was constructed with. Name() string // Folder returns the folder with which this view was created. Folder() span.URI // TempWorkspace returns the folder this view uses for its temporary // workspace module. TempWorkspace() span.URI // Shutdown closes this view, and detaches it from its session. Shutdown(ctx context.Context) // Options returns a copy of the Options for this view. Options() *Options // SetOptions sets the options of this view to new values. // Calling this may cause the view to be invalidated and a replacement view // added to the session. If so the new view will be returned, otherwise the // original one will be. SetOptions(context.Context, *Options) (View, error) // Snapshot returns the current snapshot for the view. Snapshot(ctx context.Context) (Snapshot, func()) // Rebuild rebuilds the current view, replacing the original view in its session. Rebuild(ctx context.Context) (Snapshot, func(), error) // IsGoPrivatePath reports whether target is a private import path, as identified // by the GOPRIVATE environment variable. IsGoPrivatePath(path string) bool // ModuleUpgrades returns known module upgrades. ModuleUpgrades() map[string]string // RegisterModuleUpgrades registers that upgrades exist for the given modules. RegisterModuleUpgrades(upgrades map[string]string) }
View represents a single workspace. This is the level at which we maintain configuration like working directory and build tags.
Source Files ¶
- add_import.go
- api_json.go
- call_hierarchy.go
- code_lens.go
- comment.go
- diagnostics.go
- extract.go
- fix.go
- folding_range.go
- format.go
- gc_annotations.go
- highlight.go
- hover.go
- identifier.go
- implementation.go
- known_packages.go
- options.go
- references.go
- rename.go
- rename_check.go
- signature_help.go
- symbols.go
- types_format.go
- util.go
- view.go
- workspace_symbol.go
Directories ¶
Path | Synopsis |
---|---|
Package completion provides core functionality for code completion in Go editors and tools.
|
Package completion provides core functionality for code completion in Go editors and tools. |