Fix TUI newline display issue

- Add processEscapeSequences() function to convert literal \n to actual newlines
- Apply fix to backup success, error, and running output displays
- Add TUI binary to gitignore
- Include comprehensive documentation of the fix

Resolves issue where backup output showed literal escape sequences
instead of properly formatted text with line breaks.
This commit is contained in:
Peter Wood
2025-05-30 10:03:43 -04:00
parent 374da47bf5
commit d6c76ac146
3 changed files with 87 additions and 3 deletions

View File

@@ -0,0 +1,64 @@
# TUI Newline Fix Implementation Summary
## Problem
The TUI application was displaying literal `\n` characters as text strings instead of rendering them as actual line breaks in the right-hand panel when viewing backup output.
## Root Cause
Backup scripts were outputting literal escape sequences (e.g., `\n`, `\t`, `\r`) as text strings, which were being displayed directly in the TUI viewport without processing.
## Solution
Implemented a `processEscapeSequences()` helper function that converts literal escape sequences to their actual character representations before displaying content in the viewport.
## Implementation Details
### 1. Added Helper Function
```go
// Helper function to process escape sequences in output text
func processEscapeSequences(text string) string {
processed := strings.ReplaceAll(text, "\\n", "\n")
processed = strings.ReplaceAll(processed, "\\t", "\t")
processed = strings.ReplaceAll(processed, "\\r", "\r")
return processed
}
```
### 2. Integration Points
The function is called in three key locations where backup output is displayed:
1. **Backup Success Messages** (line ~584)
```go
processedOutput := processEscapeSequences(msg.output)
```
2. **Backup Error Messages** (line ~621)
```go
processedError := processEscapeSequences(msg.error)
```
3. **Running Backup Output** (line ~677)
```go
processedOutput := processEscapeSequences(outputForDisplay)
```
## Testing
- Created test scripts that generate literal escape sequences
- Verified the fix converts `\n` to actual newlines
- Confirmed TUI compiles and runs successfully
- Tested with demonstration scripts
## Files Modified
- `/home/acedanger/shell/tui/main.go` - Main TUI application
## Files Created for Testing
- `/home/acedanger/shell/test-plex-backup.sh` - Test script with literal newlines
- `/home/acedanger/shell/test-newline-fix.go` - Standalone test of the fix
- `/home/acedanger/shell/demonstrate-newline-fix.sh` - Demonstration script
## Result
**Issue Resolved**: The TUI now properly displays newlines, tabs, and carriage returns in backup output instead of showing them as literal escape sequence characters.
## Usage
The fix is automatically applied to all backup output displayed in the TUI. No user action required - the escape sequence processing happens transparently.
---
*Fix implemented on May 30, 2025*