linker

type Deps struct {
	// EnsureFPMQuadlet builds a PHP version's image and unit.
	EnsureFPMQuadlet func(version string) error
	// ReconcileRuntimeQuadlets clears a per-site FrankenPHP or custom-FPM unit
	// the site no longer uses.
	ReconcileRuntimeQuadlets func(site config.Site)
	// StartHostProxyWorker supervises a host-proxy site's dev command.
	StartHostProxyWorker func(site config.Site, proxy *config.ProxyConfig)
	// SyncIDEDataSource points a JetBrains project at the site's database and
	// reports whether it wrote anything.
	SyncIDEDataSource func(siteRoot string) bool
}

type Mode string

type NopReporter struct{}

type Plan struct {
	// Dir is the directory being linked, as given.
	Dir string
	// Site is the registration that will be written.
	Site config.Site
	// Mode is how Site will be served.
	Mode Mode
	// Skip is set when the directory will not be registered at all, and
	// SkipDetail explains it in words the caller can print.
	Skip       Skip
	SkipDetail string
	// WorktreeParent and WorktreeBranch are set alongside SkipWorktree: the
	// site that owns this checkout, and the branch it holds.
	WorktreeParent *config.Site
	WorktreeBranch string
	// Project is the parsed .lerd.yaml, or nil when the project has none.
	Project *config.ProjectConfig
	// DroppedDomains lists domains another site already owns, which were
	// filtered out of Site.Domains.
	DroppedDomains []string
	// PHPSuggestion names a PHP version that suits the framework better than
	// the one Site carries. Empty when the chosen version is already the best
	// installed one, or when the policy forbids building images.
	PHPSuggestion string
	// PHPMin and PHPMax are the framework's supported range, for the message
	// that accompanies a clamped version. Both empty when unconstrained.
	PHPMin, PHPMax string
	// FrameworkLabel names the framework in user-facing messages, and is
	// "unknown (public: <dir>)" when detection found none.
	FrameworkLabel string
	// FrankenPHPDeclined records that the project asked for FrankenPHP but no
	// image exists for its PHP version, so the site falls back to FPM.
	FrankenPHPDeclined bool
	// ProxyCommand is the host dev-server command awaiting consent, empty when
	// the site runs none.
	ProxyCommand string
}

type Policy struct {
	// Name overrides the site name and primary domain. Empty derives both from
	// the directory name.
	Name string
	// AssumeYes records consent given outside a prompt, such as `lerd link
	// --yes` or the click that started a link from the web UI.
	AssumeYes bool
	// Prompt, when non-nil, may ask the user to resolve a decision. Nil means
	// no question can be asked, whether or not a terminal is attached.
	Prompt Prompter
	// ProjectWrites allows writing into the project directory: the .php-version
	// and .node-version pins, and the .lerd.yaml domain and framework writeback.
	ProjectWrites bool
	// Services allows installing and starting the services the project declares
	// and the ones its framework requires.
	Services bool
	// Certs allows the site to be registered as secured, which issues a
	// certificate for it.
	Certs bool
	// RepoCommands allows running commands the repository authored: a
	// host-proxy dev server and inline service containers. Consent for these
	// still goes through the usual gate; this only says the caller is a context
	// where running them is on the table at all.
	RepoCommands bool
	// ImageBuild allows building or pulling a PHP image the host does not have.
	ImageBuild bool
	// SkipRegistered stops the link when the directory is already a registered
	// site, rather than re-linking it.
	SkipRegistered bool
	// DeferPublish leaves the reloads that publish a link — systemd, the quadlet
	// rewrite, the container hosts file and nginx — to the caller, so a batch of
	// links does that work once at the end instead of once per project.
	DeferPublish bool
}

type Prompter interface {
	// Confirm asks a yes/no question and reports the answer.
	Confirm(question string, defaultYes bool) bool
	// Choose asks the user to pick one of options and returns its index.
	Choose(title string, options []string) (int, error)
}

type Reporter interface {
	// Step announces work that is starting and returns the handle that closes it.
	Step(label string) Step
	// Line reports something worth showing that is not a step.
	Line(msg string)
	// Warn reports a problem that did not stop the link.
	Warn(format string, a ...any)
	// Val styles a value inside a message, so the linker can compose detail
	// strings without knowing how the caller renders them.
	Val(s string) string
}

type Result struct {
	Plan *Plan
	// Site is the registration as written, which can differ from the plan's
	// when a newly installed PHP version was accepted.
	Site config.Site
	// WroteIDEDataSource records that a JetBrains data source was written.
	WroteIDEDataSource bool
}

type Skip string

type Step interface {
	OK(detail string)
	Fail(err error)
}

type TextReporter struct{ W io.Writer }