package
0.0.0-20250115223502-0ee3d4bd54b7
Repository: https://github.com/gnoverse/gnopls.git
Documentation: pkg.go.dev

# Packages

Package completion provides core functionality for code completion in Go editors and tools.

# Functions

AddImport adds a single import statement to the given file.
Analyze reports go/analysis-framework diagnostics in the specified package.
ApplyFix applies the specified kind of suggested fix to the given file and range, returning the resulting changes.
AssemblyHTML returns an HTML document containing an assembly listing of the selected function.
CodeActions returns all enabled code actions (edits and other commands) available for the selected range.
CodeLensSources returns the supported sources of code lenses for Go files.
CollectScopes returns all scopes in an ast path, ordered as innermost scope first.
CommentToMarkdown converts comment text to formatted markdown.
ComputeOneImportFixEdits returns text edits for a single import fix.
Definition handles the textDocument/definition request for Go files.
DocFragment finds the package and (optionally) symbol identified by the current selection, and returns the package path and the optional symbol URL fragment (e.g.
No description provided by the author
ExtractToNewFile moves selected declarations into a new file.
FoldingRange gets all of the folding range for f.
Format formats a file with a given range.
FormatNode returns the "pretty-print" output for an ast node.
FormatType returns the detail and kind for a types.Type.
FormatTypeParams turns TypeParamList into its Go representation, such as: [T, Y].
FormatVarType formats a *types.Var, accounting for type aliases.
FreeSymbolsHTML returns an HTML document containing the report of free symbols referenced by the selection.
GCOptimizationDetails invokes the Go compiler on the specified package and reports its log of optimizations decisions as a set of diagnostics.
No description provided by the author
Hover implements the "textDocument/hover" RPC for Go files.
HoverDocForObject returns the best doc comment for obj (for which fset provides file/line information).
Implementation returns a new sorted array of locations of declarations of types that implement (or are implemented by) the type referred to at the given position.
IncomingCalls returns an array of CallHierarchyIncomingCall for a file and the position within the file.
No description provided by the author
IsGenerated gets and reads the file denoted by uri and reports whether it contains a "generated file" comment as described at https://golang.org/s/generatedcode.
KnownPackagePaths returns a new list of package paths of all known packages in the package graph that could potentially be imported by the given file.
MetadataQualifierForFile returns a metadata qualifier that chooses the best qualification of an imported package relative to the file f in package with metadata m.
NarrowestMetadataForFile returns metadata for the narrowest package (the one with the fewest files) that encloses the specified file.
NarrowestPackageForFile is a convenience function that selects the narrowest non-ITV package to which this file belongs, type-checks it in the requested mode (full or workspace), and returns it, along with the parse tree of that file.
NewBuiltinSignature returns signature for the builtin object with a given name, if a builtin object with the name exists.
NewSignature returns formatted signature for a types.Signature struct.
OutgoingCalls returns an array of CallHierarchyOutgoingCall for a file and the position within the file.
PackageDocHTML formats the package documentation page.
PrepareCallHierarchy returns an array of CallHierarchyItem for a file and the position within the file.
PrepareRename searches for a valid renaming at position pp.
References returns a list of all references (sorted with definitions before uses) to the object denoted by the identifier at the given file/position, searching the entire workspace.
RemoveUnusedParameter computes a refactoring to remove the parameter indicated by the given range, which must be contained within an unused parameter name or field.
Rename returns a map of TextEdits for each file modified when renaming a given identifier within a package and a boolean value of true for renaming package and false otherwise.
No description provided by the author
SignatureHelp returns information about the signature of the innermost function call enclosing the position, or nil if there is none.
StdSymbolOf returns the std lib symbol information of the given obj.
TypeDefinition handles the textDocument/typeDefinition request for Go files.
WidestPackageForFile is a convenience function that selects the widest non-ITV package to which this file belongs, type-checks it in the requested mode (full or workspace), and returns it, along with the parse tree of that file.
WorkspaceSymbols matches symbols across all views using the given query, according to the match semantics parameterized by matcherType and style.

# Variables

ErrNoEmbed is returned by EmbedDefinition when no embed directive is found at a particular position.
ErrNoIdentFound is error returned when no identifier is found at a particular position.
ErrNoLinkname is returned by LinknameDefinition when no linkname directive is found at a particular position.

# Structs

FoldingRangeInfo holds range and kind info of folding for an ast.Node.
A PrepareItem holds the result of a "prepare rename" operation: the source range and value of a selected identifier.

# Interfaces

Web is an abstraction of gopls' web server.

# Type aliases

An importFunc is an implementation of the single-method types.Importer interface based on a function value.
No description provided by the author
A MetadataQualifier is a function that qualifies an identifier declared in a package with the given package name, import path, and package path.
No description provided by the author
No description provided by the author
No description provided by the author