sugg

type Category string

type Comment interface {

	// ID returns the comment identifier. e.g. `go.two-fer.missing_share_with_function`
	ID() string

	// Severity reports the severity of the comment.
	Severity() int

	// ToString returns the final comment the way it will be provided to the student.
	// If not already cached this involves pulling the comment from the git repository where it is located.
	ToString() string

	// Category returns the category of the comment.
	Category() Category
	// contains filtered or unexported methods
}

type Register struct {
	// Funcs a registry of functions to be called. Each function should investigate one pattern and
	// can add one or multiple suggestions if the found pattern needs commenting.
	Funcs []SuggestionFunc

	// Severity defines how severe a comment is. A sum over all comments of 5 means no approval.
	// The maximum for a single comment is 5. A comment with that severity will block approval.
	// When assigning the severity a good guideline is to ask: How many comments of similar severity
	// should block approval?
	// We can be very strict on automated comments since the student has a very fast feedback loop.
	Severity map[string]int
}

type Suggester interface {
	// AppendUnique adds a suggestion while checking if it exists already.
	// That way it does not matter if the code accidentally adds the same suggestion multiple times.
	AppendUnique(comment string)

	// AppendUniquePH adds a suggestion with placeholders while checking if it exists already.
	AppendUniquePH(commentID string, params map[string]string)

	// ReportError collects provided errors. They will be added to the output file
	// for debugging purpose. Reporting will fail the analyzer with `refer_to_mentor` status.
	// If that is not what you want consider adding a comment to the student instead of an error.
	ReportError(err error)

	// HasSuggestion checks if a comment was added. This should not be used to avoid duplicated.
	// Duplicates are avoided by default. It might however be useful to check if some other algorithm
	// found a certain pattern so it doesn't have to be checked again.
	HasSuggestion(comment string) bool
}

type SuggestionFunc func(pkg *astrav.Package, suggs Suggester)

type SuggestionReport struct {
	// contains filtered or unexported fields
}