awgodoc

package module

v0.0.0-alpha1 Latest Latest Go to latest Published: Dec 22, 2021 License: MIT Imports: 12 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/morikuni/awgodoc

README ¶

awgodoc

Alfred workflow for searching pkg.go.dev.

Documentation ¶

Index ¶

type App
- func NewApp() *App
- func (app *App) Run()
type Client
- func NewClient() *Client
- func (cli *Client) SearchPackages(ctx context.Context, query string) ([]*Package, error)
- func (cli *Client) SearchSymbols(ctx context.Context, query string) ([]*Symbol, error)
type Kind
type Package
type Symbol

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type App ¶

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

func NewApp ¶

func NewApp() *App

func (*App) Run ¶

func (app *App) Run()

type Client ¶

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

func NewClient ¶

func NewClient() *Client

func (*Client) SearchPackages ¶

func (cli *Client) SearchPackages(ctx context.Context, query string) ([]*Package, error)

func (*Client) SearchSymbols ¶

func (cli *Client) SearchSymbols(ctx context.Context, query string) ([]*Symbol, error)

type Kind ¶

type Kind string

const (
	KindType     Kind = "type"
	KindConstant Kind = "constant"
	KindFunction Kind = "function"
	KindVariable Kind = "variable"
	KindMethod   Kind = "method"
)

type Package ¶

type Package struct {
	Name              string
	ImportPath        string
	IsStandardLibrary bool
	URL               string
}

type Symbol ¶

type Symbol struct {
	Name              string
	Kind              Kind
	ImportPath        string
	IsStandardLibrary bool
	Code              string
	URL               string
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
awgodoc

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