code

package
v1.6.5 Latest Latest
Warning

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

Go to latest
Published: Sep 12, 2026 License: MIT Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source
const (
	StructCategory = "Структура комментария"
	CommitCategory = "Форма коммита"
)

Категории структурных проверок: по ним их можно отключить целиком.

Variables

This section is empty.

Functions

func SortFindings

func SortFindings(f []Finding)

SortFindings: по файлу, внутри файла по строке. Порядок стабилен между запусками, иначе diff отчётов бесполезен.

func SortItems

func SortItems(items []Item)

SortItems: сначала самые грязные блоки, чтобы --limit брал их первыми.

func WalkCode

func WalkCode(root string, f Filter) ([]string, error)

WalkCode собирает файлы с поддерживаемыми расширениями. Файл передаётся как есть. В git-репозитории список берётся у самого git: так .gitignore соблюдается точно, включая вложенные и глобальные правила, и собранный код в lib/ или bundle/ не попадает под проверку.

Types

type CodeSets

type CodeSets struct {
	RU, EN, Code *humanize.RuleSet
	MaxLines     int
	MaxLineLen   int
}

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

func ExtractComments(path string) ([]Comment, error)

ExtractComments достаёт блоки комментариев из файла. Для Go берём go/parser, для остальных - посимвольный сканер: он знает про строки и шаблоны, поэтому "//" внутри литерала за комментарий не считает.

func GitCommits

func GitCommits(dir string, limit int) ([]Comment, error)

GitCommits читает последние limit коммитов. Каждый становится Comment с File вида "commit a1b2c3d" - дальше он проверяется как обычная проза.

func (Comment) ID

func (c Comment) ID() string

ID - устойчивый ключ блока для агента: по нему он сверяет, ушла ли находка после правки. Строки съезжают, поэтому ключ дополняется текстом в Raw.

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 - одна находка в комментарии или коммите, с абсолютным номером строки.

func CheckComment

func CheckComment(cs CodeSets, c Comment, genre string) []Finding

CheckComment: правила по языку + общие правила комментариев + структурные проверки, которых регуляркой не выразить.

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 точным совпадением: номера строк после первой же правки уезжают.

func NewItem

func NewItem(c Comment, f []Finding) Item

NewItem собирает блок. Повторы одного правила на одной строке схлопываются: агенту важно правило, а не сколько раз оно совпало.

type ItemFinding

type ItemFinding struct {
	Rule     string  `json:"rule"`
	Category string  `json:"category,omitempty"`
	Fix      string  `json:"fix,omitempty"`
	Line     int     `json:"line"`
	Hard     bool    `json:"hard"`
	Lift     float64 `json:"lift,omitempty"`
	Sample   string  `json:"sample,omitempty"`
}

Jump to

Keyboard shortcuts

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