gopls

package

v0.3.0 Latest Latest Go to latest Published: Apr 3, 2024 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Azure/azure-sdk-for-go

Links

Open Source Insights

Documentation ¶

Index ¶

func Rename(sym *Symbol, newName string) error
type Symbol
- func (s Symbol) StartLine() (int64, error)
type SymbolMap
- func NewSymbolMap(m map[string]*Symbol) *SymbolMap
- func Symbols(filename string) (*SymbolMap, error)
- func (s SymbolMap) All() []*Symbol
- func (s SymbolMap) Get(name string) *Symbol
type SymbolType

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Rename ¶

func Rename(sym *Symbol, newName string) error

Rename renames a given symbol to a new name. This naming will propagate throughout, including references to the type, the type name itself and any comments that contain the type name in godoc's reference format with '[typename]'.

Types ¶

type Symbol ¶

type Symbol struct {
	Name string
	Type SymbolType

	// Position is a start and end range for a symbol
	// ex: 36:2-36:7
	// (line 36, columns 2 - 7)
	Position string

	File string
}

func (Symbol) StartLine ¶

func (s Symbol) StartLine() (int64, error)

StartLine returns the starting line for this symbol.

type SymbolMap ¶

type SymbolMap struct {
	// contains filtered or unexported fields
}

func NewSymbolMap ¶

func NewSymbolMap(m map[string]*Symbol) *SymbolMap

func Symbols ¶

func Symbols(filename string) (*SymbolMap, error)

Symbols parses the output of `gopls symbols`.

func (SymbolMap) All ¶

func (s SymbolMap) All() []*Symbol

All gets all the symbols within our map, in no specific order.

func (SymbolMap) Get ¶

func (s SymbolMap) Get(name string) *Symbol

Get retrieves a symbol, ignoring casing.

type SymbolType ¶

type SymbolType string

SymbolType maps to the second field in the `gopls symbols` output.

const (
	SymbolTypeConstant SymbolType = "Constant"
	SymbolTypeClass    SymbolType = "Class" // (ex: ACSRouterJobStatus, from 'type ACSRouterJobStatus string')
	SymbolTypeStruct   SymbolType = "Struct"
	SymbolTypeField    SymbolType = "Field"
	SymbolTypeFunction SymbolType = "Function"
	SymbolTypeMethod   SymbolType = "Method" // ex: '(*WebBackupOperationCompletedEventData).UnmarshalJSON'
)

Source Files ¶

View all Source files

gopls.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL