modules

type Client struct {

	// Set when Go modules are initialized in the current repo, that is:
	// a go.mod file exists.
	GoModulesFilename string
	// contains filtered or unexported fields
}

type ClientConfig struct {
	// Fs to get the source
	Fs afero.Fs

	// If set, it will be run before we do any duplicate checks for modules
	// etc.
	// It must be set in our case, for default project structure
	HookBeforeFinalize func(m *ModulesConfig) error

	// Absolute path to the project dir.
	WorkingDir string

	// Absolute path to the project's themes dir.
	ThemesDir string

	// Read from config file and transferred
	ModuleConfig Config
}

type Config struct {
	Mounts  []Mount
	Imports []Import

	// Meta info about this module (license information etc.).
	Params map[string]any
}

type Import struct {
	Path string // Module path

	IgnoreConfig  bool // Ignore any config in config.toml (will still follow imports).
	IgnoreImports bool // Do not follow any configured imports.
	NoMounts      bool // Do not mount any folder in this import.
	NoVendor      bool // Never vendor this import (only allowed in main project).
	Disable       bool // Turn off this module.
	Mounts        []Mount
	// contains filtered or unexported fields
}

type Module interface {

	// Config The decoded module config and mounts.
	Config() Config

	// Dir Directory holding files for this module.
	Dir() string

	// IsGoMod Returns whether this is a Go Module.
	IsGoMod() bool

	// Path Returns the path to this module.
	// This will either be the module path, e.g. "github.com/gohugoio/myshortcodes",
	// or the path below your /theme folder, e.g. "mytheme".
	Path() string

	// Owner In the dependency tree, this is the first module that defines this module
	// as a dependency.
	Owner() Module

	// Mounts Any directory remappings.
	Mounts() []Mount
}

type Modules []Module

type ModulesConfig struct {
	// All modules, including any disabled.
	AllModules Modules

	// All active modules.
	ActiveModules Modules

	// Set if this is a Go modules enabled project.
	GoModulesFilename string
}

type Mount struct {
	Source string // relative path in source repo, e.g. "scss"
	Target string // relative target path, e.g. "assets/bootstrap/scss"

	Lang string // any language code associated with this mount.
}