Merge pull request #825 from yorukot/develop

fix: convert unicode space to normal space, use rendered in file preview to fix layout bugs, Release 1.3.0

Author: lazysegtree

flake.nix

@@ -27,7 +27,7 @@
         packages = rec {
           superfile = pkgs.buildGoApplication {
             pname = "superfile";
-            version = "1.2.1";
+            version = "1.3.0";
             src = ./.;
             modules = ./gomod2nix.toml;
           };

release/release.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env -S bash -euo pipefail
 
 projectName="superfile"
-version="v1.2.1"
+version="v1.3.0"
 osList=("darwin" "linux" "windows")
 archList=("amd64" "arm64")
 mkdir dist

src/config/fixed_variable.go

@@ -11,7 +11,7 @@ import (
 )
 
 const (
-	CurrentVersion      = "v1.2.1"
+	CurrentVersion      = "v1.3.0"
 	LatestVersionURL    = "https://api.github.com/repos/yorukot/superfile/releases/latest"
 	LatestVersionGithub = "github.com/yorukot/superfile/releases/latest"
 

src/internal/common/predefined_variable.go

@@ -32,9 +32,19 @@ var (
 	FilePanelTopDirectoryIcon string
 	FilePanelNoneText         string
 
+	FilePreviewNoContentText           string
+	FilePreviewNoFileInfoText          string
+	FilePreviewUnsupportedFormatText   string
+	FilePreviewDirectoryUnreadableText string
+	FilePreviewEmptyText               string
+
 	LipglossError string
 )
 
+var (
+	UnsupportedPreviewFormats = []string{".pdf", ".torrent"}
+)
+
 // No dependencies
 func LoadInitialPrerenderedVariables() {
 	LipglossError = lipgloss.NewStyle().Foreground(lipgloss.Color("#F93939")).Render("Error") +
@@ -59,4 +69,10 @@ func LoadPrerenderedVariables() {
 
 	FilePanelTopDirectoryIcon = FilePanelTopDirectoryIconStyle.Render(" " + icon.Directory + icon.Space)
 	FilePanelNoneText = FilePanelStyle.Render(" " + icon.Error + "  No such file or directory")
+
+	FilePreviewNoContentText = "--- " + icon.Error + " No content to preview ---"
+	FilePreviewNoFileInfoText = "--- " + icon.Error + " Could not get file info ---"
+	FilePreviewUnsupportedFormatText = "--- " + icon.Error + " Unsupported formats ---"
+	FilePreviewDirectoryUnreadableText = "--- " + icon.Error + " Cannot read directory ---"
+	FilePreviewEmptyText = "--- Empty ---"
 }

src/internal/common/string_function.go

@@ -200,8 +200,36 @@ func MakePrintableWithEscCheck(line string, allowEsc bool) string {
 		if r == utf8.RuneError {
 			continue
 		}
-		if r > 0x7f || unicode.IsGraphic(r) ||
-			r == rune('\t') || r == rune('\n') || (allowEsc && r == rune('\x1b')) {
+		// It needs to be handled separately since considered a space,
+		// It is multi-byte in UTF-8, But it has zero display width
+		if r == 0xa0 {
+			sb.WriteRune(r)
+			continue
+		}
+		// It needs to be handled separately since considered a space,
+		// Since we are using ansi.StringWidth() for truncation, and \t is
+		// considered zero width
+		if r == '\t' {
+			sb.WriteString("    ")
+			continue
+		}
+		if r == 0x1b {
+			if allowEsc {
+				sb.WriteRune(r)
+			}
+			continue
+		}
+		if r > 0x7f {
+			if unicode.IsSpace(r) && utf8.RuneLen(r) > 1 {
+				// See https://github.com/charmbracelet/x/issues/466
+				// Space chacters spanning more than one bytes are not handled well by
+				// ansi.Wrap(), and so lipgloss.Render() has issues
+				r = ' '
+			}
+			sb.WriteRune(r)
+			continue
+		}
+		if unicode.IsGraphic(r) || r == rune('\n') {
 			sb.WriteRune(r)
 		}
 	}

src/internal/common/string_function_test.go

@@ -127,7 +127,7 @@ func TestMakePrintable(t *testing.T) {
 		{"", ""},
 		{"hello", "hello"},
 		{"abcdABCD0123~!@#$%^&*()_+-={}|:\"<>?,./;'[]", "abcdABCD0123~!@#$%^&*()_+-={}|:\"<>?,./;'[]"},
-		{"Horizontal Tab and NewLine\t\t\n\n", "Horizontal Tab and NewLine\t\t\n\n"},
+		{"Horizontal Tab and NewLine\t\t\n\n", "Horizontal Tab and NewLine        \n\n"},
 		{"(NBSP)\u00a0\u00a0\u00a0\u00a0;", "(NBSP)\u00a0\u00a0\u00a0\u00a0;"},
 		{"\x0b(Vertical Tab)", "(Vertical Tab)"},
 		{"\x0d(CR)", "(CR)"},
@@ -141,12 +141,14 @@ func TestMakePrintable(t *testing.T) {
 		{"Invalid Unicodes\ufffd", "Invalid Unicodes"},
 		{"Invalid Unicodes\xa0", "Invalid Unicodes"},
 		{"Ascii color sequence\x1b[38;2;230;219;116;48;2;39;40;34m\ue68f \x1b[0m", "Ascii color sequence\x1b[38;2;230;219;116;48;2;39;40;34m\ue68f \x1b[0m"},
+		{"Unicodes spaces\u202f\u205f\u2029", "Unicodes spaces   "},
+		{"IDEOGRAPHIC SPACE\u3000", "IDEOGRAPHIC SPACE "},
 	}
 	for _, tt := range inputs {
 		t.Run(fmt.Sprintf("Make %q printable", tt.input), func(t *testing.T) {
 			result := MakePrintable(tt.input)
 			if result != tt.expected {
-				t.Errorf("Expected %v, got %v", tt.expected, result)
+				t.Errorf("Expected '%v', got '%v' (input : '%v')", tt.expected, result, tt.input)
 			}
 		})
 	}

src/internal/model_render.go

@@ -10,6 +10,7 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"slices"
 	"sort"
 	"strconv"
 	"strings"
@@ -22,6 +23,7 @@ import (
 
 	"github.com/alecthomas/chroma/v2/lexers"
 	"github.com/charmbracelet/lipgloss"
+	"github.com/charmbracelet/x/exp/term/ansi"
 	"github.com/yorukot/ansichroma"
 	"github.com/yorukot/superfile/src/config/icon"
 	filepreview "github.com/yorukot/superfile/src/pkg/file_preview"
@@ -537,8 +539,6 @@ func (m *model) sortOptionsRender() string {
 }
 
 func readFileContent(filepath string, maxLineLength int, previewLine int) (string, error) {
-	// String builder is much better for efficiency
-	// See - https://stackoverflow.com/questions/1760757/how-to-efficiently-concatenate-strings-in-go/47798475#47798475
 	var resultBuilder strings.Builder
 	file, err := os.Open(filepath)
 	if err != nil {
@@ -550,12 +550,9 @@ func readFileContent(filepath string, maxLineLength int, previewLine int) (strin
 	lineCount := 0
 	for scanner.Scan() {
 		line := scanner.Text()
-		if len(line) > maxLineLength {
-			line = line[:maxLineLength]
-		}
-		// This is critical to avoid layout break, removes non Printable ASCII control characters.
-		line = common.MakePrintable(line)
-		resultBuilder.WriteString(line + "\n")
+		line = ansi.Truncate(line, maxLineLength, "")
+		resultBuilder.WriteString(line)
+		resultBuilder.WriteRune('\n')
 		lineCount++
 		if previewLine > 0 && lineCount >= previewLine {
 			break
@@ -566,14 +563,21 @@ func readFileContent(filepath string, maxLineLength int, previewLine int) (strin
 }
 
 func (m *model) filePreviewPanelRender() string {
-	previewLine := m.mainPanelHeight + 2
+	// Todo : This width adjustment must not be done inside render function. It should
+	// only be triggered via Update()
 	m.fileModel.filePreview.width += m.fullWidth - common.Config.SidebarWidth - m.fileModel.filePreview.width - ((m.fileModel.width + 2) * len(m.fileModel.filePanels)) - 2
 
+	return m.filePreviewPanelRenderWithDimensions(m.mainPanelHeight+2, m.fileModel.filePreview.width)
+}
+
+func (m *model) filePreviewPanelRenderWithDimensions(previewHeight int, previewWidth int) string {
 	panel := m.fileModel.filePanels[m.filePanelFocusIndex]
-	box := common.FilePreviewBox(previewLine, m.fileModel.filePreview.width)
+	box := common.FilePreviewBox(previewHeight, previewWidth)
+	r := ui.FilePreviewPanelRenderer(previewHeight, previewWidth)
 
 	if len(panel.element) == 0 {
-		return box.Render("\n --- " + icon.Error + " No content to preview ---")
+		r.AddLines(common.FilePreviewNoContentText)
+		return r.Render()
 	}
 	// This could create errors if panel.cursor ever becomes negative, or goes out of bounds
 	// We should have a panel validation function in our View() function
@@ -591,27 +595,30 @@ func (m *model) filePreviewPanelRender() string {
 
 	if infoErr != nil {
 		slog.Error("Error get file info", "error", infoErr)
-		return box.Render("\n --- " + icon.Error + " Error get file info ---")
+		r.AddLines(common.FilePreviewNoFileInfoText)
+		return r.Render()
 	}
 
 	ext := filepath.Ext(itemPath)
 	// check if the file is unsupported file, cuz pdf will cause error
-	if ext == ".pdf" || ext == ".torrent" {
-		return box.Render("\n --- " + icon.Error + " Unsupported formats ---")
+	if slices.Contains(common.UnsupportedPreviewFormats, ext) {
+		r.AddLines(common.FilePreviewUnsupportedFormatText)
+		return r.Render()
 	}
 
 	if fileInfo.IsDir() {
-		directoryContent := ""
 		dirPath := itemPath
 
 		files, err := os.ReadDir(dirPath)
 		if err != nil {
 			slog.Error("Error render directory preview", "error", err)
-			return box.Render("\n --- " + icon.Error + " Error render directory preview ---")
+			r.AddLines(common.FilePreviewDirectoryUnreadableText)
+			return r.Render()
 		}
 
 		if len(files) == 0 {
-			return box.Render("\n --- empty ---")
+			r.AddLines(common.FilePreviewEmptyText)
+			return r.Render()
 		}
 
 		sort.Slice(files, func(i, j int) bool {
@@ -624,15 +631,17 @@ func (m *model) filePreviewPanelRender() string {
 			return files[i].Name() < files[j].Name()
 		})
 
-		for i := 0; i < previewLine && i < len(files); i++ {
+		for i := 0; i < previewHeight && i < len(files); i++ {
 			file := files[i]
-			directoryContent += common.PrettierDirectoryPreviewName(file.Name(), file.IsDir(), common.FilePanelBGColor)
-			if i != previewLine-1 && i != len(files)-1 {
-				directoryContent += "\n"
-			}
+
+			style := common.GetElementIcon(file.Name(), file.IsDir(), common.Config.Nerdfont)
+
+			res := lipgloss.NewStyle().Foreground(lipgloss.Color(style.Color)).Background(common.FilePanelBGColor).
+				Render(style.Icon+" ") + common.FilePanelStyle.Render(file.Name())
+
+			r.AddLines(res)
 		}
-		directoryContent = common.CheckAndTruncateLineLengths(directoryContent, m.fileModel.filePreview.width)
-		return box.Render(directoryContent)
+		return r.Render()
 	}
 
 	if isImageFile(itemPath) {
@@ -645,7 +654,7 @@ func (m *model) filePreviewPanelRender() string {
 			return box.Render("\n --- Image preview is disabled ---")
 		}
 
-		ansiRender, err := filepreview.ImagePreview(itemPath, m.fileModel.filePreview.width, previewLine, common.Theme.FilePanelBG)
+		ansiRender, err := filepreview.ImagePreview(itemPath, previewWidth, previewHeight, common.Theme.FilePanelBG)
 		if errors.Is(err, image.ErrFormat) {
 			return box.Render("\n --- " + icon.Error + " Unsupported image formats ---")
 		}
@@ -671,7 +680,7 @@ func (m *model) filePreviewPanelRender() string {
 	}
 
 	// At this point either format is not nil, or we can read the file
-	fileContent, err := readFileContent(itemPath, m.fileModel.width+20, previewLine)
+	fileContent, err := readFileContent(itemPath, previewWidth, previewHeight)
 	if err != nil {
 		slog.Error("Error open file", "error", err)
 		return box.Render("\n --- " + icon.Error + " Error open file ---")
@@ -691,7 +700,7 @@ func (m *model) filePreviewPanelRender() string {
 			if batCmd == "" {
 				return box.Render("\n --- " + icon.Error + " 'bat' is not installed or not found. ---\n --- Cannot render file preview. ---")
 			}
-			fileContent, err = getBatSyntaxHighlightedContent(itemPath, previewLine, background)
+			fileContent, err = getBatSyntaxHighlightedContent(itemPath, previewHeight, background)
 		} else {
 			fileContent, err = ansichroma.HightlightString(fileContent, format.Config().Name, common.Theme.CodeSyntaxHighlightTheme, background)
 		}
@@ -700,9 +709,8 @@ func (m *model) filePreviewPanelRender() string {
 			return box.Render("\n --- " + icon.Error + " Error render code highlight ---")
 		}
 	}
-
-	fileContent = common.CheckAndTruncateLineLengths(fileContent, m.fileModel.filePreview.width)
-	return box.Render(fileContent)
+	r.AddLines(fileContent)
+	return r.Render()
 }
 
 func getBatSyntaxHighlightedContent(itemPath string, previewLine int, background string) (string, error) {