contracts

Documentation

Index

• type Enforcer
• type EnforcerConfig
• type FileProcessor
• type FilesProcessor
• type FilesProcessorConfig
• type ParsedComment
• type Parser
• type ParsingConfig

Types

type Enforcer

type Enforcer interface {
	Check(comment ParsedComment) error
}

type EnforcerConfig

type EnforcerConfig struct {
	Now    time.Time
	Strict bool
}

type FileProcessor

type FileProcessor[T any] func(filepath string) (T, error)

type FilesProcessor

type FilesProcessor[T any] interface {
	ProcessFiles(files []string) (map[string]T, error)
}

type FilesProcessorConfig

type FilesProcessorConfig[T any] struct {
	Processor            FileProcessor[T]
	Recursive            bool
	FilesExcludePatterns []string
}

type ParsedComment

type ParsedComment struct {
	CommentPrefix string
	Prefix        string
	Content       string
	Expiry        *time.Time
	LineNumber    uint
	OriginalLine  string
}

type Parser

type Parser interface {
	Parse(fileContent string) ([]ParsedComment, error)
}

type ParsingConfig

type ParsingConfig struct {
	CommentPrefixes []string
	Prefixes        []string
	ExpiryPattern   string
	CaseSensitive   bool
	DateLayout      string
}