goggles

README

goggles

     

🔭 Goggles is a GUI for your $GOPATH.

Features

• Browse and search local packages
• View package documentation
• Open the project folder in Finder or Terminal
• Open the project repository in your browser
• Displays badges for GoDoc, Goreportcard, and Travis.CI (if .travis.yml is present)

Install

Goggles can be run in a web browser (cross-platform) or as a standalone application (Mac only).

Stable

Grab the latest release from the Releases page.

From Source

Regardless, there are a few steps you'll need to take in order to build and run Goggles from source:

1. go get github.com/KyleBanks/goggles/...
2. Install npm and Gulp, in order to build the front-end assets.
3. Install go-bindata-assetfs in order to bundle front-end assets into the Go binary.

Web Browser

1. Run make to build and run Goggles in your web browser.

Standalone (Mac Only)

1. Install Gallium, in order to bundle the .app.
2. Run make app to build and launch the application.

Note: If you'd like to see Goggles available as a standalone application on additional platforms, I encourage you to help contribute to the Gallium project.

Contributing

Contributions to Goggles are very welcome! In order to contribute, either open a new issue for discussion prior to making changes, or comment on an existing ticket indicating that you'd like to take it.

Author

Goggles was developed by Kyle Banks.

Thanks

The Gopher loading images were created by Ashley McNamara and inspired by Renee French.

License

Goggles is available under the Apache 2.0 license.

Documentation

Index

• type Doc
• type DocType
• type Package
  • func NewPackage(path string) (*Package, error)
• type Service
  • func (Service) Details(name string) (*Package, error)
  • func (s Service) List() ([]*Package, error)

Types

type Doc

type Doc struct {
	Type DocType `json:"type"`

	Name        string `json:"name"`
	Repository  string `json:"repository"`
	Header      string `json:"header"`
	Import      string `json:"import"`
	Declaration string `json:"declaration"`
	Usage       string `json:"usage"`

	Constants string `json:"constants"`
	Variables string `json:"variables"`
	Content   []Doc  `json:"content"`

	HasTravis bool `json:"hasTravis"`
}

Doc represents documentation for a function, type, or package.

type DocType

type DocType string

DocType defines a type of documentation.

const (
	// PackageDoc indicates package-level documentation.
	PackageDoc DocType = "PACKAGE"
	// FunctionDoc indicates function-level documentation.
	FunctionDoc DocType = "FUNCTION"
	// TypeDoc indicates type-level documentation.
	TypeDoc DocType = "TYPE"
)

type Package

type Package struct {
	depth.Pkg

	Docs *Doc `json:"docs"`
	// contains filtered or unexported fields
}

Package represents a go source package.

func NewPackage

func NewPackage(path string) (*Package, error)

NewPackage attempts to resolve a go package from the path provided.

The path can be either the absolute path (ex. /foo/bar/package) or the import path (ex. github.com/foo/bar).

type Service

type Service struct{}

Service is a pkg service that can access go packages.

func (Service) Details

func (Service) Details(name string) (*Package, error)

Details returns the full details of a Package.

func (Service) List

func (s Service) List() ([]*Package, error)

List returns a list of all packages in the $GOPATH.