common

type DirHandler func(dir string) error

type Displayer interface {
	SetVerbose(bool)

	WroteDirectoriesInFile(wrote []string, file string, dir string)
}

type GoMod interface {
	Open(dir string) (GoModFile, error)
}

type GoModFile interface {
	File() *modfile.File
	DropReplace(packageName, packageVersion string) error
}

type GoWork interface {
	Read() (*modfile.WorkFile, error)
	Write(file *modfile.WorkFile) error
	Edit(func(*modfile.WorkFile) error) error

	Remove()
	Clean() error
	Init() error

	AddUse(dir string) error
	RemoveUse(dir string) error

	RelativeTo(dir string) (string, error)
}

type ReturnToDirMethod func() error

type RunWith interface {
	/* Runs the command with dir being the absolute path for every folder defined in a workspace */
	Absolute() error

	/* Runs the command with dir being the relative path for every folder defined in a workspace */
	Relative() error

	/* Runs the command with dir being the absolute path for every folder defined in the workspace's directory */
	Root() error
}

type Runtime interface {
	Execute(name string, args ...string) error
	DisplayExec(name string, args ...string)
	ExecuteInDir(dir, name string, args ...string) error
	ExecuteCapture(name string, args ...string) (out, errOut string, err error)
	ExecuteCaptureInDir(dir, name string, args ...string) (out, errOut string, err error)
	WriteFile(name string, data []byte, perm fs.FileMode) error
	RemoveAll(path string) error
	Remove(path string) error
	Chdir(dir string) (r ReturnToDirMethod, err error)
	RemoveIfExist(fileName string) (removed bool)

	// Exported CLI commands
	Bool(string) bool

	Dry() bool

	SetContext(ctx *cli.Context)
}

type VsFolder struct {
	Path string `json:"path"`
}

type VsWorkspace struct {
	Folders  []VsFolder             `json:"folders"`
	Settings map[string]interface{} `json:"settings"`
}

type WorkSpaceHandler func(vs *VsWorkspace) error

type Workspace interface {
	Stat() error
	Delete() error

	/* Defines a runWith for running commands asynchronously */
	ForEach(DirHandler) RunWith
	Loc() string
	Dir() string
	FileName() string

	Read() (VsWorkspace, error)
	Write(vs VsWorkspace) error
	Edit(WorkSpaceHandler) error

	New() error
	OpenWithCode() error

	AddUse(dir string) error
	RemoveUse(dir string) error

	List() ([]string, error)
	RelativeTo(dir string) (string, error)
}