scanner

Documentation

Index

• type FileResult
• type LanguageResult
• type Scanner
  • func NewScanner(languages language.Languages) *Scanner
  • func (sc *Scanner) Scan(files []analyzer.FileMetadata) ([]scanResult, error)
  • func (sc *Scanner) Summary(results []scanResult) *Summary
• type Summary

Types

type FileResult

type FileResult struct {
	Path       string
	Lines      int
	CodeLines  int
	BlankLines int
	Comments   int
}

type LanguageResult

type LanguageResult struct {
	Lines      int
	CodeLines  int
	BlankLines int
	Comments   int
}

type Scanner

type Scanner struct {
	SupportedLanguages language.Languages
}

func NewScanner

func NewScanner(languages language.Languages) *Scanner

func (*Scanner) Scan

func (sc *Scanner) Scan(files []analyzer.FileMetadata) ([]scanResult, error)

func (*Scanner) Summary

func (sc *Scanner) Summary(results []scanResult) *Summary

type Summary

type Summary struct {
	Languages       map[string]*LanguageResult
	Files           []FileResult
	FilesByLanguage map[string]int
	TotalFiles      int
	TotalLines      int
	TotalCodeLines  int
	TotalBlankLines int
	TotalComments   int
}