utils

type AldevConfig struct {
	AppName   string // the name of the app - beware: the key has to be "appname" in the YAML file
	Languages string // the languages available for this app, seperated by a comma - for example: en,fr,it,de,zh,es
	Lib       *struct {
		SrcDir  string // where the library source code can be found
		Config  string // the path to the config file for the API, from the API's folder
		Install string // command that should be run to install stuff, like needed dependencies, etc.
		Develop string // command that should be run to allow for continuously developping & building the library
		BinDir  string // the directory where to find the library's compiled binary, as seen from the library source folder (srcdir)
		// contains filtered or unexported fields
	}
	API *struct {
		SrcDir  string // where the API's Goald-based code should be found
		Config  string // the path to the config file for the API, from the API's folder
		Port    int    // the port used to expose the whole load-balanced API service
		I18n    *I18nConfig
		DataDir string // where to find bootstraping data to run the app
		BinDir  string // the directory where to find the API's compiled binary, as seen from the API source folder (srcdir)
		// contains filtered or unexported fields
	}
	// APIOnly bool      // if true, then no web app is handled
	Web *struct {
		SrcDir  string // where the Web app's GoaldR-based code should be found
		Port    int    // the port used to expose the app's frontend
		EnvVars []*struct {
			Name  string // the variable name; must start with "WEB_"
			Desc  string // a description for the
			Value string // the value we're using for the local dev environment
		}
	}
	Native *struct {
		SrcDir  string      // where the Native app's GoaldN-based code should be found
		I18n    *I18nConfig //
		DataDir string      // where to find bootstraping data to run the app
	}
	Vendors   []*VendorConfig // external projects to vendor into our project
	Deploying *struct {
		Dir string // where all the deploying config should be
	}
	CodeSwaps []*CodeSwapsConfig // Automatically, temporarily swapping bits of code
	Jobs      []*JobConfig       // Jobs to run
}

type AldevContext interface {
	CancelableContext
	GetLoopCtx() CancelableContext
	RestartLoop()
}

type AldevTask func(ctx CancelableContext)

type CancelableContext interface {
	context.Context
	WithExecDir(...string) CancelableContext

	WithStdOutWriter(io.Writer) CancelableContext

	WithStdErrWriter(io.Writer) CancelableContext

	// WithErrLogFn(errLogFn) CancelableContext
	// getErrLogFn() errLogFn
	WithEnvVars(...string) CancelableContext

	WithReRun() CancelableContext

	WithAllowFailure(bool) CancelableContext

	CancelAll()
	NewChildContext() CancelableContext
	// contains filtered or unexported methods
}

type CmdConfig struct {
	Exec   string // the command to run
	From   string // the path from which to run the command
	FailOK bool   // if true, then the command is allowed to fail
}

type CodeSwapsConfig struct {
	From string   // the path from which to look for swaps; "." for the current project, "../../dependency" to swap in another lib
	For  []string // the file paths for which to apply the same swaps; can be provided as a glob, e.g. "./src/**/*.ts?",
	Do   []*struct {
		Replace string // the substring to look for and replace
		With    string // the replacement
		EOFCom  bool   // should the added comment (HOTSWAPPED) be at the end of the line (// ...) rather than inline (/* ... */) ?
	}
}

type I18nConfig struct {
	Links   []string // the link to download the translations from; each new file can override previous translations
	KeySize int      // the max size of the key in the translation UID namespace.key
	Folder  string   // the path of the file where to write the downloaded translations
}

type JobConfig struct {
	Description string       // a short description of the job
	Cmds        []*CmdConfig // a list of commands to run
}

type VendorConfig struct {
	Repo    string // the repo of the external project
	Branch  string // the branch to use; if provided, then the version is ignored
	Version string // the maximal version (tag) to fetch; can also be the "latest"
	From    string // the path inside the repo to copy; if void, then all the repo is copied
	To      string // the place where to paste the copied cod
}