gops

README

gops

The most simple terminal todo utility in the World.

• Simple
• Stupid
• Concrete

What? Why?

Around the World, there are tons of todo-like software. Why do we need to make another? Because I desperately need a simple, convenient to-do list in terminal. The software should be as simple as possible and usable with only a few keystrokes.

gops?

The name gops is ambiguous:

1. gops might mean 'go-operations' aka 'go-todolist'.
2. gops might be Gopink, which I like more 😀.

Install

A command tool gops will be built into $GOPATH/bin/.

go install github.com/dknight/gops/...

CLI usage

Usage of gops:
  -c uint
        Number of the task to complete.
  -f string
        File of stored todo items. (default /home/xdkn1ght/.config/gops/default)
  -l    Display todo-lists.
  -n string
        Set name of the new todo task.
  -s    Sort items by date and status.
  -t    Set list to today's date.
  -u    Display only incomplete items.
  -v    Displays the version.

Make a new item

gops -n "Make a soup"
gops -n "Drink beer and eat semki"

Complete an item

gops -c 2

List all items completed and incompleted

gops -a

Some cli usage examples

Use different list rather than default.

gops -n "Make training at gym" -f training
gops -n "Buy healthy food" -f lifestyle

gops -f lifestyle

Save and read to file with today's date.

gops -t -n "Today go to dentist"
gops -t

Testing

go test

Contribution

Any help is appreciated. Found a bug, typo, inaccuracy, etc.? Please do not hesitate to make a pull request or file an issue.

License

MIT 2022

Documentation

Index

• Constants
• Variables
• func ConfigDir() string
• func CreateStoreFile() (*os.File, error)
• func DefaultFile() string
• func DisplayLists(rds []io.Reader) error
• func GetDefaultStoreFilePath() string
• func GetListsByPath(path string) ([]io.Reader, error)
• func GetStoreFile() (*os.File, error)
• func GetSystemConfigPath() string
• func MakeStoreFilePath(name string) string
• func ResolveDoneColor(st bool) string
• func SetStoreFileName(name string)
• func SortItems(items []Item, wr io.Writer) error
• func StoreFileName() string
• func Truncate(wr io.Writer) error
• func Version() string
• type Item
  • func AllItems(rd io.Reader) ([]Item, error)
  • func CompleteItem(i uint, items []Item, wr io.Writer) (*Item, error)
  • func FilterItemsByStatus(items []Item, status bool) []Item
  • func NewItem(tm time.Time, s bool, t string) *Item
  • func (item *Item) BeautifulString(i int) string
  • func (item *Item) Complete()
  • func (item *Item) GetMark() []rune
  • func (item *Item) Save(wr io.Writer) error
  • func (item *Item) Slice() []string
• type List
  • func (li List) BeautifulString() string

Constants

const (
	// ItemStatusCompleted identifies item as done.
	ItemStatusCompleted = true
	// ItemStatusIncompleted identifies item as incomplete..
	ItemStatusIncompleted = false
)

Variables

var Color = struct {
	Blue   string
	Green  string
	Yellow string
	Red    string
	Nul    string
}{
	Blue:   "\033[94m",
	Green:  "\033[92m",
	Yellow: "\033[93m",
	Red:    "\033[91m",
	Nul:    "\033[0m",
}

Color contains some colors for terminal representation.

Functions

func ConfigDir

func ConfigDir() string

ConfigDir gets the gops name in config directory.

func CreateStoreFile

func CreateStoreFile() (*os.File, error)

CreateStoreFile create store file if not exists.

func DefaultFile

func DefaultFile() string

DefaultFile gets default file name in config directory.

func DisplayLists

func DisplayLists(rds []io.Reader) error

DisplayLists shows all lists.

func GetDefaultStoreFilePath

func GetDefaultStoreFilePath() string

GetDefaultStoreFilePath gets default file to store items.

func GetListsByPath

func GetListsByPath(path string) ([]io.Reader, error)

GetListsByPath gets all list by given path in file system.

func GetStoreFile

func GetStoreFile() (*os.File, error)

GetStoreFile resolves the file to store todo items on file system.

func GetSystemConfigPath

func GetSystemConfigPath() string

GetSystemConfigPath gets config directory, on Linux usually $HOME/.config

func MakeStoreFilePath

func MakeStoreFilePath(name string) string

MakeStoreFilePath makes path to store file.

func ResolveDoneColor

func ResolveDoneColor(st bool) string

ResolveDoneColor gets the done item color.

func SetStoreFileName

func SetStoreFileName(name string)

SetStoreFileName set store file name where items are written.

func SortItems

func SortItems(items []Item, wr io.Writer) error

SortItems sorts the items by date and the by status, completed items are going to bottom.

func StoreFileName

func StoreFileName() string

StoreFileName gets the file name where items are written.

func Truncate

func Truncate(wr io.Writer) error

Truncate truncates writer, currently implemeted only for file and buffer.

func Version

func Version() string

Version gets the version of gops. Maybe do better structure major, minor, patch.

Types

type Item

type Item struct {
	Time   time.Time
	Status bool
	Task   string
}

Item represents a todo item.

func AllItems

func AllItems(rd io.Reader) ([]Item, error)

AllItems reads the todo items from file and returns them.

func CompleteItem

func CompleteItem(i uint, items []Item, wr io.Writer) (*Item, error)

CompleteItem sets the status of a todo item to complete and writes it to file.

func FilterItemsByStatus

func FilterItemsByStatus(items []Item, status bool) []Item

FilterItemsByStatus filters the todo items by status completed or incomplete.

func NewItem

func NewItem(tm time.Time, s bool, t string) *Item

NewItem create a new todo item.

func (*Item) BeautifulString

func (item *Item) BeautifulString(i int) string

BeautifulString returns string to output with colors.

func (*Item) Complete

func (item *Item) Complete()

Complete completes a todo item.

func (*Item) GetMark

func (item *Item) GetMark() []rune

GetMark gets mark for completed or incompleted item.

func (*Item) Save

func (item *Item) Save(wr io.Writer) error

Save saves the todo item to file.

func (*Item) Slice

func (item *Item) Slice() []string

Slice converts the todo item into slice.

type List

type List struct {
	// Done counts completed items.
	Done int
	// Total counts total items.
	Total int
	// Name is the name of the list (file).
	Name string
}

List represents lists.

func (List) BeautifulString

func (li List) BeautifulString() string

BeautifulString prints list as the beautiful string.