workspace

Documentation

Overview

Package workspace validates and contains access to a configured Go workspace.

Index

• type Toolchain
• type Workspace
  • func Open(ctx context.Context, root string) (*Workspace, error)
  • func (w *Workspace) Relative(path string) (string, error)
  • func (w *Workspace) RequiredGo() string
  • func (w *Workspace) Resolve(path string) (string, error)
  • func (w *Workspace) Root() string
  • func (w *Workspace) Toolchain() Toolchain

Types

type Toolchain

type Toolchain struct {
	Path    string `json:"path"`
	Version string `json:"version"`
}

Toolchain is the effective Go executable selected from the process PATH.

type Workspace

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

Workspace is a validated, symlink-resolved Go workspace root.

func Open

func Open(ctx context.Context, root string) (*Workspace, error)

Open validates root as a directory in an active Go module or workspace.

func (*Workspace) Relative

func (w *Workspace) Relative(path string) (string, error)

Relative returns an existing contained path relative to the workspace root.

func (*Workspace) RequiredGo

func (w *Workspace) RequiredGo() string

RequiredGo returns the highest Go version required by the active workspace.

func (*Workspace) Resolve

func (w *Workspace) Resolve(path string) (string, error)

Resolve resolves an existing path and rejects anything outside the workspace.

func (*Workspace) Root

func (w *Workspace) Root() string

Root returns the absolute, symlink-resolved workspace root.

func (*Workspace) Toolchain

func (w *Workspace) Toolchain() Toolchain

Toolchain returns the immutable effective Go toolchain recorded at preflight.