From 470e8ad5a374467cc886bc0b371bbc389c7bc9cc Mon Sep 17 00:00:00 2001 From: agres Date: Thu, 16 Oct 2025 00:21:16 +0200 Subject: [PATCH 1/4] Moved some files, implemented Dockerfile for tests, implemented makefile with install functionality --- Dockerfile | 6 ++ Makefile | 31 ++++++++++ data/commands.json | 6 ++ data/commands_template.json | 18 ++++++ go.mod | 18 ++++++ go.sum | 80 ++++++++++++++++++++++++++ src/configHandler.go | 6 ++ src/main.go | 108 ++++++++--------------------------- src/tui.go | 111 ++++++++++++++++++++++++++++++++++++ 9 files changed, 301 insertions(+), 83 deletions(-) create mode 100644 Dockerfile create mode 100644 Makefile create mode 100644 data/commands_template.json create mode 100644 go.mod create mode 100644 go.sum create mode 100644 src/configHandler.go create mode 100644 src/tui.go diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..8770d9a --- /dev/null +++ b/Dockerfile @@ -0,0 +1,6 @@ +FROM golang:1.24-alpine AS builder +WORKDIR /app +COPY . . +RUN apk add --no-cache make +RUN make install +CMD ["cheatsh"] diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..5170b3e --- /dev/null +++ b/Makefile @@ -0,0 +1,31 @@ +EXECUTABLE = cheatsh +PACKAGES = ./src/. +BINDIR = bin +SYSCONFDIR = /etc/cheatsh +PREFIX ?= /usr/local + +all: build + +build: + @mkdir -p bin + go build -o bin/$(EXECUTABLE) $(PACKAGES) + +install: build + + @echo "Installing binary in $(PREFIX)" + install -Dm755 bin/$(EXECUTABLE) $(PREFIX)/bin/$(EXECUTABLE) + + @echo "Copying config files to $(SYSCONFDIR)" + install -Dm644 data/commands.json $(SYSCONFDIR)/commands.json + install -Dm644 data/commands_template.json $(SYSCONFDIR)/commands_template.json + +uninstall: + rm -f $(PREFIX)/bin/$(EXECUTABLE) + rm -rf $(SYSCONFDIR) + +clean: + rm -rf bin/ + +docker: + docker build -t cheatsh-test . + docker run -it --rm cheatsh-test /bin/sh diff --git a/data/commands.json b/data/commands.json index d961305..08f7b5c 100644 --- a/data/commands.json +++ b/data/commands.json @@ -68,5 +68,11 @@ "command": "GOOS=linux GOARCH=amd64 go build -o bin/myprogram.exe main.go", "desc": "Cross-compile for Linux (alt. windows, darwin (arm64 / amd64))" } + ], + "git": [ + { + "command": "git checkout -b branch_name", + "desc": "Create and checkout a new branch" + } ] } diff --git a/data/commands_template.json b/data/commands_template.json new file mode 100644 index 0000000..093e558 --- /dev/null +++ b/data/commands_template.json @@ -0,0 +1,18 @@ +{ + "language/system": [ + { + "command": "the actual command", + "desc": "Describe the command here" + }, + { + "command": "and add any amount of commands below", + "desc": "Describe them" + } + ], + "different language/system": [ + { + "command": "the command for a different language", + "desc": "Describe it" + } + ] +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..91388e4 --- /dev/null +++ b/go.mod @@ -0,0 +1,18 @@ +module github.com/dominikagres/cheat_sheet + +go 1.24.1 + +require ( + github.com/gdamore/tcell/v2 v2.8.1 + github.com/rivo/tview v0.42.0 +) + +require ( + github.com/gdamore/encoding v1.0.1 // indirect + github.com/lucasb-eyer/go-colorful v1.2.0 // indirect + github.com/mattn/go-runewidth v0.0.16 // indirect + github.com/rivo/uniseg v0.4.7 // indirect + golang.org/x/sys v0.29.0 // indirect + golang.org/x/term v0.28.0 // indirect + golang.org/x/text v0.21.0 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..8afde65 --- /dev/null +++ b/go.sum @@ -0,0 +1,80 @@ +github.com/gdamore/encoding v1.0.1 h1:YzKZckdBL6jVt2Gc+5p82qhrGiqMdG/eNs6Wy0u3Uhw= +github.com/gdamore/encoding v1.0.1/go.mod h1:0Z0cMFinngz9kS1QfMjCP8TY7em3bZYeeklsSDPivEo= +github.com/gdamore/tcell/v2 v2.8.1 h1:KPNxyqclpWpWQlPLx6Xui1pMk8S+7+R37h3g07997NU= +github.com/gdamore/tcell/v2 v2.8.1/go.mod h1:bj8ori1BG3OYMjmb3IklZVWfZUJ1UBQt9JXrOCOhGWw= +github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY= +github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= +github.com/mattn/go-runewidth v0.0.16 h1:E5ScNMtiwvlvB5paMFdw9p4kSQzbXFikJ5SQO6TULQc= +github.com/mattn/go-runewidth v0.0.16/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= +github.com/rivo/tview v0.42.0 h1:b/ftp+RxtDsHSaynXTbJb+/n/BxDEi+W3UfF5jILK6c= +github.com/rivo/tview v0.42.0/go.mod h1:cSfIYfhpSGCjp3r/ECJb+GKS7cGJnqV8vfjQPwoXyfY= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.3/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc= +golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU= +golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8= +golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= +golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/mod v0.15.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= +golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= +golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= +golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= +golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk= +golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44= +golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y= +golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.29.0 h1:TPYlXGxvx1MGTn2GiZDhnjPA9wZzZeGKHHmKhHYvgaU= +golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= +golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo= +golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU= +golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk= +golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY= +golang.org/x/term v0.28.0 h1:/Ts8HFuMR2E6IP/jlo7QVLZHggjKQbhu/7H0LJFr3Gg= +golang.org/x/term v0.28.0/go.mod h1:Sw/lC2IAUZ92udQNf3WodGtn4k/XoLyZoh8v/8uiwek= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= +golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= +golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo= +golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= +golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= +golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58= +golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/src/configHandler.go b/src/configHandler.go new file mode 100644 index 0000000..a831ee8 --- /dev/null +++ b/src/configHandler.go @@ -0,0 +1,6 @@ +package main + + +func testFunction() string { + return "" +} diff --git a/src/main.go b/src/main.go index 5a74bbb..02accb5 100644 --- a/src/main.go +++ b/src/main.go @@ -1,96 +1,38 @@ package main import ( - "encoding/json" "fmt" - "log" "os" - "sort" - - "github.com/gdamore/tcell/v2" - "github.com/rivo/tview" + "flag" ) -// Individual Command Items Later Extracted -type CmdItem struct { - CommandName string `json:"command"` - CommandDescription string `json:"desc"` -} -// All commands -type CmdMap map[string][]CmdItem - -// Read Json-File and return it -func loadCommands(path string) (CmdMap, error) { - data, err := os.ReadFile(path) - if err != nil { - return nil, err - } - - var m CmdMap - if err := json.Unmarshal(data, &m); err != nil { - return nil, err - } - return m, nil -} - -// Function Called when a subset of functions has been selected -func showCommandList(app *tview.Application, lang string, cmds []CmdItem, langList *tview.List) { - cmdList := tview.NewList() - cmdList.SetBorder(true).SetTitle(fmt.Sprintf("%s commands", lang)) - - for _, c := range cmds { - c := c - cmdList.AddItem(c.CommandName, c.CommandDescription, 0, func() { - //fmt.Println(c.CommandName) - app.Suspend(func() { - fmt.Println(c.CommandName) // this now prints visibly - }) - app.Stop() - os.Exit(0) - }) - } - - cmdList.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey { - if event.Rune() == 'b' || event.Key() == tcell.KeyEscape { - // Restore the language list - app.SetRoot(langList, true) - return nil - } - return event - }) - - app.SetRoot(cmdList, true) -} - -// Main Function -// Initialises the first page and starts app func main() { - commands, err := loadCommands("data/commands.json") - if err != nil { - log.Fatalf("Cannot load commands file: %v", err) + + configFlag := flag.String("config", "", "Specify a config file") + helpFlag := flag.Bool("help", false, "Show help") + + flag.Parse() + + if len(os.Args) == 1 { + StartTui() + return } - app := tview.NewApplication() - - // Sort alphabetically - langs := make([]string, 0, len(commands)) - for lang := range commands { - langs = append(langs, lang) - } - sort.Strings(langs) - - langList := tview.NewList() - langList.SetBorder(true).SetTitle("Select a topic") - - for _, lang := range langs { - lang := lang // capture loop variable - langList.AddItem(lang, "", 0, func() { - showCommandList(app, lang, commands[lang], langList) - }) - } - - if err := app.SetRoot(langList, true).Run(); err != nil { - log.Fatalf("Error initialising TUI: %v", err) + switch { + case *helpFlag: + printHelp() + case *configFlag != "": + StartTui(*configFlag) + default: + printHelp() + os.Exit(1) } } + +func printHelp() { + fmt.Println(`Usage: cheatsh [options] + Options: + --config Specify a config file + --help Show this help message`) +} diff --git a/src/tui.go b/src/tui.go new file mode 100644 index 0000000..8bcd84a --- /dev/null +++ b/src/tui.go @@ -0,0 +1,111 @@ +package main + +import ( + "fmt" + "sort" + "log" + "os" + "encoding/json" + + "github.com/gdamore/tcell/v2" + "github.com/rivo/tview" +) + +var commandsFile []byte + +type CmdItem struct { + CommandName string `json:"command"` + CommandDescription string `json:"desc"` +} +type CmdMap map[string][]CmdItem + + +func StartTui(configFilePath ...string) { + + var configFilePathString string + if len(configFilePath) > 0 { + configFilePathString = configFilePath[0] + } else { + configFilePathString = "/etc/cheatsh/commands.json" + } + commands, err := loadCommands(configFilePathString) + if err != nil { + log.Fatalf("Cannot load commands file: %v", err) + } + + app := tview.NewApplication() + + // Sort alphabetically + langs := make([]string, 0, len(commands)) + for lang := range commands { + langs = append(langs, lang) + } + sort.Strings(langs) + + langList := tview.NewList() + langList.SetBorder(true).SetTitle("Select a topic") + + for _, lang := range langs { + lang := lang + langList.AddItem(lang, "", 0, func() { + showCommandList(app, lang, commands[lang], langList) + }) + } + + langList.SetWrapAround(false).SetHighlightFullLine(true) + langList.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey { + if event.Rune() == 'b' || event.Key() == tcell.KeyEscape { + app.Stop() + os.Exit(0) + } + return event + }) + + if err := app.SetRoot(langList, true).Run(); err != nil { + log.Fatalf("Error initialising TUI: %v", err) + } +} + +func showCommandList(app *tview.Application, lang string, cmds []CmdItem, langList *tview.List) { + cmdList := tview.NewList() + cmdList.SetBorder(true).SetTitle(fmt.Sprintf("%s commands", lang)) + + for _, c := range cmds { + c := c + cmdList.AddItem(c.CommandName, c.CommandDescription, 0, func() { + app.Suspend(func() { + fmt.Println(c.CommandName) + }) + app.Stop() + os.Exit(0) + }) + } + + cmdList.SetWrapAround(false).SetHighlightFullLine(true) + cmdList.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey { + if event.Rune() == 'b' || event.Key() == tcell.KeyEscape { + // Restore the language list + app.SetRoot(langList, true) + return nil + } + return event + }) + + app.SetRoot(cmdList, true) +} + +func loadCommands(path string) (CmdMap, error) { + + data, err := os.ReadFile(path) + if err != nil { + return nil, err + } + + var m CmdMap + err = json.Unmarshal(data, &m) + if err != nil { + return nil, err + } + + return m, nil +} From b2f106dcdfd88fdcc9b1eff8f607918728b7e9b3 Mon Sep 17 00:00:00 2001 From: agres Date: Thu, 16 Oct 2025 00:21:45 +0200 Subject: [PATCH 2/4] Removed go files from gitignore --- .gitignore | 3 --- 1 file changed, 3 deletions(-) diff --git a/.gitignore b/.gitignore index 55e3d4c..fdb3507 100644 --- a/.gitignore +++ b/.gitignore @@ -45,7 +45,6 @@ *.pdb # Kernel Module Compile Results -*.mod* *.cmd .tmp_versions/ modules.order @@ -57,6 +56,4 @@ dkms.conf *.dwo # Go -*.sum -*.mod bin/* From b4f7007a9f0197ce8991789c36408fb4615ec3c3 Mon Sep 17 00:00:00 2001 From: agres Date: Fri, 17 Oct 2025 12:13:45 +0200 Subject: [PATCH 3/4] Reworked tui in bubbletea instead of tview --- Makefile | 3 + go.mod | 23 ++++- go.sum | 117 +++++++++-------------- src/configHandler.go | 4 +- src/main.go | 6 +- src/tui.go | 221 ++++++++++++++++++++++++++++++------------- 6 files changed, 227 insertions(+), 147 deletions(-) diff --git a/Makefile b/Makefile index 5170b3e..fb3bf53 100644 --- a/Makefile +++ b/Makefile @@ -29,3 +29,6 @@ clean: docker: docker build -t cheatsh-test . docker run -it --rm cheatsh-test /bin/sh + +local: build + ./bin/cheatsh --config ./data/commands.json diff --git a/go.mod b/go.mod index 91388e4..9f1c590 100644 --- a/go.mod +++ b/go.mod @@ -3,16 +3,29 @@ module github.com/dominikagres/cheat_sheet go 1.24.1 require ( - github.com/gdamore/tcell/v2 v2.8.1 - github.com/rivo/tview v0.42.0 + github.com/charmbracelet/bubbles v0.21.0 + github.com/charmbracelet/bubbletea v1.3.10 + github.com/charmbracelet/lipgloss v1.1.0 ) require ( - github.com/gdamore/encoding v1.0.1 // indirect + github.com/atotto/clipboard v0.1.4 // indirect + github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect + github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc // indirect + github.com/charmbracelet/x/ansi v0.10.1 // indirect + github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd // indirect + github.com/charmbracelet/x/term v0.2.1 // indirect + github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f // indirect github.com/lucasb-eyer/go-colorful v1.2.0 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/mattn/go-localereader v0.0.1 // indirect github.com/mattn/go-runewidth v0.0.16 // indirect + github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 // indirect + github.com/muesli/cancelreader v0.2.2 // indirect + github.com/muesli/termenv v0.16.0 // indirect github.com/rivo/uniseg v0.4.7 // indirect - golang.org/x/sys v0.29.0 // indirect - golang.org/x/term v0.28.0 // indirect + github.com/sahilm/fuzzy v0.1.1 // indirect + github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect + golang.org/x/sys v0.36.0 // indirect golang.org/x/text v0.21.0 // indirect ) diff --git a/go.sum b/go.sum index 8afde65..3178f39 100644 --- a/go.sum +++ b/go.sum @@ -1,80 +1,55 @@ -github.com/gdamore/encoding v1.0.1 h1:YzKZckdBL6jVt2Gc+5p82qhrGiqMdG/eNs6Wy0u3Uhw= -github.com/gdamore/encoding v1.0.1/go.mod h1:0Z0cMFinngz9kS1QfMjCP8TY7em3bZYeeklsSDPivEo= -github.com/gdamore/tcell/v2 v2.8.1 h1:KPNxyqclpWpWQlPLx6Xui1pMk8S+7+R37h3g07997NU= -github.com/gdamore/tcell/v2 v2.8.1/go.mod h1:bj8ori1BG3OYMjmb3IklZVWfZUJ1UBQt9JXrOCOhGWw= -github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/atotto/clipboard v0.1.4 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z4= +github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI= +github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k= +github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8= +github.com/aymanbagabas/go-udiff v0.2.0 h1:TK0fH4MteXUDspT88n8CKzvK0X9O2xu9yQjWpi6yML8= +github.com/aymanbagabas/go-udiff v0.2.0/go.mod h1:RE4Ex0qsGkTAJoQdQQCA0uG+nAzJO/pI/QwceO5fgrA= +github.com/charmbracelet/bubbles v0.21.0 h1:9TdC97SdRVg/1aaXNVWfFH3nnLAwOXr8Fn6u6mfQdFs= +github.com/charmbracelet/bubbles v0.21.0/go.mod h1:HF+v6QUR4HkEpz62dx7ym2xc71/KBHg+zKwJtMw+qtg= +github.com/charmbracelet/bubbletea v1.3.10 h1:otUDHWMMzQSB0Pkc87rm691KZ3SWa4KUlvF9nRvCICw= +github.com/charmbracelet/bubbletea v1.3.10/go.mod h1:ORQfo0fk8U+po9VaNvnV95UPWA1BitP1E0N6xJPlHr4= +github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc h1:4pZI35227imm7yK2bGPcfpFEmuY1gc2YSTShr4iJBfs= +github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc/go.mod h1:X4/0JoqgTIPSFcRA/P6INZzIuyqdFY5rm8tb41s9okk= +github.com/charmbracelet/lipgloss v1.1.0 h1:vYXsiLHVkK7fp74RkV7b2kq9+zDLoEU4MZoFqR/noCY= +github.com/charmbracelet/lipgloss v1.1.0/go.mod h1:/6Q8FR2o+kj8rz4Dq0zQc3vYf7X+B0binUUBwA0aL30= +github.com/charmbracelet/x/ansi v0.10.1 h1:rL3Koar5XvX0pHGfovN03f5cxLbCF2YvLeyz7D2jVDQ= +github.com/charmbracelet/x/ansi v0.10.1/go.mod h1:3RQDQ6lDnROptfpWuUVIUG64bD2g2BgntdxH0Ya5TeE= +github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd h1:vy0GVL4jeHEwG5YOXDmi86oYw2yuYUGqz6a8sLwg0X8= +github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd/go.mod h1:xe0nKWGd3eJgtqZRaN9RjMtK7xUYchjzPr7q6kcvCCs= +github.com/charmbracelet/x/exp/golden v0.0.0-20241011142426-46044092ad91 h1:payRxjMjKgx2PaCWLZ4p3ro9y97+TVLZNaRZgJwSVDQ= +github.com/charmbracelet/x/exp/golden v0.0.0-20241011142426-46044092ad91/go.mod h1:wDlXFlCrmJ8J+swcL/MnGUuYnqgQdW9rhSD61oNMb6U= +github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQaGIAQ= +github.com/charmbracelet/x/term v0.2.1/go.mod h1:oQ4enTYFV7QN4m0i9mzHrViD7TQKvNEEkHUMCmsxdUg= +github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f h1:Y/CXytFA4m6baUTXGLOoWe4PQhGxaX0KpnayAqC48p4= +github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f/go.mod h1:vw97MGsxSvLiUE2X8qFplwetxpGLQrlU1Q9AUEIzCaM= +github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc= +github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw= github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY= github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/mattn/go-localereader v0.0.1 h1:ygSAOl7ZXTx4RdPYinUpg6W99U8jWvWi9Ye2JC/oIi4= +github.com/mattn/go-localereader v0.0.1/go.mod h1:8fBrzywKY7BI3czFoHkuzRoWE9C+EiG4R1k4Cjx5p88= github.com/mattn/go-runewidth v0.0.16 h1:E5ScNMtiwvlvB5paMFdw9p4kSQzbXFikJ5SQO6TULQc= github.com/mattn/go-runewidth v0.0.16/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= -github.com/rivo/tview v0.42.0 h1:b/ftp+RxtDsHSaynXTbJb+/n/BxDEi+W3UfF5jILK6c= -github.com/rivo/tview v0.42.0/go.mod h1:cSfIYfhpSGCjp3r/ECJb+GKS7cGJnqV8vfjQPwoXyfY= +github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 h1:ZK8zHtRHOkbHy6Mmr5D264iyp3TiX5OmNcI5cIARiQI= +github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6/go.mod h1:CJlz5H+gyd6CUWT45Oy4q24RdLyn7Md9Vj2/ldJBSIo= +github.com/muesli/cancelreader v0.2.2 h1:3I4Kt4BQjOR54NavqnDogx/MIoWBFa0StPA8ELUXHmA= +github.com/muesli/cancelreader v0.2.2/go.mod h1:3XuTXfFS2VjM+HTLZY9Ak0l6eUKfijIfMUZ4EgX0QYo= +github.com/muesli/termenv v0.16.0 h1:S5AlUN9dENB57rsbnkPyfdGuWIlkmzJjbFf0Tf5FWUc= +github.com/muesli/termenv v0.16.0/go.mod h1:ZRfOIKPFDYQoDFF4Olj7/QJbW60Ol/kL1pU3VfY/Cnk= github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= -github.com/rivo/uniseg v0.4.3/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= -github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= -golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= -golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= -golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc= -golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU= -golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8= -golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= -golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= -golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= -golang.org/x/mod v0.15.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= -golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= -golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= -golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= -golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= -golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= -golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= -golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk= -golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44= -golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM= -golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y= -golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= -golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= -golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= -golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= -golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= -golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= -golang.org/x/sys v0.29.0 h1:TPYlXGxvx1MGTn2GiZDhnjPA9wZzZeGKHHmKhHYvgaU= -golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= -golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE= -golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= -golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= -golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= -golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo= -golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU= -golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk= -golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY= -golang.org/x/term v0.28.0 h1:/Ts8HFuMR2E6IP/jlo7QVLZHggjKQbhu/7H0LJFr3Gg= -golang.org/x/term v0.28.0/go.mod h1:Sw/lC2IAUZ92udQNf3WodGtn4k/XoLyZoh8v/8uiwek= -golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= -golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= -golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= -golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= -golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= -golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= -golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= -golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +github.com/sahilm/fuzzy v0.1.1 h1:ceu5RHF8DGgoi+/dR5PsECjCDH1BE3Fnmpo7aVXOdRA= +github.com/sahilm/fuzzy v0.1.1/go.mod h1:VFvziUEIMCrT6A6tw2RFIXPXXmzXbOsSHF0DOI8ZK9Y= +github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no= +github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM= +golang.org/x/exp v0.0.0-20220909182711-5c715a9e8561 h1:MDc5xs78ZrZr3HMQugiXOAkSZtfTpbJLDr/lwfgO53E= +golang.org/x/exp v0.0.0-20220909182711-5c715a9e8561/go.mod h1:cyybsKvd6eL0RnXn6p/Grxp8F5bW7iYuBgsNCOHpMYE= +golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.36.0 h1:KVRy2GtZBrk1cBYA7MKu5bEZFxQk4NIDV6RLVcC8o0k= +golang.org/x/sys v0.36.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo= golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ= -golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= -golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= -golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= -golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= -golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58= -golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk= -golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/src/configHandler.go b/src/configHandler.go index a831ee8..2f33b2a 100644 --- a/src/configHandler.go +++ b/src/configHandler.go @@ -1,6 +1,6 @@ package main -func testFunction() string { - return "" +func HandleInput() { + } diff --git a/src/main.go b/src/main.go index 02accb5..c441ec3 100644 --- a/src/main.go +++ b/src/main.go @@ -11,6 +11,7 @@ func main() { configFlag := flag.String("config", "", "Specify a config file") helpFlag := flag.Bool("help", false, "Show help") + newFlag := flag.Bool("new", false, "Add new command to config") flag.Parse() @@ -24,6 +25,8 @@ func main() { printHelp() case *configFlag != "": StartTui(*configFlag) + case *newFlag: + HandleInput() default: printHelp() os.Exit(1) @@ -34,5 +37,6 @@ func printHelp() { fmt.Println(`Usage: cheatsh [options] Options: --config Specify a config file - --help Show this help message`) + --help Show this help message + --new Add a new command to the config file`) } diff --git a/src/tui.go b/src/tui.go index 8bcd84a..5b2f687 100644 --- a/src/tui.go +++ b/src/tui.go @@ -1,97 +1,154 @@ package main import ( + "encoding/json" "fmt" - "sort" "log" "os" - "encoding/json" + //"sort" + //"strings" - "github.com/gdamore/tcell/v2" - "github.com/rivo/tview" + + "github.com/charmbracelet/bubbles/key" + "github.com/charmbracelet/bubbles/list" + tea "github.com/charmbracelet/bubbletea" + "github.com/charmbracelet/lipgloss" ) -var commandsFile []byte - +type CmdMap map[string][]CmdItem type CmdItem struct { CommandName string `json:"command"` CommandDescription string `json:"desc"` } -type CmdMap map[string][]CmdItem +type item struct { + title string + description string +} +func (i item) Title() string { return i.title } +func (i item) Description() string { return i.description } +func (i item) FilterValue() string { return i.title } + +type view int + +type model struct { + list list.Model + commands CmdMap + currentView view + currentKey string + selectedCmd string +} +func (m model) Init() tea.Cmd { return nil } + +func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) { + + switch msg := msg.(type) { + + case tea.KeyMsg: + + switch msg.String() { + + case "ctrl+c", "q": + return m, tea.Quit + + case "enter": + selected, ok := m.list.SelectedItem().(item) + if ok { + if m.currentView == viewCategories { + m.currentKey = selected.title + m.currentView = viewCommands + m.list.Title = m.currentKey + m.list.SetItems(cmdItemsToList(m.commands[m.currentKey])) + } else if m.currentView == viewCommands { + m.selectedCmd = selected.title + return m, tea.Quit + } + } + + case "b": + + if m.currentView == viewCommands { + m.currentView = viewCategories + m.list.Title = "Choose a list of commands" + m.list.SetItems(cmdMapKeysToList(m.commands)) + } + + } + + case tea.WindowSizeMsg: + h, v := docStyle.GetFrameSize() + m.list.SetSize(msg.Width-h, msg.Height-v) + + } + + var cmd tea.Cmd + m.list, cmd = m.list.Update(msg) + return m, cmd + +} + +func (m model) View() string { + return docStyle.Render(m.list.View()) +} + +var docStyle = lipgloss.NewStyle().Margin(1, 2) + +const ( + viewCategories view = iota + viewCommands +) func StartTui(configFilePath ...string) { - var configFilePathString string - if len(configFilePath) > 0 { - configFilePathString = configFilePath[0] - } else { - configFilePathString = "/etc/cheatsh/commands.json" - } - commands, err := loadCommands(configFilePathString) + configFile := "/etc/cheatsh/commands.json" + if len(configFilePath) > 0 { + configFile = configFilePath[0] + } + + commands, err := loadCommands(configFile) if err != nil { log.Fatalf("Cannot load commands file: %v", err) } - app := tview.NewApplication() + // ToDo: Sort Items + // ToDo: Handle readout of file before calling this function - // Sort alphabetically - langs := make([]string, 0, len(commands)) - for lang := range commands { - langs = append(langs, lang) - } - sort.Strings(langs) - - langList := tview.NewList() - langList.SetBorder(true).SetTitle("Select a topic") - - for _, lang := range langs { - lang := lang - langList.AddItem(lang, "", 0, func() { - showCommandList(app, lang, commands[lang], langList) - }) - } - - langList.SetWrapAround(false).SetHighlightFullLine(true) - langList.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey { - if event.Rune() == 'b' || event.Key() == tcell.KeyEscape { - app.Stop() - os.Exit(0) + delegate := list.NewDefaultDelegate() + backKey := key.NewBinding( + key.WithKeys("b"), + key.WithHelp("b", "back"), + ) + delegate.ShortHelpFunc = func() []key.Binding{ + return []key.Binding{ + backKey, } - return event - }) - - if err := app.SetRoot(langList, true).Run(); err != nil { - log.Fatalf("Error initialising TUI: %v", err) } -} - -func showCommandList(app *tview.Application, lang string, cmds []CmdItem, langList *tview.List) { - cmdList := tview.NewList() - cmdList.SetBorder(true).SetTitle(fmt.Sprintf("%s commands", lang)) - - for _, c := range cmds { - c := c - cmdList.AddItem(c.CommandName, c.CommandDescription, 0, func() { - app.Suspend(func() { - fmt.Println(c.CommandName) - }) - app.Stop() - os.Exit(0) - }) - } - - cmdList.SetWrapAround(false).SetHighlightFullLine(true) - cmdList.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey { - if event.Rune() == 'b' || event.Key() == tcell.KeyEscape { - // Restore the language list - app.SetRoot(langList, true) - return nil + delegate.FullHelpFunc = func() [][]key.Binding{ + return [][]key.Binding{ + {backKey}, } - return event - }) + } - app.SetRoot(cmdList, true) + items := cmdMapKeysToList(commands) + l := list.New(items, delegate, 0, 0) + l.Title = "Choose a list of commands" + + m := model{ + list: l, + commands: commands, + currentView: viewCategories, + } + + p := tea.NewProgram(m, tea.WithAltScreen()) + finalModel, err := p.Run() + if err != nil { + fmt.Println("Error running program:", err) + os.Exit(1) + } + + if m, ok := finalModel.(model); ok && m.selectedCmd != "" { + fmt.Println(m.selectedCmd) + } } func loadCommands(path string) (CmdMap, error) { @@ -109,3 +166,31 @@ func loadCommands(path string) (CmdMap, error) { return m, nil } + +func cmdMapKeysToList(m CmdMap) []list.Item { + + items := []list.Item{} + + for name, _ := range m { + listItem := item{ + title: name, + description: "", + } + items = append(items, listItem) + } + return items +} + +func cmdItemsToList(cmds []CmdItem) []list.Item { + + items := []list.Item{} + + for _, command := range cmds { + listItem := item{ + title: command.CommandName, + description: command.CommandDescription, + } + items = append(items, listItem) + } + return items +} From 43b1fbb64cf4a724bb4678f834d468cb369ecd45 Mon Sep 17 00:00:00 2001 From: agres Date: Sat, 18 Oct 2025 00:34:39 +0200 Subject: [PATCH 4/4] Refactored the map to a struct because maps are for some reason not sortable, added sorting --- .gitignore | 3 ++ src/main.go | 80 +++++++++++++++++++++++++++++++++++++++++++++++++---- src/tui.go | 68 ++++++++++----------------------------------- 3 files changed, 93 insertions(+), 58 deletions(-) diff --git a/.gitignore b/.gitignore index fdb3507..e1ddad7 100644 --- a/.gitignore +++ b/.gitignore @@ -57,3 +57,6 @@ dkms.conf # Go bin/* + +# Log Files +log/ diff --git a/src/main.go b/src/main.go index c441ec3..2257da8 100644 --- a/src/main.go +++ b/src/main.go @@ -4,8 +4,32 @@ import ( "fmt" "os" "flag" + "encoding/json" + "log" + "sort" ) +type CmdGroup struct { + Category string + Commands []CmdItem +} + +type CmdList []CmdGroup + +type CmdItem struct { + CommandName string `json:"command"` + CommandDescription string `json:"desc"` +} + +func (list CmdList) Get(category string) []CmdItem { + for _, group := range list { + if group.Category == category { + return group.Commands + } + } + return nil +} + func main() { @@ -15,22 +39,41 @@ func main() { flag.Parse() - if len(os.Args) == 1 { - StartTui() + configFile := "/etc/cheatsh/commands.json" + + var commands CmdList + var err error + + if *configFlag != "" { + commands, err = loadCommands(*configFlag) + if err != nil { + log.Fatalf("Cannot load commands file: %v", err) + } + StartTui(commands) + return + } else if len(os.Args) == 1 { + commands, err = loadCommands(configFile) + if err != nil { + log.Fatalf("Cannot load commands file: %v", err) + } + StartTui(commands) return } switch { + case *helpFlag: printHelp() - case *configFlag != "": - StartTui(*configFlag) + case *newFlag: HandleInput() + default: printHelp() os.Exit(1) + } + } func printHelp() { @@ -38,5 +81,32 @@ func printHelp() { Options: --config Specify a config file --help Show this help message - --new Add a new command to the config file`) + --new Add a new command to the config file`) +} + +func loadCommands(path string) (CmdList, error) { + data, err := os.ReadFile(path) + if err != nil { + return nil, err + } + + var raw map[string][]CmdItem + err = json.Unmarshal(data, &raw) + if err != nil { + return nil, err + } + + cmdList := make(CmdList, 0, len(raw)) + for category, commands := range raw { + cmdList = append(cmdList, CmdGroup{ + Category: category, + Commands: commands, + }) + } + + sort.Slice(cmdList, func(i, j int) bool { + return cmdList[i].Category < cmdList[j].Category + }) + + return cmdList, nil } diff --git a/src/tui.go b/src/tui.go index 5b2f687..49288d2 100644 --- a/src/tui.go +++ b/src/tui.go @@ -1,9 +1,7 @@ package main import ( - "encoding/json" "fmt" - "log" "os" //"sort" //"strings" @@ -15,11 +13,6 @@ import ( "github.com/charmbracelet/lipgloss" ) -type CmdMap map[string][]CmdItem -type CmdItem struct { - CommandName string `json:"command"` - CommandDescription string `json:"desc"` -} type item struct { title string @@ -33,7 +26,7 @@ type view int type model struct { list list.Model - commands CmdMap + commands CmdList currentView view currentKey string selectedCmd string @@ -58,7 +51,7 @@ func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) { m.currentKey = selected.title m.currentView = viewCommands m.list.Title = m.currentKey - m.list.SetItems(cmdItemsToList(m.commands[m.currentKey])) + m.list.SetItems(cmdItemsToList(m.commands.Get(m.currentKey))) } else if m.currentView == viewCommands { m.selectedCmd = selected.title return m, tea.Quit @@ -70,7 +63,7 @@ func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) { if m.currentView == viewCommands { m.currentView = viewCategories m.list.Title = "Choose a list of commands" - m.list.SetItems(cmdMapKeysToList(m.commands)) + m.list.SetItems(cmdListKeysToList(m.commands)) } } @@ -98,20 +91,7 @@ const ( viewCommands ) -func StartTui(configFilePath ...string) { - - configFile := "/etc/cheatsh/commands.json" - if len(configFilePath) > 0 { - configFile = configFilePath[0] - } - - commands, err := loadCommands(configFile) - if err != nil { - log.Fatalf("Cannot load commands file: %v", err) - } - - // ToDo: Sort Items - // ToDo: Handle readout of file before calling this function +func StartTui(commands CmdList) { delegate := list.NewDefaultDelegate() backKey := key.NewBinding( @@ -129,7 +109,7 @@ func StartTui(configFilePath ...string) { } } - items := cmdMapKeysToList(commands) + items := cmdListKeysToList(commands) l := list.New(items, delegate, 0, 0) l.Title = "Choose a list of commands" @@ -151,34 +131,16 @@ func StartTui(configFilePath ...string) { } } -func loadCommands(path string) (CmdMap, error) { - - data, err := os.ReadFile(path) - if err != nil { - return nil, err - } - - var m CmdMap - err = json.Unmarshal(data, &m) - if err != nil { - return nil, err - } - - return m, nil -} - -func cmdMapKeysToList(m CmdMap) []list.Item { - - items := []list.Item{} - - for name, _ := range m { - listItem := item{ - title: name, - description: "", - } - items = append(items, listItem) - } - return items +func cmdListKeysToList(cmds CmdList) []list.Item { + items := []list.Item{} + for _, group := range cmds { + listItem := item{ + title: group.Category, + description: "", + } + items = append(items, listItem) + } + return items } func cmdItemsToList(cmds []CmdItem) []list.Item {