clockin

Documentation

Index

• Constants
• Variables
• func AddProject(c *Config, project, module string) error
• func CreateIfNotPresent(path string) error
• func DoesPathExist(path string) (bool, error)
• func PrintAllProjects(c *Config) error
• func SanitizePath(Path string) (string, error)
• type Config
  • func InitializeConfig() (*Config, error)
  • func LoadConfig() (*Config, error)
  • func LoadOrInitialiseConfig() (*Config, error)
  • func (c *Config) GetBaseDir() (string, error)
  • func (c *Config) LoadDefaultConfig() error
  • func (c *Config) Print()
  • func (c *Config) ReadAndSave()
  • func (c *Config) Save() error
  • func (c *Config) SetBaseDir(dirPath string) error
• type Entry
• type EntryFile
• type Module
• type Project

Constants

const (
	DefaultBaseDirPath = "~/.clockin/"
	ConfigFileName     = "config.yml"
)

const (
	DEFAULT_FILE_MODE fs.FileMode = 0644
)

const (
	PROJECT_FILE string = "projects.yml"
)

Variables

var (
	ValidConfigPaths []string = []string{"./config.yml", "~/.clockin/config.yml"}
)

Functions

func AddProject

func AddProject(c *Config, project, module string) error

func CreateIfNotPresent

func CreateIfNotPresent(path string) error

func DoesPathExist

func DoesPathExist(path string) (bool, error)

func PrintAllProjects

func PrintAllProjects(c *Config) error

func SanitizePath

func SanitizePath(Path string) (string, error)

Types

type Config

type Config struct {
	BaseDir string
}

func InitializeConfig

func InitializeConfig() (*Config, error)

func LoadConfig

func LoadConfig() (*Config, error)

func LoadOrInitialiseConfig

func LoadOrInitialiseConfig() (*Config, error)

func (*Config) GetBaseDir

func (c *Config) GetBaseDir() (string, error)

func (*Config) LoadDefaultConfig

func (c *Config) LoadDefaultConfig() error

func (*Config) Print

func (c *Config) Print()

func (*Config) ReadAndSave

func (c *Config) ReadAndSave()

func (*Config) Save

func (c *Config) Save() error

func (*Config) SetBaseDir

func (c *Config) SetBaseDir(dirPath string) error

type Entry

type Entry struct {
	Timestamp string
	Project   string
	Module    string
	Remarks   string
}

type EntryFile

type EntryFile struct {
	Entries []Entry
}

type Module

type Module string

type Project

type Project struct {
	ProjectName string
	Modules     []Module
}