Sidebar code separation

src/cmd/main.go

@@ -13,7 +13,7 @@ import (
 	"time"
 
 	"github.com/yorukot/superfile/src/internal/common"
-	"github.com/yorukot/superfile/src/internal/common/utils"
+	"github.com/yorukot/superfile/src/internal/utils"
 
 	tea "github.com/charmbracelet/bubbletea"
 	"github.com/charmbracelet/lipgloss"

src/config/fixed_variable.go

@@ -5,7 +5,7 @@ import (
 	"path/filepath"
 
 	"github.com/urfave/cli/v2"
-	"github.com/yorukot/superfile/src/internal/common/utils"
+	"github.com/yorukot/superfile/src/internal/utils"
 
 	"github.com/adrg/xdg"
 )

src/internal/common/icon_utils.go

@@ -0,0 +1,63 @@
+package common
+
+import (
+	"path/filepath"
+	"strings"
+
+	"github.com/yorukot/superfile/src/config/icon"
+)
+
+func GetElementIcon(file string, isDir bool, nerdFont bool) icon.Style {
+	ext := strings.TrimPrefix(filepath.Ext(file), ".")
+	name := file
+
+	if !nerdFont {
+		return icon.Style{
+			Icon:  "",
+			Color: Theme.FilePanelFG,
+		}
+	}
+
+	if isDir {
+		resultIcon := icon.Folders["folder"]
+		betterIcon, hasBetterIcon := icon.Folders[name]
+		if hasBetterIcon {
+			resultIcon = betterIcon
+		}
+		return resultIcon
+	}
+	// default icon for all files. try to find a better one though...
+	resultIcon := icon.Icons["file"]
+	// resolve aliased extensions
+	extKey := strings.ToLower(ext)
+	alias, hasAlias := icon.Aliases[extKey]
+	if hasAlias {
+		extKey = alias
+	}
+
+	// see if we can find a better icon based on extension alone
+	betterIcon, hasBetterIcon := icon.Icons[extKey]
+	if hasBetterIcon {
+		resultIcon = betterIcon
+	}
+
+	// now look for icons based on full names
+	fullName := name
+
+	fullName = strings.ToLower(fullName)
+	fullAlias, hasFullAlias := icon.Aliases[fullName]
+	if hasFullAlias {
+		fullName = fullAlias
+	}
+	bestIcon, hasBestIcon := icon.Icons[fullName]
+	if hasBestIcon {
+		resultIcon = bestIcon
+	}
+	if resultIcon.Color == "NONE" {
+		return icon.Style{
+			Icon:  resultIcon.Icon,
+			Color: Theme.FilePanelFG,
+		}
+	}
+	return resultIcon
+}

src/internal/common/icon_utils_test.go

@@ -0,0 +1,97 @@
+package common
+
+import (
+	"testing"
+
+	"github.com/yorukot/superfile/src/config/icon"
+)
+
+func TestGetElementIcon(t *testing.T) {
+	tests := []struct {
+		name     string
+		file     string
+		isDir    bool
+		nerdFont bool
+		expected icon.Style
+	}{
+		{
+			name:     "Non-nerdfont returns empty icon",
+			file:     "test.txt",
+			isDir:    false,
+			nerdFont: false,
+			expected: icon.Style{
+				Icon:  "",
+				Color: Theme.FilePanelFG,
+			},
+		},
+		{
+			name:     "Directory with nerd font",
+			file:     "folder",
+			isDir:    true,
+			nerdFont: true,
+			expected: icon.Folders["folder"],
+		},
+		{
+			name:     "File with known extension",
+			file:     "test.js",
+			isDir:    false,
+			nerdFont: true,
+			expected: icon.Icons["js"],
+		},
+		{
+			name:     "Full name takes priority over extension",
+			file:     "gulpfile.js",
+			isDir:    false,
+			nerdFont: true,
+			expected: icon.Icons["gulpfile.js"],
+		},
+		{
+			name:     ".git directory",
+			file:     ".git",
+			isDir:    true,
+			nerdFont: true,
+			expected: icon.Folders[".git"],
+		},
+		{
+			name:     "superfile directory",
+			file:     "superfile",
+			isDir:    true,
+			nerdFont: true,
+			expected: icon.Folders["superfile"],
+		},
+		{
+			name:     "package.json file",
+			file:     "package.json",
+			isDir:    false,
+			nerdFont: true,
+			expected: icon.Icons["package"],
+		},
+		{
+			name:     "File with unknown extension",
+			file:     "test.xyz",
+			isDir:    false,
+			nerdFont: true,
+			expected: icon.Style{
+				Icon: icon.Icons["file"].Icon,
+				// Theme is not defined here, so this will be blank
+				Color: Theme.FilePanelFG,
+			},
+		},
+		{
+			name:     "File with aliased name",
+			file:     "dockerfile",
+			isDir:    false,
+			nerdFont: true,
+			expected: icon.Icons["dockerfile"],
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result := GetElementIcon(tt.file, tt.isDir, tt.nerdFont)
+			if result.Icon != tt.expected.Icon || result.Color != tt.expected.Color {
+				t.Errorf("GetElementIcon() = %v, want %v", result, tt.expected)
+			}
+		})
+	}
+}

