helper

Documentation

Index

• func CLIMode()
• func CheckForNext() string
• func ClearScreen()
• func CorrectExercice(exercicePath string, saveIt bool, output bool) bool
• func DownloadFiles(dir string)
• func GetHint() (string, error)
• func GetNextExercise(index int) (string, error)
• func Initialize(workingPath string) bool
• func ResetFiles()
• func SaveConfig(config Config) error
• type Config
  • func LoadConfig() Config
• type Exercises
• type GitHubFile

Functions

func CLIMode

func CLIMode()

func CheckForNext

func CheckForNext() string

func ClearScreen

func ClearScreen()

Clear the terminal to keep everything clean

func CorrectExercice

func CorrectExercice(exercicePath string, saveIt bool, output bool) bool

func DownloadFiles

func DownloadFiles(dir string)

func GetHint

func GetHint() (string, error)

Get the next hint of the pending exercice, if no more hint, a message is displayed

func GetNextExercise

func GetNextExercise(index int) (string, error)

GetNextExercise gets the next exercise from exercices.json

func Initialize

func Initialize(workingPath string) bool

func ResetFiles

func ResetFiles()

Called when reset to delete all files

func SaveConfig

func SaveConfig(config Config) error

Types

type Config

type Config struct {
	Next int    `json:"next"`
	Hint int    `json:"hint"`
	Path string `json:"path"`
}

func LoadConfig

func LoadConfig() Config

type Exercises

type Exercises struct {
	Exercises []string `json:"exercices"`
}

type GitHubFile

type GitHubFile struct {
	Name        string `json:"name"`
	Path        string `json:"path"`
	SHA         string `json:"sha"`
	Size        int    `json:"size"`
	URL         string `json:"url"`
	HTMLURL     string `json:"html_url"`
	DownloadURL string `json:"download_url"`
	Type        string `json:"type"`
}