exercise

Documentation

Index

• Constants
• func GetExercises() (*[]Exercise, error)
• type Exercise
  • func Search(name string) (*Exercise, error)
  • func (e *Exercise) Run() Result
  • func (e *Exercise) State() State
• type Result
• type State

Constants

const (
	Compile = "compile"
	Test    = "test"
)

const Regex = `\/\/\s*I\s+AM\s+NOT\s+DONE\b`

Regex pattern for //I AM NOT DONE

Functions

func GetExercises

func GetExercises() (*[]Exercise, error)

Get list of exercises

Types

type Exercise

type Exercise struct {
	Name string `yaml:"name"`
	Type string `yaml:"type"`
	File string `yaml:"file"`
}

func Search

func Search(name string) (*Exercise, error)

Search for particular exercise

func (*Exercise) Run

func (e *Exercise) Run() Result

func (*Exercise) State

func (e *Exercise) State() State

Get state of the exercise by checking if "I AM NOT DONE" is being removed from the exercise or not.

type Result

type Result struct {
	Output string
	Err    string
}

type State

type State int

const (
	Done State = iota
	Pending
)

Enum for exercise's state