project

Documentation

Index

• func Confirm(message, help string, force bool) bool
• func Copy(src, dst string) (int64, error)
• func Create(path string) (afero.File, error)
• func CreateAemInstallDir(instance objects.Instance) (string, error)
• func CreateBinDir() (string, error)
• func CreateDir(path string) (string, error)
• func CreateDirForPackage(aemPackage *objects.Package) (string, error)
• func CreateInstallDir(instance objects.Instance) (string, error)
• func CreateInstanceDir(instance objects.Instance) (string, error)
• func CreateInstancesDir() (string, error)
• func Exists(path string) bool
• func FilesystemError(err bool)
• func GetAemInstallDirLocation(instance objects.Instance) (string, error)
• func GetAppDirLocation(instance objects.Instance) (string, error)
• func GetBinDir() (string, error)
• func GetConfigFileLocation() (string, error)
• func GetDirForPackage(aemPackage *objects.Package) (string, error)
• func GetInstanceDirLocation(instance objects.Instance) (string, error)
• func GetInstancesDirLocation() (string, error)
• func GetJarFileLocation(jar *objects.AemJar) (string, error)
• func GetLicenseLocation(instance objects.Instance) (string, error)
• func GetLocationForPackage(aemPackage *objects.Package) (string, error)
• func GetLogDirLocation(instance objects.Instance) (string, error)
• func GetPidFileLocation(instance objects.Instance) (string, error)
• func GetRunDirLocation(instance objects.Instance) (string, error)
• func GetUnpackDirLocation() (string, error)
• func GetWorkDir() (string, error)
• func HomeDir() (string, error)
• func IsFile(path string) bool
• func Mock(ro bool) afero.Fs
• func Open(path string) (afero.File, error)
• func ReadDir(path string) ([]os.FileInfo, error)
• func Remove(path string) error
• func RemoveAll(path string) error
• func RemoveSlash(path string) string
• func Rename(source, destination string) error
• func WriteGitIgnoreFile() (string, error)
• func WriteTextFile(path, content string) (int, error)

Functions

func Confirm

func Confirm(message, help string, force bool) bool

Confirm ask user for confirmation.

func Copy

func Copy(src, dst string) (int64, error)

Copy file

func Create

func Create(path string) (afero.File, error)

Create file

func CreateAemInstallDir

func CreateAemInstallDir(instance objects.Instance) (string, error)

CreateAemInstallDir creates aem install dir

func CreateBinDir

func CreateBinDir() (string, error)

CreateBinDir Create bin dir

func CreateDir

func CreateDir(path string) (string, error)

CreateDir creates a dir for package struct

func CreateDirForPackage

func CreateDirForPackage(aemPackage *objects.Package) (string, error)

CreateDirForPackage creates a dir for package struct

func CreateInstallDir

func CreateInstallDir(instance objects.Instance) (string, error)

CreateInstallDir create the install dir

func CreateInstanceDir

func CreateInstanceDir(instance objects.Instance) (string, error)

CreateInstanceDir Create dir for instance

func CreateInstancesDir

func CreateInstancesDir() (string, error)

CreateInstancesDir creates instances dir for all instances to be created under

func Exists

func Exists(path string) bool

Exists tell if a file exists

func FilesystemError

func FilesystemError(err bool)

FilesystemError trigger filesystem error for unit testing

func GetAemInstallDirLocation

func GetAemInstallDirLocation(instance objects.Instance) (string, error)

GetAemInstallDirLocation gets AEM install dir for location

func GetAppDirLocation

func GetAppDirLocation(instance objects.Instance) (string, error)

GetAppDirLocation gets app dir for instance

func GetBinDir

func GetBinDir() (string, error)

GetBinDir get global project bin dir

func GetConfigFileLocation

func GetConfigFileLocation() (string, error)

GetConfigFileLocation get project config file location

func GetDirForPackage

func GetDirForPackage(aemPackage *objects.Package) (string, error)

GetDirForPackage get the path for the packages dir

func GetInstanceDirLocation

func GetInstanceDirLocation(instance objects.Instance) (string, error)

GetInstanceDirLocation Get's location for instance

func GetInstancesDirLocation

func GetInstancesDirLocation() (string, error)

GetInstancesDirLocation get location of instances dir

func GetJarFileLocation

func GetJarFileLocation(jar *objects.AemJar) (string, error)

GetJarFileLocation Get the location of the jar file

func GetLicenseLocation

func GetLicenseLocation(instance objects.Instance) (string, error)

GetLicenseLocation get license location for instance

func GetLocationForPackage

func GetLocationForPackage(aemPackage *objects.Package) (string, error)

GetLocationForPackage location for package

func GetLogDirLocation

func GetLogDirLocation(instance objects.Instance) (string, error)

GetLogDirLocation Get the log file location

func GetPidFileLocation

func GetPidFileLocation(instance objects.Instance) (string, error)

GetPidFileLocation gets path of pidfile

func GetRunDirLocation

func GetRunDirLocation(instance objects.Instance) (string, error)

GetRunDirLocation Get location of the run dir of aem

func GetUnpackDirLocation

func GetUnpackDirLocation() (string, error)

GetUnpackDirLocation get unpack dir location

func GetWorkDir

func GetWorkDir() (string, error)

GetWorkDir get workdir for project

func HomeDir

func HomeDir() (string, error)

HomeDir returns user home's dir

func IsFile

func IsFile(path string) bool

IsFile tells you if it is a file

func Mock

func Mock(ro bool) afero.Fs

Mock replace fs with memFS for mocking and testing

func Open

func Open(path string) (afero.File, error)

Open opens a file, returning it or an error, if any happens.

func ReadDir

func ReadDir(path string) ([]os.FileInfo, error)

ReadDir Read dir from filesystem

func Remove

func Remove(path string) error

Remove removes a file identified by name, returning an error, if any happens.

func RemoveAll

func RemoveAll(path string) error

RemoveAll removes a directory path and any children it contains. It does not fail if the path does not exist (return nil).

func RemoveSlash

func RemoveSlash(path string) string

RemoveSlash Removes slash from end of path

func Rename

func Rename(source, destination string) error

Rename file

func WriteGitIgnoreFile

func WriteGitIgnoreFile() (string, error)

WriteGitIgnoreFile Write ignore file to disk

func WriteTextFile

func WriteTextFile(path, content string) (int, error)

WriteTextFile write textfile to disk