Documentation
¶
Overview ¶
Package config читает .hum1izer.yaml: настройки проекта рядом с кодом.
Index ¶
- Constants
- func Compile(glob string) (*regexp.Regexp, error)
- func KnownLang(name string) bool
- func LangOf(path string) string
- func Langs() []string
- func Patch(path string, kv map[string]any) error
- func SaveUser(u User) (string, error)
- func UserPath() (string, error)
- type Comments
- type Config
- type LLM
- type Languages
- type Rules
- type User
Constants ¶
const Name = ".hum1izer.yaml"
Name - имя файла настроек. Ищется от каталога проверки вверх до корня.
Variables ¶
This section is empty.
Functions ¶
func Compile ¶
Compile переводит glob в регулярку: ** через каталоги, * внутри одного сегмента. Паттерн без слэша сверяется ещё и с именем файла.
Types ¶
type Config ¶
type Config struct {
Version int `yaml:"version"`
Genre string `yaml:"genre,omitempty"`
RulesFile string `yaml:"rules_file,omitempty"`
Comments Comments `yaml:"comments"`
Languages Languages `yaml:"languages"`
Exclude []string `yaml:"exclude,omitempty"`
Baseline string `yaml:"baseline,omitempty"`
Rules Rules `yaml:"rules"`
LLM LLM `yaml:"llm,omitempty"`
Path string `yaml:"-"` // откуда прочитан, пусто если настроек нет
}
func Find ¶
Find поднимается от dir вверх, пока не найдёт файл настроек или не упрётся в корень. Отсутствие файла не ошибка: возвращается пустая конфигурация.
func (Config) AllowedLangs ¶
AllowedLangs: nil означает все языки.
type LLM ¶ added in v1.7.0
type LLM struct {
BaseURL string `yaml:"base_url,omitempty"`
Model string `yaml:"model,omitempty"`
Key string `yaml:"key,omitempty"`
}
LLM - куда ходить за переписыванием комментария. Годится любой OpenAI-совместимый адрес; ключ лучше держать в OPENAI_API_KEY, а не в файле.
type Rules ¶
type Rules struct {
Only []string `yaml:"only,omitempty"`
Disable []string `yaml:"disable,omitempty"`
}
Rules: only - белый список, пустой означает все. disable вычитается после. Имена берутся из отчёта: подходит и имя правила, и имя категории.