[v3] Add basic support for config + add screenshots & gif to readme (#71)

* add journal file as config

* add config struct

* add support for config file

* add new gif for v3

* update Readme and add screenshots

* fix readme

* fix collapsible section

* update demo_v3 tape file

Author: siddhantac

Makefile

@@ -26,6 +26,10 @@ test:
 demo:
 	vhs demo.tape
 
+demov3:
+	vhs home_v3.tape
+	vhs reports_v3.tape
+
 release:
 	GITHUB_TOKEN=$(GITHUB_TOKEN) goreleaser release --clean
 

README.md

@@ -33,6 +33,26 @@ To try V3, you can update to the latest version and run
 
 Please note, **v3 does not use a config file yet**. So if you are using a config file with v2 then it won't be used with v3.
 
+## Demo
+
+![demo](assets/demo_v3.gif)
+
+### Screenshots
+
+<details>
+<summary>Home</summary>
+
+![home](assets/screenshot_home_v3.png)
+
+</details>
+
+<details>
+<summary>Reports</summary>
+
+![reports](assets/screenshot_reports_v3.png)
+
+</details>
+
 ## V3 roadmap
 - [x] Accounts table
 - [x] Balance table

assets/demo_v3.gif

@@ -0,0 +1,3 @@
+{
+    "journalFile": "data/hledger.journal"
+}

assets/screenshot_home_v3.png

@@ -0,0 +1,40 @@
+Output assets/home_v3.gif
+Set Shell zsh
+Set Width 1920
+Set Height 1200
+Set Framerate 30
+Set FontSize 16
+
+Type "go run . -v3 -cfg config_v3.json"
+Enter
+Sleep 2s
+Type "jj"
+Sleep 1s
+Type "2jj"
+Sleep 1s
+Type "j"
+Sleep 1s
+Type "jj"
+Sleep 1s
+
+Type "3j"
+Sleep 1s
+Type "1"
+Sleep 1s
+Type "kk"
+Sleep 1s
+Type "2j"
+Sleep 1s
+Enter
+Sleep 1s
+Type "j3"
+Sleep 1s
+
+Sleep 1s
+Tab
+Sleep 3s
+Type "2"
+Sleep 1s
+
+Type "qq"
+

assets/screenshot_reports_v3.png

@@ -18,7 +18,15 @@ func main() {
 	flag.Parse()
 
 	if runV3 {
-		v3.Start(isDebug)
+		var cfg v3.Config
+		if configFile != "" {
+			var err error
+			cfg, err = v3.NewConfig(configFile)
+			if err != nil {
+				log.Fatal(err)
+			}
+		}
+		v3.Start(cfg, isDebug)
 	} else {
 		cfg := ui.DefaultConfig
 		if configFile != "" {

config_v3.json

@@ -0,0 +1,29 @@
+package ui
+
+import (
+	"encoding/json"
+	"io"
+	"os"
+)
+
+type Config struct {
+	JournalFile string `json:"journalFile"`
+}
+
+func NewConfig(configFile string) (Config, error) {
+	file, err := os.Open(configFile)
+	if err != nil {
+		return Config{}, err
+	}
+
+	return parseJSON(file)
+}
+
+func parseJSON(file io.Reader) (Config, error) {
+	var cfg Config
+	if err := json.NewDecoder(file).Decode(&cfg); err != nil {
+		return cfg, err
+	}
+
+	return cfg, nil
+}

demo_v3.tape

@@ -13,10 +13,20 @@ import (
 )
 
 type HledgerData struct {
+	journalFile string
+}
+
+func NewHledgerData(journalFile string) HledgerData {
+	return HledgerData{
+		journalFile: journalFile,
+	}
 }
 
 func (hd HledgerData) runCommand(args []string) (io.Reader, error) {
 	log.Printf("data: command: %v", args)
+	if hd.journalFile != "" {
+		args = append(args, "-f", hd.journalFile)
+	}
 	cmd := exec.Command("hledger", args...)
 	stdout, err := cmd.StdoutPipe()
 	if err != nil {