tendo

Documentation

Index

• type Class
• type ITendo
• type LanguageType
• type LogLevel
• type Logger
• type NodeType
• type Tendo
  • func NewTendo(logLevel LogLevel) *Tendo
  • func (tendo *Tendo) DisplayTotals()
  • func (tendo *Tendo) GetTotals() (int, int, int, int)
  • func (tendo *Tendo) Inspect(path string, languageType LanguageType)
  • func (tendo *Tendo) Shutdown()
  • func (tendo *Tendo) ToString() string

Types

type Class

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

type ITendo

type ITendo interface {
	Walk(path string)
}

type LanguageType

type LanguageType uint8

LanguageType determines which language the repo uses

type LogLevel

type LogLevel uint8

LogLevel determines how much to output when logging

const (
	Golang LogLevel = iota
	Java
)

The various types of languages

const (
	LogAll LogLevel = iota
	LogTrace
	LogInfo
	LogWarnings
	LogErrors
)

The various levels of logging

type Logger

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

type NodeType

type NodeType uint8

NodeType determines which node was encountered when walking the path

const (
	NoType NodeType = iota
	PackageType
	ClassType
	MethodType
	FunctionType
)

The various types of nodes

type Tendo

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

Tendo is the struct which manages all of the packages in the specified Go project

func NewTendo

func NewTendo(logLevel LogLevel) *Tendo

NewTendo creates a new instance of Tendo and returns a reference to it

func (*Tendo) DisplayTotals

func (tendo *Tendo) DisplayTotals()

DisplayTotals calls GetTotals() and then displays the results to the console

func (*Tendo) GetTotals

func (tendo *Tendo) GetTotals() (int, int, int, int)

GetTotals returns the total number of packages, structs and methods

func (*Tendo) Inspect

func (tendo *Tendo) Inspect(path string, languageType LanguageType)

Inspect walks through all of the Go files specified in the path and counts the packages, structs and methods

func (*Tendo) Shutdown

func (tendo *Tendo) Shutdown()

func (*Tendo) ToString

func (tendo *Tendo) ToString() string