changeloggenerator

type ChangelogGenerator interface {
	Name() string
	Description() string
	Version() string

	// GenerateForVersion generates changelog for a specific version bump.
	GenerateForVersion(version, previousVersion, bumpType string) error

	// IsEnabled returns whether the plugin is enabled.
	IsEnabled() bool

	// GetConfig returns the plugin configuration.
	GetConfig() *Config
}

type ChangelogGeneratorPlugin struct {
	// contains filtered or unexported fields
}

type CommitInfo struct {
	Hash        string
	ShortHash   string
	Subject     string
	Author      string
	AuthorEmail string
}

type Config struct {
	// Enabled controls whether the plugin is active.
	Enabled bool

	// Mode determines output style: "versioned", "unified", or "both".
	Mode string

	// Format determines the changelog format: "grouped" or "keepachangelog".
	// "grouped" (default): Current behavior with custom group labels
	// "keepachangelog": Keep a Changelog specification format
	Format string

	// ChangesDir is the directory for version-specific changelog files.
	ChangesDir string

	// ChangelogPath is the path to the unified changelog file.
	ChangelogPath string

	// HeaderTemplate is the path to a custom header template file.
	HeaderTemplate string

	// Repository contains git repository settings for link generation.
	Repository *RepositoryConfig

	// Groups defines commit grouping rules.
	Groups []GroupConfig

	// ExcludePatterns lists regex patterns for commits to exclude.
	ExcludePatterns []string

	// IncludeNonConventional includes non-conventional commits in "Other Changes" section.
	// When false (default), these commits are skipped with a warning.
	IncludeNonConventional bool

	// UseDefaultIcons enables default icons for commit groups and contributors.
	// When true, predefined icons are applied to default groups and the contributors section.
	// User-defined GroupIcons or Contributors.Icon can override specific defaults.
	UseDefaultIcons bool

	// GroupIcons maps default group labels to icons (used when Groups is empty).
	GroupIcons map[string]string

	// BreakingChangesIcon is the icon for the breaking changes section header.
	// This is used by formatters that have a dedicated breaking changes section.
	BreakingChangesIcon string

	// Contributors configures the contributors section.
	Contributors *ContributorsConfig

	// MergeAfter controls when versioned changelog files are merged into the unified changelog.
	// Values: "immediate" (merge right after generation), "manual" (no auto-merge, default),
	// "prompt" (interactive confirmation, auto-skips in CI/non-interactive environments).
	MergeAfter string
}

type Contributor struct {
	Name     string
	Username string
	Email    string
	Host     string // The git host for URL generation
}

type ContributorsConfig struct {
	Enabled               bool
	Format                string
	Icon                  string
	ShowNewContributors   bool
	NewContributorsFormat string
	NewContributorsIcon   string
}

type Formatter interface {
	// FormatChangelog generates the changelog content for a version.
	// It receives the version information, grouped commits, and remote info
	// and returns the formatted markdown content.
	FormatChangelog(
		version string,
		previousVersion string,
		grouped map[string][]*GroupedCommit,
		sortedKeys []string,
		remote *RemoteInfo,
	) string
}

type GenerateResult struct {
	Content                string
	SkippedNonConventional []*ParsedCommit
}

type Generator struct {
	// contains filtered or unexported fields
}

type GitHubFormatter struct {
	// contains filtered or unexported fields
}

type GroupCommitsResult struct {
	Grouped                map[string][]*GroupedCommit
	SkippedNonConventional []*ParsedCommit
}

type GroupConfig struct {
	Pattern string
	Label   string
	Icon    string
	Order   int
}

type GroupedCommit struct {
	*ParsedCommit
	GroupLabel string
	GroupIcon  string
	GroupOrder int
}

type GroupedFormatter struct {
	// contains filtered or unexported fields
}

type KeepAChangelogFormatter struct {
	// contains filtered or unexported fields
}

type MinimalFormatter struct {
	// contains filtered or unexported fields
}

type NewContributor struct {
	Contributor
	FirstCommit CommitInfo // The commit that introduced this contributor
	PRNumber    string     // PR number if available (extracted from commit message)
}

type ParsedCommit struct {
	CommitInfo
	Type        string // feat, fix, docs, etc.
	Scope       string // Optional scope in parentheses
	Description string // The commit description after the colon
	Breaking    bool   // Has breaking change indicator (! or BREAKING CHANGE footer)
	PRNumber    string // Extracted PR/MR number if present
}

type RemoteInfo struct {
	Provider string // github, gitlab, codeberg, gitea, bitbucket, custom
	Host     string // e.g., github.com, gitlab.com, codeberg.org
	Owner    string
	Repo     string
}

type RepositoryConfig struct {
	// Provider is the git hosting provider: github, gitlab, codeberg, gitea, bitbucket, custom.
	Provider string
	// Host is the git server hostname (e.g., "github.com", "gitlab.com").
	Host string
	// Owner is the repository owner/organization.
	Owner string
	// Repo is the repository name.
	Repo string
	// AutoDetect enables automatic detection from git remote.
	AutoDetect bool
}