Documentation
¶
Overview ¶
Package loggingfields contains rules that validate logger field usage.
Index ¶
- type LoggingFieldCasingRule
- func (r *LoggingFieldCasingRule) Category() string
- func (r *LoggingFieldCasingRule) Check(fset *token.FileSet, file *ast.File) []violation.Violation
- func (r *LoggingFieldCasingRule) Description() string
- func (r *LoggingFieldCasingRule) Name() string
- func (r *LoggingFieldCasingRule) Severity() violation.Severity
- type LoggingSpecializedFieldRule
- func (r *LoggingSpecializedFieldRule) Category() string
- func (r *LoggingSpecializedFieldRule) Check(fset *token.FileSet, file *ast.File) []violation.Violation
- func (r *LoggingSpecializedFieldRule) Description() string
- func (r *LoggingSpecializedFieldRule) Name() string
- func (r *LoggingSpecializedFieldRule) Severity() violation.Severity
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type LoggingFieldCasingRule ¶
type LoggingFieldCasingRule struct{}
LoggingFieldCasingRule checks that logger field names use snake_case.
func NewLoggingFieldCasingRule ¶
func NewLoggingFieldCasingRule() *LoggingFieldCasingRule
NewLoggingFieldCasingRule creates a new LoggingFieldCasingRule.
func (*LoggingFieldCasingRule) Category ¶
func (r *LoggingFieldCasingRule) Category() string
Category returns the rule category.
func (*LoggingFieldCasingRule) Description ¶
func (r *LoggingFieldCasingRule) Description() string
Description returns the rule description.
func (*LoggingFieldCasingRule) Name ¶
func (r *LoggingFieldCasingRule) Name() string
Name returns the rule name.
func (*LoggingFieldCasingRule) Severity ¶
func (r *LoggingFieldCasingRule) Severity() violation.Severity
Severity returns the default severity.
type LoggingSpecializedFieldRule ¶
type LoggingSpecializedFieldRule struct{}
LoggingSpecializedFieldRule ensures log calls use specialized field helpers instead of casting.
func NewLoggingSpecializedFieldRule ¶
func NewLoggingSpecializedFieldRule() *LoggingSpecializedFieldRule
NewLoggingSpecializedFieldRule creates a new LoggingSpecializedFieldRule.
func (*LoggingSpecializedFieldRule) Category ¶
func (r *LoggingSpecializedFieldRule) Category() string
Category returns the rule category.
func (*LoggingSpecializedFieldRule) Check ¶
func (r *LoggingSpecializedFieldRule) Check(fset *token.FileSet, file *ast.File) []violation.Violation
Check analyzes a file for violations.
func (*LoggingSpecializedFieldRule) Description ¶
func (r *LoggingSpecializedFieldRule) Description() string
Description returns the rule description.
func (*LoggingSpecializedFieldRule) Name ¶
func (r *LoggingSpecializedFieldRule) Name() string
Name returns the rule name.
func (*LoggingSpecializedFieldRule) Severity ¶
func (r *LoggingSpecializedFieldRule) Severity() violation.Severity
Severity returns the default severity.