docs: render previews for daemon/tui events handling (#54)

## What does this PR do?

Minor docs changes; adds ./preview/daemon that works like a test but
invokes vhs to render gifs for daemon preview of the event handling
scenarios.

Author: fiffeek

Makefile

@@ -250,6 +250,12 @@ record/preview: build/docs
 	@git checkout -- ./preview/tapes/configs/
 	@git clean -fd ./preview/tapes/configs/
 
+record/preview/daemon/selected: build/docs
+	@$(GOTESTSUM) -- ./preview/daemon/ -v -count=1 -run $(TEST_SELECTOR)
+
+record/preview/daemon: build/docs
+	@$(GOTESTSUM) -- ./preview/daemon/ -v -count=1
+
 demo: record/preview
 
 record/previews: build/docs

README.md

@@ -18,13 +18,21 @@ An event-driven service with an interactive TUI that automatically manages Hyprl
 
 ## Preview
 
-![demo](./preview/output/demo.gif)
+### Full TUI demo
+
+![TUI demo](./preview/output/demo.gif)
+
+### Daemon Render on async power events
+
+![power events demo](./preview/output/power_events.gif)
 
 ## Table Of Contents
 
 <!--ts-->
 * [HyprDynamicMonitors](#hyprdynamicmonitors)
    * [Preview](#preview)
+      * [Full TUI demo](#full-tui-demo)
+      * [Daemon Render on async power events](#daemon-render-on-async-power-events)
    * [Table Of Contents](#table-of-contents)
    * [Features](#features)
    * [Quick Start](#quick-start)

cmd/tui.go

@@ -31,6 +31,9 @@ var tuiCmd = &cobra.Command{
 			}
 			logrus.SetOutput(f)
 			defer f.Close()
+		} else {
+			// disable logging completely for tui unless run in the debug mode
+			logrus.SetLevel(logrus.PanicLevel)
 		}
 
 		if runningUnderTest {

docs/docs/configuration/lid-events.md

@@ -6,6 +6,8 @@ sidebar_position: 7
 
 Lid state monitoring uses D-Bus to listen for UPower lid events. This feature is optional and needs to be explicitly enabled.
 
+![Lid events](/previews/lid_events.gif)
+
 ## Enabling Lid Events
 
 To enable lid state monitoring:

docs/docs/configuration/power-events.md

@@ -6,6 +6,8 @@ sidebar_position: 4
 
 Power state monitoring uses D-Bus to listen for UPower events. This allows profiles and templates to react to AC/battery power changes.
 
+![Power events](/previews/power_events.gif)
+
 ## Disabling Power Events
 
 To disable power state monitoring entirely:

docs/docs/intro.md

@@ -8,9 +8,15 @@ slug: /
 HyprDynamicMonitors is an event-driven service that automatically manages Hyprland monitor configurations based on connected displays and power state.
 It also provides a standalone TUI that can be used for ad-hoc modifications and profile management.
 
-# Preview
+## Preview
 
-![Adjusting monitor scaling](/previews/demo.gif)
+### Full TUI Preview
+
+![Demo](/previews/demo.gif)
+
+### Async Events
+
+![Events](/previews/lid_tui.gif)
 
 ## Features
 

internal/testutils/hypr.go

@@ -89,6 +89,12 @@ func respondToHyprIPC(t *testing.T, listener net.Listener, exitOnError bool, com
 }
 
 func SetupFakeHyprEventsServer(ctx context.Context, t *testing.T, listener net.Listener, events []string) chan struct{} {
+	return SetupFakeHyprEventsServerWithSleep(ctx, t, listener, events, nil, 10*time.Millisecond)
+}
+
+func SetupFakeHyprEventsServerWithSleep(ctx context.Context, t *testing.T, listener net.Listener,
+	events []string, initialSleep *time.Duration, sleepBetweenEvents time.Duration,
+) chan struct{} {
 	serverDone := make(chan struct{})
 	go func() {
 		defer func() {
@@ -112,6 +118,10 @@ func SetupFakeHyprEventsServer(ctx context.Context, t *testing.T, listener net.L
 		Logf(t, "Fake Hypr events server: accepted connection, ready to send events")
 
 		for i, event := range events {
+			if initialSleep != nil {
+				time.Sleep(*initialSleep)
+			}
+
 			select {
 			case <-ctx.Done():
 				Logf(t, "Fake Hypr events server: context cancelled while sending events")
@@ -124,7 +134,7 @@ func SetupFakeHyprEventsServer(ctx context.Context, t *testing.T, listener net.L
 				return
 			}
 			Logf(t, "Wrote event %d on the event socket: %s", i, event)
-			time.Sleep(10 * time.Millisecond)
+			time.Sleep(sleepBetweenEvents)
 		}
 
 		Logf(t, "Fake Hypr events server: finished sending %d events, waiting for context cancellation", len(events))

internal/tui/hdm_config_pane.go

@@ -263,6 +263,12 @@ func (h *HDMConfigPane) renderProfileDetails(profile *config.Profile) string {
 		content.WriteString("\n")
 	}
 
+	if profile.Conditions != nil && profile.Conditions.LidState != nil {
+		content.WriteString(configDetailLabelStyle.Render("Lid State: "))
+		content.WriteString(configDetailStyle.Render(profile.Conditions.LidState.Value()))
+		content.WriteString("\n")
+	}
+
 	if profile.Conditions != nil && profile.Conditions.RequiredMonitors != nil {
 		content.WriteString(configDetailLabelStyle.Render("Required Monitors:"))
 		content.WriteString("\n")

internal/tui/header_test.go

@@ -42,7 +42,7 @@ func TestHeader_Update(t *testing.T) {
 			setupMsg:        tui.OperationStatusCmd(tui.OperationNameMatchingProfile, testErr),
 			expectedMode:    "",
 			expectedView:    tui.ViewMode(0),
-			expectedErr:     "Matching Profile: test error",
+			expectedErr:     "Reload Profile: test error",
 			expectedSuccess: "",
 		},
 		{
@@ -55,7 +55,7 @@ func TestHeader_Update(t *testing.T) {
 		},
 		{
 			name:            "OperationStatus success without showSuccessToUser",
-			setupMsg:        tui.OperationStatusCmd(tui.OperationNameMatchingProfile, nil),
+			setupMsg:        tui.OperationStatusCmd(tui.OperationNameMove, nil),
 			expectedMode:    "",
 			expectedView:    tui.ViewMode(0),
 			expectedErr:     "",

internal/tui/messages.go

@@ -140,7 +140,7 @@ func (o OperationStatus) String() string {
 	case OperationNameCreateProfile:
 		operationName = "Create Profile"
 	case OperationNameMatchingProfile:
-		operationName = "Matching Profile"
+		operationName = "Reload Profile"
 	case OperationNameEditProfile:
 		operationName = "Edit Profile"
 	case OperationNameHDMConfigReloadRequested:
@@ -181,6 +181,7 @@ func OperationStatusCmd(name OperationName, err error) tea.Cmd {
 		OperationNameToggleVRR,
 		OperationNameNextBitdepth,
 		OperationNameSetColorPreset,
+		OperationNameMatchingProfile,
 	}
 	showSuccessToUser := slices.Contains(criticalOperations, name)
 	return func() tea.Msg {