config

type BranchConfig struct {
	// The template structure of your branch names.
	// Example pattern:
	// {{.Type}}/{{.Author}}-{{.Issue}}-{{.Description}}
	//
	// Example branch names:
	// - feature/PROJ-1234-add-foo
	// - chore-PROJ-1234-update-deps
	// - name-fix-PROJ-1234-wrong-thing
	// - bug-name-PROJ-1234-fix-thing
	// - PROJ-1234-some-new-features
	Template string `yaml:"template"`

	// The pattern that should be used to validate the branch name and extract variables.
	//
	// Example: {{.Type}}\/({{.Issue}}-)?{{.Description}}
	// Where the variables are defined in the `variable_patterns` field.
	Pattern string `yaml:"pattern"`

	// The patterns that should be fetched from the branch name.
	//
	// Example:
	//   "Issue": "([A-Z]+\\-[0-9]+)"
	//   "Author": "([a-z0-9]+)"
	//   "Description": "(.*)"
	//   "Type": "(fix|feat|chore|docs|refactor|test|style|build|ci|perf|revert)"
	VariablePatterns map[string]string `yaml:"variable_patterns"`

	TokenSeparators []string `yaml:"token_separators"`

	MaxLength int `yaml:"max_length"`
}

type CheckoutNewConfig struct {
	Jira   CheckoutNewJiraConfig   `yaml:"jira"`
	GitHub CheckoutNewGitHubConfig `yaml:"github"`
}

type CheckoutNewGitHubConfig struct {
	IssueListFlags []string `yaml:"issue_list_flags"`
}

type CheckoutNewJiraConfig struct {
	IssueJQL string `yaml:"issue_jql"`
	Project  string `yaml:"project"`
}

type IssueConfig struct {
	Provider string   `yaml:"provider"`
	Types    []string `yaml:"types"`
}

type JiraConfig struct {
	Endpoint string `yaml:"endpoint,omitempty"`
	User     string `yaml:"user,omitempty"`
	Token    string `yaml:"token,omitempty"`
}

type LinearConfig struct {
	APIKey string `yaml:"api_key"`
}

type PullRequestConfig struct {
	Title                 string   `yaml:"title"`
	IgnoreCommitsPatterns []string `yaml:"ignore_commits_patterns"`
	AnswerChecklist       *bool    `yaml:"answer_checklist"`
	PushToRemote          *bool    `yaml:"push_to_remote"`

	Body string `yaml:"-"`
}

type RepositoryConfig struct {
	Branch                  BranchConfig      `yaml:"branch"`
	PR                      PullRequestConfig `yaml:"pr"`
	Issue                   IssueConfig       `yaml:"issue"`
	CheckoutNew             CheckoutNewConfig `yaml:"checkout_new"`
	PullRequestTemplatePath string            `yaml:"pull_request_template_path"`
}

type SetupConfig struct {
	JiraConfig   *JiraConfig   `yaml:"jira,omitempty"`
	LinearConfig *LinearConfig `yaml:"linear,omitempty"`

	// RepositoryConfig a global config for all repositories.
	// Per-repository config properties will override this one.
	RepositoryConfig *RepositoryConfig `yaml:"global,omitempty"`
}