src/internal/common/load_config.go

@@ -10,7 +10,7 @@ import (
 	"reflect"
 
 	"github.com/pelletier/go-toml/v2"
-	"github.com/yorukot/superfile/src/internal/common/utils"
+	"github.com/yorukot/superfile/src/internal/utils"
 
 	variable "github.com/yorukot/superfile/src/config"
 )

src/internal/string_function.go → src/internal/common/string_function.go

@@ -1,4 +1,4 @@
-package internal
+package common
 
 import (
 	"bufio"
@@ -11,22 +11,20 @@ import (
 	"unicode"
 	"unicode/utf8"
 
-	"github.com/yorukot/superfile/src/internal/common"
-
 	"github.com/charmbracelet/lipgloss"
 	"github.com/charmbracelet/x/exp/term/ansi"
 )
 
-func truncateText(text string, maxChars int, talis string) string {
-	truncatedText := ansi.Truncate(text, maxChars-len(talis), "")
+func TruncateText(text string, maxChars int, tails string) string {
+	truncatedText := ansi.Truncate(text, maxChars-len(tails), "")
 	if text != truncatedText {
-		return truncatedText + talis
+		return truncatedText + tails
 	}
 
 	return text
 }
 
-func truncateTextBeginning(text string, maxChars int, talis string) string {
+func TruncateTextBeginning(text string, maxChars int, tails string) string {
 	if ansi.StringWidth(text) <= maxChars {
 		return text
 	}
@@ -40,63 +38,63 @@ func truncateTextBeginning(text string, maxChars int, talis string) string {
 		truncatedWidth = ansi.StringWidth(string(truncatedRunes))
 	}
 
-	if len(truncatedRunes) > len(talis) {
-		truncatedRunes = append([]rune(talis), truncatedRunes[len(talis):]...)
+	if len(truncatedRunes) > len(tails) {
+		truncatedRunes = append([]rune(tails), truncatedRunes[len(tails):]...)
 	}
 
 	return string(truncatedRunes)
 }
 
-func truncateMiddleText(text string, maxChars int, talis string) string {
+func TruncateMiddleText(text string, maxChars int, tails string) string {
 	if utf8.RuneCountInString(text) <= maxChars {
 		return text
 	}
 
 	halfEllipsisLength := (maxChars - 3) / 2
-
-	truncatedText := text[:halfEllipsisLength] + talis + text[utf8.RuneCountInString(text)-halfEllipsisLength:]
+	// Todo : Use ansi.Substring to correctly handle ANSI escape codes
+	truncatedText := text[:halfEllipsisLength] + tails + text[utf8.RuneCountInString(text)-halfEllipsisLength:]
 
 	return truncatedText
 }
 
-func prettierName(name string, width int, isDir bool, isSelected bool, bgColor lipgloss.Color) string {
-	style := getElementIcon(name, isDir)
+func PrettierName(name string, width int, isDir bool, isSelected bool, bgColor lipgloss.Color) string {
+	style := GetElementIcon(name, isDir, Config.Nerdfont)
 	if isSelected {
-		return common.StringColorRender(lipgloss.Color(style.Color), bgColor).
+		return StringColorRender(lipgloss.Color(style.Color), bgColor).
 			Background(bgColor).
 			Render(style.Icon+" ") +
-			common.FilePanelItemSelectedStyle.
-				Render(truncateText(name, width, "..."))
+			FilePanelItemSelectedStyle.
+				Render(TruncateText(name, width, "..."))
 	}
-	return common.StringColorRender(lipgloss.Color(style.Color), bgColor).
+	return StringColorRender(lipgloss.Color(style.Color), bgColor).
 		Background(bgColor).
 		Render(style.Icon+" ") +
-		common.FilePanelStyle.Render(truncateText(name, width, "..."))
+		FilePanelStyle.Render(TruncateText(name, width, "..."))
 }
 
-func prettierDirectoryPreviewName(name string, isDir bool, bgColor lipgloss.Color) string {
-	style := getElementIcon(name, isDir)
-	return common.StringColorRender(lipgloss.Color(style.Color), bgColor).
+func PrettierDirectoryPreviewName(name string, isDir bool, bgColor lipgloss.Color) string {
+	style := GetElementIcon(name, isDir, Config.Nerdfont)
+	return StringColorRender(lipgloss.Color(style.Color), bgColor).
 		Background(bgColor).
 		Render(style.Icon+" ") +
-		common.FilePanelStyle.Render(name)
+		FilePanelStyle.Render(name)
 }
 
-func clipboardPrettierName(name string, width int, isDir bool, isSelected bool) string {
-	style := getElementIcon(name, isDir)
+func ClipboardPrettierName(name string, width int, isDir bool, isSelected bool) string {
+	style := GetElementIcon(name, isDir, Config.Nerdfont)
 	if isSelected {
-		return common.StringColorRender(lipgloss.Color(style.Color), common.FooterBGColor).
-			Background(common.FooterBGColor).
+		return StringColorRender(lipgloss.Color(style.Color), FooterBGColor).
+			Background(FooterBGColor).
 			Render(style.Icon+" ") +
-			common.FilePanelItemSelectedStyle.Render(truncateTextBeginning(name, width, "..."))
+			FilePanelItemSelectedStyle.Render(TruncateTextBeginning(name, width, "..."))
 	}
-	return common.StringColorRender(lipgloss.Color(style.Color), common.FooterBGColor).
-		Background(common.FooterBGColor).
+	return StringColorRender(lipgloss.Color(style.Color), FooterBGColor).
+		Background(FooterBGColor).
 		Render(style.Icon+" ") +
-		common.FilePanelStyle.Render(truncateTextBeginning(name, width, "..."))
+		FilePanelStyle.Render(TruncateTextBeginning(name, width, "..."))
 }
 
-func fileNameWithoutExtension(fileName string) string {
+func FileNameWithoutExtension(fileName string) string {
 	for {
 		pos := strings.LastIndexByte(fileName, '.')
 		if pos <= 0 {
@@ -107,7 +105,7 @@ func fileNameWithoutExtension(fileName string) string {
 	return fileName
 }
 
-func formatFileSize(size int64) string {
+func FormatFileSize(size int64) string {
 	if size == 0 {
 		return "0B"
 	}
@@ -116,7 +114,7 @@ func formatFileSize(size int64) string {
 	unitsBin := []string{"B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB"}
 
 	// Todo : Remove duplication here
-	if common.Config.FileSizeUseSI {
+	if Config.FileSizeUseSI {
 		unitIndex := int(math.Floor(math.Log(float64(size)) / math.Log(1000)))
 		adjustedSize := float64(size) / math.Pow(1000, float64(unitIndex))
 		return fmt.Sprintf("%.2f %s", adjustedSize, unitsDec[unitIndex])
@@ -127,7 +125,7 @@ func formatFileSize(size int64) string {
 }
 
 // Truncate line lengths and keep ANSI
-func checkAndTruncateLineLengths(text string, maxLength int) string {
+func CheckAndTruncateLineLengths(text string, maxLength int) string {
 	lines := strings.Split(text, "\n")
 	var result strings.Builder
 
@@ -144,7 +142,7 @@ func checkAndTruncateLineLengths(text string, maxLength int) string {
 }
 
 // Separated this out out for easy testing
-func isBufferPrintable(buffer []byte) bool {
+func IsBufferPrintable(buffer []byte) bool {
 	for _, b := range buffer {
 		// This will also handle b==0
 		if !unicode.IsPrint(rune(b)) && !unicode.IsSpace(rune(b)) {
@@ -154,8 +152,8 @@ func isBufferPrintable(buffer []byte) bool {
 	return true
 }
 
-// isExensionExtractable checks if a string is a valid compressed archive file extension.
-func isExensionExtractable(ext string) bool {
+// IsExtensionExtractable checks if a string is a valid compressed archive file extension.
+func IsExtensionExtractable(ext string) bool {
 	// Extensions based on the types that package: `xtractr` `ExtractFile` function handles.
 	validExtensions := map[string]struct{}{
 		".zip":     {},
@@ -173,7 +171,7 @@ func isExensionExtractable(ext string) bool {
 }
 
 // Check file is text file or not
-func isTextFile(filename string) (bool, error) {
+func IsTextFile(filename string) (bool, error) {
 	file, err := os.Open(filename)
 	if err != nil {
 		return false, err
@@ -186,14 +184,14 @@ func isTextFile(filename string) (bool, error) {
 	if err != nil && !errors.Is(err, io.EOF) {
 		return false, err
 	}
-	return isBufferPrintable(buffer[:cnt]), nil
+	return IsBufferPrintable(buffer[:cnt]), nil
 }
 
 // Although some characters like `\x0b`(vertical tab) are printable,
 // previewing them breaks the layout.
 // So, among the "non-graphic" printable characters, we only need \n and \t
 // Space and NBSP are already considered graphic by unicode.
-func makePrintable(line string) string {
+func MakePrintable(line string) string {
 	var sb strings.Builder
 	// This has to be looped byte-wise, looping it rune-wise
 	// or by using strings.Map would cause issues with strings like