feat: add calendar tab (#37)

* feat: boilerplate code for new tab * feat: more boilerplate * feat: working calendar view with view mode selection * refactor: remove calendar modes * feat: better calendar controls (frees tab for pane focus) * refactor: export calendar to widgets * feat: timeline view based on selected date * feat: mark days with tasks on calendars * fix: crash on empty vault * refactor: rename Timeline tab to Calendar * feat: only show 3 months in calendar * style: make clippy happy * fix: Wrong year when selecting January or December * fix: reload vault in calendar * feat: show days with tasks even when selected or previewed (underlined) * chore: small changes to example files * feat: add cli command to open calendar view * feat: populate footer * feat: add calendar legend * feat: display selected date * fix: tab switching didn't take calendar into account * chore: add vhs to flake * docs: update examples * docs: add calendar to readme * docs: typo * docs: add demo description * feat: goto today command * docs: add goto today command
louis-thevenet · Jan 1, 2025 · 20120cd · 20120cd
1 parent 95b166a
commit 20120cd
Show file tree

Hide file tree

Showing 37 changed files with 760 additions and 89 deletions.
diff --git a/.config/config.toml b/.config/config.toml
@@ -1,3 +1,41 @@
+[keybindings.Calendar]
+# App
+"<q>" = "Quit"
+"<Ctrl-c>" = "Quit"
+"<Ctrl-z>" = "Suspend"
+"<?>" = "Help"
+# Tabs
+"<Shift-Right>" = "TabRight"
+"<Shift-l>" = "TabRight"
+"<Shift-Left>" = "TabLeft"
+"<shift-h>" = "TabLeft"
+# Scrolling
+"<Ctrl-u>" = "ViewUp"
+"<Ctrl-k>" = "ViewUp"
+"<Ctrl-Up>" = "ViewUp"
+"<PageUp>" = "ViewPageUp"
+"<Ctrl-j>" = "ViewDown"
+"<Ctrl-d>" = "ViewDown"
+"<Ctrl-Down>" = "ViewDown"
+"<PageDown>" = "ViewPageDown"
+# Navigation
+"<r>" = "ReloadVault"
+"<t>" = "GotoToday"
+"<j>" = "Down"
+"<Down>" = "Down"
+"<k>" = "Up"
+"<Up>" = "Up"
+"<h>" = "Left"
+"<Left>" = "Left"
+"<l>" = "Right"
+"<Right>" = "Right"
+"<Shift-j>" = "NextMonth"
+"<Shift-Down>" = "NextMonth"
+"<Shift-k>" = "PreviousMonth"
+"<Shift-Up>" = "PreviousMonth"
+"<n>" = "NextYear"
+"<Shift-n>" = "PreviousYear"
+
 [keybindings.Explorer]
 # App
 "<q>" = "Quit"

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -24,14 +24,14 @@ futures = "0.3.31"
 human-panic = "2.0.2"
 lazy_static = "1.5.0"
 libc = "0.2.167"
-ratatui = {version = "0.29.0", features = ["serde", "macros"]}
+ratatui = {version = "0.29.0", features = ["serde", "macros", "widget-calendar"]}
 signal-hook = "0.3.17"
 strip-ansi-escapes = "0.2.0"
 tokio = {version = "1.41.1", features = ["full"]}
 tokio-util = "0.7.12"
 tracing-error = "0.2.1"
 tracing-subscriber = {version = "0.3.19", features = ["env-filter", "serde"]}
-chrono = "0.4.38"
+chrono = {version="0.4.38"}
 tui-widget-list = "0.13.0"
 tui-input = "0.11.1"
 edit = "0.1.5"
@@ -46,6 +46,7 @@ strum_macros = "0.26.4"
 notify-rust = "4.11.3"
 lexical-sort = "0.3.1"
 winnow = "0.6.20"
+time = "0.3.37"
 
 [dev-dependencies]
 insta = {version = "1.41.1", features = ["yaml"]}

diff --git a/README.md b/README.md
@@ -1,9 +1,20 @@
-onfig Vault-tasks
+# Vault-tasks
 
 `vault-tasks` is a TUI Markdown task manager.
 
 It will parse any Markdown file or vault and display the tasks it contains.
 
+## Demo using `./test-vault`
+
+```
+test-vault
+├── chocolate_lava_cake.md
+├── daily_workout.md
+├── diy_bookshelf.md
+├── study_plan.md
+└── test.md
+```
+
 ![Demo](./examples/demo_full.gif)
 
 ## Why
@@ -24,13 +35,13 @@ I also spend most of my writing time in the terminal (Helix) and do not rely on
   - priority
 - Navigate vault
 - Search through tasks (sort and filter)
+- Calendar view and timeline
 - Edit tasks or open in default editor
 - Time Management tab (Pomodoro & Flowtime)
 
 ## Planned Features
 
 - `new` action in Explorer Tab to create a new child on selected entry
-- A Timeline tab with a calendar and a chronological view. (I'd also like to be able to import calendar files)
 
 ## Installation
 
@@ -162,6 +173,29 @@ Check the key map within the app with `?`
 
 ![](./examples/demo_filter.gif)
 
+#### Calendar Tab
+
+##### Navigation
+
+| Key       | Alternate Key | Action   |
+| --------- | ------------- | -------- |
+| `h`       | `←`           | +1 day   |
+| `l`       | `→`           | -1 day   |
+| `j`       | `↓`           | +7 days  |
+| `k`       | `↑`           | -7 days  |
+| `Shift-j` | `Shift-↓`     | +1 month |
+| `Shift-k` | `Shift-↑`     | -1 month |
+| `n`       |               | +1 year  |
+| `Shift-n` |               | -1 year  |
+
+##### Commands
+
+| Key | Action     |
+| --- | ---------- |
+| `t` | Goto Today |
+
+![](./examples/demo_calendar.gif)
+
 #### Time Management Tab
 
 ##### Navigation
@@ -192,6 +226,7 @@ vault-tasks explorer # is the default
 # Or
 vault-tasks filter
 vault-tasks time
+vault-tasks calendar
 ```
 
 You can also output the content of a vault in standard output using

diff --git a/examples/demo_calendar.gif b/examples/demo_calendar.gif
diff --git a/examples/demo_calendar.mp4 b/examples/demo_calendar.mp4
diff --git a/examples/demo_calendar.tape b/examples/demo_calendar.tape
@@ -0,0 +1,35 @@
+Output ./demo_calendar.gif
+Output ./demo_calendar.mp4
+
+Set Shell zsh
+Set Theme "Builtin Solarized Light"
+Set TypingSpeed 80ms
+Set FontSize 22
+Set Width 1800
+Set Height 1000
+
+Hide
+Type "vault-tasks -c ../.config/ -v ../test-vault calendar"
+Enter
+Show
+# Calendar tab
+# 
+Sleep 2.5s
+
+Right
+Sleep 2s
+Right@0.5s 4
+Sleep 2s
+
+Right@0.5s 3
+Sleep 1s
+Right@1s 2
+Sleep 1s
+
+Shift+k
+Sleep 1s
+Up@0.5s 3
+
+# Stop vault-tasks
+Ctrl+c
+
diff --git a/examples/demo_explorer.gif b/examples/demo_explorer.gif
diff --git a/examples/demo_explorer.mp4 b/examples/demo_explorer.mp4
diff --git a/examples/demo_explorer.tape b/examples/demo_explorer.tape
@@ -8,10 +8,12 @@ Set Theme "Builtin Solarized Light"
 Set TypingSpeed 80ms
 Set FontSize 22
 Set Width 1800
-Set Height 800
+Set Height 1000
 
+Hide
 Type "vault-tasks -c ../.config/ -v ../test-vault explorer"
 Enter
+Show
 
 # First entry
 Sleep 3s

diff --git a/examples/demo_filter.gif b/examples/demo_filter.gif
diff --git a/examples/demo_filter.mp4 b/examples/demo_filter.mp4
diff --git a/examples/demo_filter.tape b/examples/demo_filter.tape
@@ -6,10 +6,12 @@ Set Theme "Builtin Solarized Light"
 Set TypingSpeed 80ms
 Set FontSize 22
 Set Width 1800
-Set Height 800
+Set Height 1000
 
+Hide
 Type "vault-tasks -c ../.config/ -v ../test-vault filter"
 Enter
+Show
 
 Sleep 3s
 Type "#tobuy 09/29"

diff --git a/examples/demo_full.gif b/examples/demo_full.gif
diff --git a/examples/demo_full.mp4 b/examples/demo_full.mp4
diff --git a/examples/demo_full.tape b/examples/demo_full.tape
@@ -13,8 +13,9 @@ Set TypingSpeed 80ms
 Set FontSize 22
 Set FontSize 22
 Set Width 1800
-Set Height 800
+Set Height 1000
 
 Source ./demo_explorer.tape
 Source ./demo_filter.tape
+Source ./demo_calendar.tape
 Source ./demo_time.tape
diff --git a/examples/demo_full.webm b/examples/demo_full.webm
diff --git a/examples/demo_time.gif b/examples/demo_time.gif
diff --git a/examples/demo_time.mp4 b/examples/demo_time.mp4
diff --git a/examples/demo_time.tape b/examples/demo_time.tape
@@ -6,10 +6,12 @@ Set Theme "Builtin Solarized Light"
 Set TypingSpeed 80ms
 Set FontSize 22
 Set Width 1800
-Set Height 800
+Set Height 1000
 
+Hide
 Type "vault-tasks -c ../.config/ -v ../test-vault time"
 Enter
+Show
 
 # Time Management tab
 Sleep 1s

diff --git a/examples/justfile b/examples/justfile
@@ -1,6 +1,7 @@
 make-all-vhs:
     vhs < ./demo_explorer.tape
     vhs < ./demo_filter.tape
+    vhs < ./demo_calendar.tape
     vhs < ./demo_time.tape
     git checkout HEAD -- ../test-vault/test.md # it is edited during explorer demo
     vhs < ./demo_full.tape

diff --git a/src/action.rs b/src/action.rs
@@ -19,6 +19,11 @@ pub enum Action {
     Key(KeyEvent),
     ReloadVault,
     // Movements
+    GotoToday,
+    NextMonth,
+    PreviousMonth,
+    NextYear,
+    PreviousYear,
     PreviousMethod,
     NextMethod,
     NextSegment,

diff --git a/src/app.rs b/src/app.rs
@@ -9,8 +9,8 @@ use crate::{
     action::Action,
     cli::{Cli, Commands},
     components::{
-        explorer_tab::ExplorerTab, filter_tab::FilterTab, fps::FpsCounter, home::Home,
-        time_management_tab::TimeManagementTab, Component,
+        calendar_tab::CalendarTab, explorer_tab::ExplorerTab, filter_tab::FilterTab,
+        fps::FpsCounter, home::Home, time_management_tab::TimeManagementTab, Component,
     },
     config::Config,
     tui::{Event, Tui},
@@ -41,6 +41,7 @@ pub enum Mode {
     Explorer,
     Filter,
     TimeManagement,
+    Calendar,
 }
 
 impl App {
@@ -56,6 +57,7 @@ impl App {
                 Box::<FpsCounter>::default(),
                 Box::new(ExplorerTab::new()),
                 Box::new(FilterTab::new()),
+                Box::new(CalendarTab::new()),
                 Box::new(TimeManagementTab::new()),
             ],
             should_quit: false,
@@ -72,6 +74,7 @@ impl App {
         let tab = match args.command {
             Some(Commands::Filter) => Action::Focus(Mode::Filter),
             Some(Commands::TimeManagement) => Action::Focus(Mode::TimeManagement),
+            Some(Commands::Calendar) => Action::Focus(Mode::Calendar),
             Some(Commands::Explorer | Commands::GenerateConfig { path: _ }) | None => {
                 Action::Focus(Mode::Explorer)
             }

diff --git a/src/cli.rs b/src/cli.rs
@@ -37,6 +37,9 @@ pub enum Commands {
     /// Open Time Management view
     #[command(alias = "time")]
     TimeManagement,
+    /// Open Calendar view
+    #[command(alias = "cld")]
+    Calendar,
     /// Generates a new configuration file from the default one
     GenerateConfig { path: Option<PathBuf> },
     /// Write tasks to STDOUT

diff --git a/src/components.rs b/src/components.rs
@@ -12,6 +12,7 @@ use crate::{
     tui::{Event, Tui},
 };
 
+pub mod calendar_tab;
 pub mod explorer_tab;
 pub mod filter_tab;
 pub mod fps;