config

package
v1.7.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 13, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Overview

Package config читает .hum1izer.yaml: настройки проекта рядом с кодом.

Index

Constants

View Source
const Name = ".hum1izer.yaml"

Name - имя файла настроек. Ищется от каталога проверки вверх до корня.

Variables

This section is empty.

Functions

func Compile

func Compile(glob string) (*regexp.Regexp, error)

Compile переводит glob в регулярку: ** через каталоги, * внутри одного сегмента. Паттерн без слэша сверяется ещё и с именем файла.

func KnownLang

func KnownLang(name string) bool

func LangOf

func LangOf(path string) string

LangOf возвращает язык по расширению файла, пустую строку для чужого файла.

func Langs

func Langs() []string

func Patch added in v1.7.0

func Patch(path string, kv map[string]any) error

Patch меняет значения в .hum1izer.yaml через yaml.Node: маршалинг структуры выбросил бы комментарии. Ключи - точечные пути, "comments.max_lines".

func SaveUser added in v1.7.0

func SaveUser(u User) (string, error)

func UserPath added in v1.7.0

func UserPath() (string, error)

UserPath - $XDG_CONFIG_HOME/hum1izer/config.yaml, иначе ~/.config/hum1izer. Тот же путь на всех системах: так его проще назвать в документации.

Types

type Comments

type Comments struct {
	MaxLines  *int  `yaml:"max_lines,omitempty"`
	MaxLine   *int  `yaml:"max_line,omitempty"`
	Commits   *int  `yaml:"commits,omitempty"`
	SkipTests *bool `yaml:"skip_tests,omitempty"`
}

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

func Find(dir string) (Config, error)

Find поднимается от dir вверх, пока не найдёт файл настроек или не упрётся в корень. Отсутствие файла не ошибка: возвращается пустая конфигурация.

func Load

func Load(path string) (Config, error)

func (Config) Allow

func (c Config) Allow(rule, category string) bool

Allow: пропускать ли находку с таким именем правила и категории.

func (Config) AllowedLangs

func (c Config) AllowedLangs() map[string]bool

AllowedLangs: nil означает все языки.

func (Config) Excludes

func (c Config) Excludes() ([]*regexp.Regexp, error)

Excludes - скомпилированные исключения проекта.

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 Languages

type Languages struct {
	Only   []string `yaml:"only,omitempty"`
	Ignore []string `yaml:"ignore,omitempty"`
}

type Rules

type Rules struct {
	Only    []string `yaml:"only,omitempty"`
	Disable []string `yaml:"disable,omitempty"`
}

Rules: only - белый список, пустой означает все. disable вычитается после. Имена берутся из отчёта: подходит и имя правила, и имя категории.

type User added in v1.7.0

type User struct {
	LLM LLM `yaml:"llm,omitempty"`
}

User - настройки человека, а не проекта: адрес API, ключ, модель. Ключу в репозитории не место, поэтому файл в домашнем каталоге и с правами 0600.

func LoadUser added in v1.7.0

func LoadUser() (User, error)

LoadUser: отсутствие файла не ошибка, это первый запуск.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL