workspace

Documentation

Index

• Constants
• func FindWorkspaceTempDir(wd string, opts FindWorkspaceOptions) string
• type FS
• type FindWorkspaceOptions
• type FindWorkspaceResult
  • func FindWorkspace(workingDir string, opts FindWorkspaceOptions) (*FindWorkspaceResult, error)

Constants

const (
	SpeakeasyFolder = ".speakeasy"
	GenFolder       = ".gen"
)

Functions

func FindWorkspaceTempDir

func FindWorkspaceTempDir(wd string, opts FindWorkspaceOptions) string

Types

type FS

type FS interface {
	fs.StatFS
}

type FindWorkspaceOptions

type FindWorkspaceOptions struct {
	FindFile     string // An optional file to find in the workspace
	AllowOutside bool   // Allow searching outside the workspace
	Recursive    bool   // Recursively search for the workspace in parent directories
	FS           FS     // An optional filesystem to use
}

type FindWorkspaceResult

type FindWorkspaceResult struct {
	Data []byte
	Path string
}

func FindWorkspace

func FindWorkspace(workingDir string, opts FindWorkspaceOptions) (*FindWorkspaceResult, error)