Documentation
¶
Index ¶
Constants ¶
const ( StructCategory = "Структура комментария" CommitCategory = "Форма коммита" )
Категории структурных проверок: по ним их можно отключить целиком.
Variables ¶
This section is empty.
Functions ¶
func Ignored ¶ added in v1.7.0
Ignored - блоки, которые проверка не смотрит: лицензия, прагма компилятора, пометка hum1izer:keep. Калибровка должна пропускать их так же, иначе шапки лицензий задерут предел длины.
func Shape ¶ added in v1.7.0
Shape - форма блока: сколько в нём строк прозы и какая строка самая длинная. По ним калибруются пределы под конкретный репозиторий.
func SortFindings ¶
func SortFindings(f []Finding)
SortFindings: по файлу, внутри файла по строке. Порядок стабилен между запусками, иначе diff отчётов бесполезен.
func SortItems ¶
func SortItems(items []Item)
SortItems: сначала самые грязные блоки, чтобы --limit брал их первыми.
Types ¶
type CodeSets ¶
CodeSets - наборы правил для кода: язык выбирается по самому комментарию, code применяется всегда.
type Comment ¶
type Comment struct {
File string `json:"file"`
Start int `json:"start"`
End int `json:"end"`
Lines int `json:"lines"`
Text string `json:"text"`
Raw string `json:"raw"` // исходные строки как есть, вместе с // и /* */
Lang string `json:"lang"` // go, ts, svelte, swift, git
Next string `json:"-"` // первая строка кода после блока, для проверки пересказа
Doc bool `json:"-"` // /** */, /// или /// - документирующий комментарий
SO int `json:"-"` // смещение начала блока в байтах
EO int `json:"-"` // смещение конца блока в байтах
}
Comment - блок комментария или текст коммита: то, что мы проверяем как прозу.
func ExtractComments ¶
ExtractComments достаёт блоки комментариев из файла. Для Go берём go/parser, для остальных - посимвольный сканер: он знает про строки и шаблоны, поэтому "//" внутри литерала за комментарий не считает.
func GitCommits ¶
GitCommits читает последние limit коммитов. Каждый становится Comment с File вида "commit a1b2c3d" - дальше он проверяется как обычная проза.
type Filter ¶
type Filter struct {
SkipTests bool
Langs map[string]bool // nil - все языки
Exclude []*regexp.Regexp
}
Filter - что из дерева брать. Пустой Filter означает все поддерживаемые языки.
type Finding ¶
type Finding struct {
File string `json:"file"`
Category string `json:"category,omitempty"`
Line int `json:"line"`
Rule string `json:"rule"`
Fix string `json:"fix,omitempty"`
Sample string `json:"sample,omitempty"`
Lift float64 `json:"lift,omitempty"`
Hard bool `json:"hard"`
}
Finding - одна находка в комментарии или коммите, с абсолютным номером строки.
type Item ¶
type Item struct {
ID string `json:"id"`
Hash string `json:"hash"`
File string `json:"file"`
Start int `json:"start"`
End int `json:"end"`
Lang string `json:"lang"`
Kind string `json:"kind"`
Score int `json:"score"`
Raw string `json:"raw"`
Findings []ItemFinding `json:"findings"`
}
Item - блок для агента. Правка идёт по Raw точным совпадением: номера строк после первой же правки уезжают.