mod

Documentation

Index

• Constants
• Variables
• func AppendVersion(path, ver string) string
• func ExtractVersion(path string) (newpath, ver string)
• func SyslModInit(modName string) error
• type DependencyManager
• type Fs
  • func NewFs(fs afero.Fs, root string) *Fs
  • func (fs *Fs) Name() string
  • func (fs *Fs) Open(name string) (afero.File, error)
  • func (fs *Fs) OpenFile(name string, flag int, perm os.FileMode) (afero.File, error)
  • func (fs *Fs) OpenWithModule(name string) (afero.File, *Module, error)
• type Module
  • func Retrieve(name string, ver string) (*Module, error)
• type Modules
  • func (m *Modules) Add(v *Module)
  • func (m *Modules) Len() int

Constants

const (
	SyslModulesOff    = "off"
	SyslModulesOn     = "on"
	SyslModulesGitHub = "github"
	SyslModulesGoMod  = "gomod"
	MasterBranch      = "master"
)

Variables

var GitHubMode = os.Getenv("SYSL_MODULES") == SyslModulesGitHub

var SyslModules = os.Getenv("SYSL_MODULES") != SyslModulesOff

Functions

func AppendVersion

func AppendVersion(path, ver string) string

func ExtractVersion

func ExtractVersion(path string) (newpath, ver string)

func SyslModInit

func SyslModInit(modName string) error

Assumes that a go module and a sysl module is mutually exclusive. This function makes the assumption that the CWD is not a go module since we hijack this command and use go.mod and possibly go.sum to determine whether the current folder/project is a sysl module

Types

type DependencyManager

type DependencyManager interface {
	// Download external dependency to local directory
	Get(filename, ver string, m *Modules) (*Module, error)
	// Find dependency in m *Modules
	Find(filename, ver string, m *Modules) *Module
	// Load local cache into m *Modules
	Load(m *Modules) error
}

type Fs

type Fs struct {
	afero.Fs
	// contains filtered or unexported fields
}

func NewFs

func NewFs(fs afero.Fs, root string) *Fs

func (*Fs) Name

func (fs *Fs) Name() string

func (*Fs) Open

func (fs *Fs) Open(name string) (afero.File, error)

func (*Fs) OpenFile

func (fs *Fs) OpenFile(name string, flag int, perm os.FileMode) (afero.File, error)

func (*Fs) OpenWithModule

func (fs *Fs) OpenWithModule(name string) (afero.File, *Module, error)

type Module

type Module struct {
	// The name of module joined by forward slash(/). e.g. "github.com/anz-bank/sysl"
	Name string
	// The absolute path to the module.
	// e.g. "/Users/foo/go/pkg/mod/github.com/anz-bank/sysl@v1.1.0" on Linux and macOS
	//      "C:\Users\foo\go\pkg\mod\github.com\anz-bank\sysl@v1.1.0" on Windows
	Dir string
	// The version of the module. e.g. "v1.1.0"
	Version string
}

func Retrieve

func Retrieve(name string, ver string) (*Module, error)

type Modules

type Modules []*Module

func (*Modules) Add

func (m *Modules) Add(v *Module)

func (*Modules) Len

func (m *Modules) Len() int