cuemod

Documentation

Index

• Constants
• func BuildConfig(optionFns ...OptionFunc) *load.Config
• func InjectContext(c context.Context, cc *Context) context.Context
• func WithOpts(ctx context.Context, fns ...OptFn) context.Context
• type Context
  • func ContextFor(root string) *Context
  • func FromContext(c context.Context) *Context
  • func (r *Context) Build(ctx context.Context, files []string, options ...OptionFunc) *build.Instance
  • func (r *Context) BuildConfig(ctx context.Context, options ...OptionFunc) *cueload.Config
  • func (r *Context) Cleanup() error
  • func (r *Context) CompletePath(p string) string
  • func (r *Context) CueModRoot() string
  • func (r *Context) Get(ctx context.Context, i string) error
  • func (r *Context) ListCue(fromPath string) ([]string, error)
  • func (r *Context) Resolve(ctx context.Context, importPath string, importedAt string) (string, error)
• type ImportFunc
• type Instance
  • func Build(inputs []string, optionFns ...OptionFunc) *Instance
  • func BuildInstances(c *load.Config, inputs []string) []*Instance
• type Mod
  • func (m *Mod) FixVersion(repo string, version string) string
  • func (m *Mod) LoadInfo(ctx context.Context) (bool, error)
  • func (m *Mod) ModuleRoot() string
  • func (m *Mod) Resolved() bool
  • func (m *Mod) SetRequire(module string, modVersion modfile.ModVersion, indirect bool)
  • func (m *Mod) String() string
• type OptFn
  • func OptImport(b string) OptFn
  • func OptUpgrade(b bool) OptFn
  • func OptVerbose(v bool) OptFn
• type OptionFunc
  • func OptImportFunc(importFunc ImportFunc) OptionFunc
  • func OptOverlay(overlay map[string]load.Source) OptionFunc
  • func OptRoot(dir string) OptionFunc
• type Opts
  • func OptsFromContext(ctx context.Context) Opts
• type Path
  • func PathFor(mod *Mod, importPath string) *Path
  • func (i *Path) ImportPath() string
  • func (i Path) ImportPathRoot() string
  • func (i Path) ImportPathRootDir() string
  • func (i *Path) ResolvedImportPath() string
  • func (i Path) String() string
  • func (i *Path) SymlinkOrImport(ctx context.Context, root string) error
  • func (i Path) WithReplace(from string, replaceTarget modfile.ReplaceTarget) *Path
• type ReplaceRule

Constants

const ModSumFilename = "cue.mod/module.sum"

Functions

func BuildConfig

func BuildConfig(optionFns ...OptionFunc) *load.Config

func InjectContext

func InjectContext(c context.Context, cc *Context) context.Context

func WithOpts

func WithOpts(ctx context.Context, fns ...OptFn) context.Context

Types

type Context

type Context struct {
	Mod *Mod
	// contains filtered or unexported fields
}

func ContextFor

func ContextFor(root string) *Context

func FromContext

func FromContext(c context.Context) *Context

func (*Context) Build

func (r *Context) Build(ctx context.Context, files []string, options ...OptionFunc) *build.Instance

func (*Context) BuildConfig

func (r *Context) BuildConfig(ctx context.Context, options ...OptionFunc) *cueload.Config

func (*Context) Cleanup

func (r *Context) Cleanup() error

func (*Context) CompletePath

func (r *Context) CompletePath(p string) string

func (*Context) CueModRoot

func (r *Context) CueModRoot() string

func (*Context) Get

func (r *Context) Get(ctx context.Context, i string) error

func (*Context) ListCue

func (r *Context) ListCue(fromPath string) ([]string, error)

func (*Context) Resolve

func (r *Context) Resolve(ctx context.Context, importPath string, importedAt string) (string, error)

type ImportFunc

type ImportFunc = func(importPath string, importedAt string) (resolvedDir string, err error)

type Instance

type Instance = build.Instance

func Build

func Build(inputs []string, optionFns ...OptionFunc) *Instance

func BuildInstances

func BuildInstances(c *load.Config, inputs []string) []*Instance

type Mod

type Mod struct {
	modfile.ModFile
	modfile.ModVersion

	// Repo where module in vcs root
	Repo string
	// SubPath mod local sub path
	SubPath string
	// Dir module absolute dir
	Dir string
	// Root means this import path is mod root
	Root bool
	// Sum repo absolute dir sum
	Sum string
}

func (*Mod) FixVersion

func (m *Mod) FixVersion(repo string, version string) string

func (*Mod) LoadInfo

func (m *Mod) LoadInfo(ctx context.Context) (bool, error)

func (*Mod) ModuleRoot

func (m *Mod) ModuleRoot() string

func (*Mod) Resolved

func (m *Mod) Resolved() bool

func (*Mod) SetRequire

func (m *Mod) SetRequire(module string, modVersion modfile.ModVersion, indirect bool)

func (*Mod) String

func (m *Mod) String() string

type OptFn

type OptFn = func(o *Opts)

func OptImport

func OptImport(b string) OptFn

func OptUpgrade

func OptUpgrade(b bool) OptFn

func OptVerbose

func OptVerbose(v bool) OptFn

type OptionFunc

type OptionFunc = func(c *load.Config)

func OptImportFunc

func OptImportFunc(importFunc ImportFunc) OptionFunc

func OptOverlay

func OptOverlay(overlay map[string]load.Source) OptionFunc

func OptRoot

func OptRoot(dir string) OptionFunc

type Opts

type Opts struct {
	Upgrade bool
	Verbose bool
	Import  string
}

func OptsFromContext

func OptsFromContext(ctx context.Context) Opts

type Path

type Path struct {
	Mod
	SubPath string
	Replace *ReplaceRule
}

func PathFor

func PathFor(mod *Mod, importPath string) *Path

func (*Path) ImportPath

func (i *Path) ImportPath() string

func (Path) ImportPathRoot

func (i Path) ImportPathRoot() string

func (Path) ImportPathRootDir

func (i Path) ImportPathRootDir() string

func (*Path) ResolvedImportPath

func (i *Path) ResolvedImportPath() string

func (Path) String

func (i Path) String() string

func (*Path) SymlinkOrImport

func (i *Path) SymlinkOrImport(ctx context.Context, root string) error

func (Path) WithReplace

func (i Path) WithReplace(from string, replaceTarget modfile.ReplaceTarget) *Path

type ReplaceRule

type ReplaceRule struct {
	From string
	modfile.ReplaceTarget
}