aspell

type Aspell struct {
	RemoteFile          RemoteFile       `yaml:"remote_file"`
	Mode                mode             `yaml:"mode"`
	HelpText            string           `yaml:"-"`
	IdentifierScope     identifierScope  `yaml:"identifier_scope"`
	Dictionaries        DictionaryConfig `yaml:"dictionaries"`
	IgnoreFiles         []string         `yaml:"ignore_files"`
	AllowedWords        []string         `yaml:"allowed"`
	ExtraDicts          []string         `yaml:"-"` // paths to downloaded .rws files for aspell --extra-dicts
	MinLength           int              `yaml:"min_length"`
	NoIgnoreIdentifiers bool             `yaml:"no_ignore_identifiers"`
}

type DictionaryConfig struct {
	// GitHub repo directories to fetch all dictionary files from.
	// Supports URLs like https://github.com/owner/repo/tree/branch/path/to/dir
	GitHub []GitHubDictionary `yaml:"github"`
	// GitLab repo directories to fetch all dictionary files from.
	// Supports URLs like https://gitlab.com/group/project/-/tree/branch/path/to/dir
	GitLab []GitLabDictionary `yaml:"gitlab"`
	// Direct URLs to individual dictionary files (.txt or .rws).
	URLs []string `yaml:"urls"`
}

type GitHubDictionary struct {
	// URL to a GitHub directory, e.g. https://github.com/haproxytech/check-commit/tree/main/aspell/dictionaries
	URL string `yaml:"url"`
	// Optional environment variable name containing a GitHub token for private repos.
	TokenEnv string `yaml:"token_env"`
}

type GitLabDictionary struct {
	// URL to a GitLab directory, e.g. https://gitlab.com/group/project/-/tree/main/path/to/dir
	// Also supports self-hosted instances like https://gitlab.example.com/group/project/-/tree/main/path
	URL string `yaml:"url"`
	// Optional environment variable name containing a GitLab private token.
	TokenEnv string `yaml:"token_env"`
}

type RemoteFile struct {
	URL             string `yaml:"url"`
	URLEnv          string `yaml:"url_env"`
	HeaderFromENV   string `yaml:"header_from_env"`
	PrivateTokenENV string `yaml:"private_token_env"`
	AllowedItemsKey string `yaml:"allowed_items_key"`
}