refactor: standardize TODO comments across the codebase

Author: yorukot

.golangci.yaml

@@ -269,7 +269,7 @@ linters:
     - bodyclose # checks whether HTTP response body is closed successfully
     - canonicalheader # checks whether net/http.Header uses canonical header
     - copyloopvar # detects places where loop variables are copied (Go 1.22+)
-    # Todo enable this - This needs a fix in few of our functions
+    # TODO enable this - This needs a fix in few of our functions
     #- cyclop # checks function and package cyclomatic complexity
     - depguard # checks if package imports are in a list of acceptable packages
     - dupl # tool for code clone detection
@@ -280,38 +280,38 @@ linters:
     - exptostd # detects functions from golang.org/x/exp/ that can be replaced by std functions
     - fatcontext # detects nested contexts in loops
     # - forbidigo # forbids identifiers # Not needed. this blocks only fmt.Print family and is not useful right now
-    # Todo enable - need to make functions shorter
+    # TODO enable - need to make functions shorter
     #- funlen # tool for detection of long functions
     - gocheckcompilerdirectives # validates go compiler directive comments (//go:)
-    # Todo enable - This is too much for us right now
+    # TODO enable - This is too much for us right now
     - gochecknoglobals # checks that no global variables exist
     - gochecknoinits # checks that no init functions are present in Go code
     - gochecksumtype # checks exhaustiveness on Go "sum types"
-    # Todo enable - Need to refactor many functions
+    # TODO enable - Need to refactor many functions
     # - gocognit # computes and checks the cognitive complexity of functions
     - goconst # finds repeated strings that could be replaced by a constant
     - gocritic # provides diagnostics that check for bugs, performance and style issues
-    # Todo enable
+    # TODO enable
     #- gocyclo # computes and checks the cyclomatic complexity of functions
     #- godot # checks if comments end in a period # Too much for us right now
     - goimports # in addition to fixing imports, goimports also formats your code in the same style as gofmt
     - gomoddirectives # manages the use of 'replace', 'retract', and 'excludes' directives in go.mod
     - goprintffuncname # checks that printf-like functions are named with f at the end
-    # Todo enable - ignore for a few int overflow, and fix file permissions
+    # TODO enable - ignore for a few int overflow, and fix file permissions
     # weak md5 cryptography, Subprocess launched with a potential tainted input
     # - gosec # inspects source code for security problems
     - iface # checks the incorrect use of interfaces, helping developers avoid interface pollution
     - intrange # finds places where for loops could make use of an integer range
-    # Todo enable : Need many fixes
+    # TODO enable : Need many fixes
     # - lll # reports long lines
     - loggercheck # checks key value pairs for common logger libraries (kitlog,klog,logr,zap)
     - makezero # finds slice declarations with non-zero initial length
     - mirror # reports wrong mirror patterns of bytes/strings usage
-    # Todo enable - Many many magic numbers, and this should be fixed.
+    # TODO enable - Many many magic numbers, and this should be fixed.
     # - mnd # detects magic numbers
     - musttag # enforces field tags in (un)marshaled structs
     - nakedret # finds naked returns in functions greater than a specified function length
-    # Todo enable : Many reports. A bit hard to understand the nesting value.
+    # TODO enable : Many reports. A bit hard to understand the nesting value.
     # - nestif # reports deeply nested if statements
     - nilerr # finds the code that returns nil even if it checks that the error is not nil
     - nilnesserr # reports that it checks for err != nil, but it returns a different nil value error (powered by nilness and nilerr)
@@ -325,11 +325,11 @@ linters:
     - promlinter # checks Prometheus metrics naming via promlint
     - protogetter # reports direct reads from proto message fields when getters should be used
     - reassign # checks that package variables are not reassigned
-    # Todo enable - Issue due to model struct
+    # TODO enable - Issue due to model struct
     # - recvcheck # checks for receiver type consistency
     - revive # fast, configurable, extensible, flexible, and beautiful linter for Go, drop-in replacement of golint
     - rowserrcheck # checks whether Err of rows is checked successfully
-    # Todo enable - Need to use non-root logger
+    # TODO enable - Need to use non-root logger
     # - sloglint # ensure consistent code style when using log/slog
     - spancheck # checks for mistakes with OpenTelemetry/Census spans
     - sqlclosecheck # checks that sql.Rows and sql.Stmt are closed
@@ -345,7 +345,7 @@ linters:
     - wastedassign # finds wasted assignment statements
     - whitespace # detects leading and trailing whitespace
 
-    ## Todo : Enable some of them
+    ## TODO : Enable some of them
     ## you may want to enable
     - decorder # checks declaration order and count of types, constants, variables and functions
     # We have so many false positives

src/internal/common/predefined_variable.go

@@ -15,7 +15,7 @@ var (
 	MinimumHeight = 24
 	MinimumWidth  = 60
 
-	// Todo : These are model object properties, not global properties
+	// TODO : These are model object properties, not global properties
 	// We are modifying them in the code many time. They need to be part of model struct.
 	MinFooterHeight = 6
 	ModalWidth      = 60
@@ -53,7 +53,7 @@ func LoadInitialPrerenderedVariables() {
 		lipgloss.NewStyle().Foreground(lipgloss.Color("#00FFEE")).Render(" ┃ ")
 }
 
-// Dependecies - Todo We should programmatically guarantee these dependencies. And log error
+// Dependecies - TODO We should programmatically guarantee these dependencies. And log error
 // if its not satisfied.
 // LoadThemeConfig() in style.go should be finished
 // loadConfigFile() in config_types.go should be finished

src/internal/common/string_function.go

@@ -52,7 +52,7 @@ func TruncateMiddleText(text string, maxChars int, tails string) string {
 	}
 
 	halfEllipsisLength := (maxChars - 3) / 2
-	// Todo : Use ansi.Substring to correctly handle ANSI escape codes
+	// TODO : Use ansi.Substring to correctly handle ANSI escape codes
 	truncatedText := text[:halfEllipsisLength] + tails + text[utf8.RuneCountInString(text)-halfEllipsisLength:]
 
 	return truncatedText
@@ -114,7 +114,7 @@ func FormatFileSize(size int64) string {
 	unitsDec := []string{"B", "kB", "MB", "GB", "TB", "PB", "EB"}
 	unitsBin := []string{"B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB"}
 
-	// Todo : Remove duplication here
+	// TODO : Remove duplication here
 	if Config.FileSizeUseSI {
 		unitIndex := int(math.Floor(math.Log(float64(size)) / math.Log(1000)))
 		adjustedSize := float64(size) / math.Pow(1000, float64(unitIndex))

src/internal/common/style_function.go

@@ -237,7 +237,7 @@ func LoadHotkeysError(value string) string {
 	return lipgloss.NewStyle().Foreground(lipgloss.Color("#FF5555")).Render("■ ERROR: ") + "Hotkeys file \"" + lipgloss.NewStyle().Foreground(lipgloss.Color("#00D9FF")).Render(value) + "\" invalidation"
 }
 
-// Todo : Fix Code duplication in textInput.Model creation
+// TODO : Fix Code duplication in textInput.Model creation
 // This eventually caused a bug, where we created new model for sidebar search, and
 // Didn't set `Width` in that. Take Width and other parameters as input in one function
 // Generate search bar for file panel

src/internal/config_function.go

@@ -24,7 +24,7 @@ func initialConfig(firstFilePanelDirs []string) (toggleDotFile bool, toggleFoote
 	// Open log stream
 	file, err := os.OpenFile(variable.LogFile, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0666)
 
-	// Todo : This could be improved if we want to make superfile more resilient to errors
+	// TODO : This could be improved if we want to make superfile more resilient to errors
 	// For example if the log file directories have access issues.
 	// we could pass a dummy object to log.SetOutput() and the app would still function.
 	if err != nil {

src/internal/function.go

@@ -25,7 +25,7 @@ import (
 )
 
 // Check if the directory is external disk path
-// Todo : This function should be give two directories, and it should return
+// TODO : This function should be give two directories, and it should return
 // if the two share a different disk partition.
 // Ideally we shouldn't even try to figure that out in our file operations, and let OS handles it.
 // But at least right now its not okay. This returns if `path` is an External disk
@@ -58,7 +58,7 @@ func returnFocusType(focusPanel focusPanelType) filePanelFocusType {
 	return secondFocus
 }
 
-// Todo : Take common.Config.CaseSensitiveSort as a function parameter
+// TODO : Take common.Config.CaseSensitiveSort as a function parameter
 // and also consider testing this caseSensitive with both true and false in
 // our unit_test TestReturnDirElement
 func returnDirElement(location string, displayDotFile bool, sortOptions sortOptionsModelData) []element {
@@ -83,7 +83,7 @@ func returnDirElement(location string, displayDotFile bool, sortOptions sortOpti
 	var order func(i, j int) bool
 	reversed := sortOptions.reversed
 
-	// Todo : These strings should not be hardcoded here, but defined as constants
+	// TODO : These strings should not be hardcoded here, but defined as constants
 	switch sortOptions.options[sortOptions.selected] {
 	case "Name":
 		order = func(i, j int) bool {
@@ -223,7 +223,7 @@ func panelElementHeight(mainPanelHeight int) int {
 	return mainPanelHeight - 3
 }
 
-// Todo : replace usage of this with slices.contains
+// TODO : replace usage of this with slices.contains
 func arrayContains(s []string, str string) bool {
 	for _, v := range s {
 		if v == str {
@@ -310,7 +310,7 @@ func renameIfDuplicate(destination string) (string, error) {
 	}
 }
 
-// Todo : Move this model related function to the right file. Should not be in functions file.
+// TODO : Move this model related function to the right file. Should not be in functions file.
 func (m *model) returnMetaData() {
 	panel := m.fileModel.filePanels[m.filePanelFocusIndex]
 	cursor := panel.cursor
@@ -366,7 +366,7 @@ func (m *model) returnMetaData() {
 	if fileInfo.IsDir() {
 		m.fileMetaData.metaData = append(m.fileMetaData.metaData, [2]string{"Name", fileInfo.Name()})
 		if m.focusPanel == metadataFocus {
-			// Todo : Calling dirSize() could be expensive for large directories, as it recursively
+			// TODO : Calling dirSize() could be expensive for large directories, as it recursively
 			// walks the entire tree. Consider lazy loading, caching, or an async approach to avoid UI lockups.
 			m.fileMetaData.metaData = append(m.fileMetaData.metaData, [2]string{"Size", common.FormatFileSize(dirSize(filePath))})
 		}
@@ -423,7 +423,7 @@ func (m *model) returnMetaData() {
 	panel.element[panel.cursor].metaData = m.fileMetaData.metaData
 }
 
-// Todo : Replace all usage of "m.fileModel.filePanels[m.filePanelFocusIndex]" with this
+// TODO : Replace all usage of "m.fileModel.filePanels[m.filePanelFocusIndex]" with this
 // There are many usage
 func (m *model) getFocusedFilePanel() *filePanel {
 	return &m.fileModel.filePanels[m.filePanelFocusIndex]

src/internal/handle_file_operation_test.go

@@ -33,7 +33,7 @@ func TestCompressSelectedFiles(t *testing.T) {
 	// 5 - Compress multiple selected files and directories
 	// 6 - Pressing compress hotkey on empty panel doesn't do anything or crashes on both browser/select mode
 
-	// Copied from CopyTest. Todo - work on it.
+	// Copied from CopyTest. TODO - work on it.
 
 	testdata := []struct {
 		name              string
@@ -126,7 +126,7 @@ func TestCompressSelectedFiles(t *testing.T) {
 			}, time.Second, 10*time.Millisecond)
 
 			// No-op update to get the filepanel updated
-			// Todo - This should not be needed. Only operation finish SPF should refresh
+			// TODO - This should not be needed. Only operation finish SPF should refresh
 			// on its own
 			TeaUpdateWithErrCheck(t, &m, nil)
 

src/internal/handle_file_operations.go

@@ -82,9 +82,9 @@ func (m *model) panelCreateNewFile() {
 	m.firstTextInput = true
 }
 
-// Todo : This function does not needs the entire model. Only pass the panel object
+// TODO : This function does not needs the entire model. Only pass the panel object
 func (m *model) IsRenamingConflicting() bool {
-	// Todo : Replace this with m.getCurrentFilePanel() everywhere
+	// TODO : Replace this with m.getCurrentFilePanel() everywhere
 	panel := &m.fileModel.filePanels[m.filePanelFocusIndex]
 
 	if len(panel.element) == 0 {
@@ -273,7 +273,7 @@ func (m *model) deleteMultipleItems() {
 		}
 	}
 
-	// This feels a bit fuzzy and unclean. Todo : Review and simplify this.
+	// This feels a bit fuzzy and unclean. TODO : Review and simplify this.
 	// We should never get to this condition of panel.cursor getting negative
 	// and if we do, we should error log that.
 	if panel.cursor >= len(panel.element)-len(panel.selected)-1 {
@@ -331,7 +331,7 @@ func (m *model) completelyDeleteSingleItem() {
 		message.processNewState = p
 		channel <- message
 	}
-	// Todo : This is duplicated code fragment. Remove this duplication
+	// TODO : This is duplicated code fragment. Remove this duplication
 	if len(panel.element) == 0 {
 		panel.cursor = 0
 	} else if panel.cursor >= len(panel.element) {
@@ -496,7 +496,7 @@ func (m *model) pasteItem() {
 	}
 
 	for _, folderPath := range m.copyItems.items {
-		// Todo : Fix this. This is inefficient
+		// TODO : Fix this. This is inefficient
 		// In case of a cut operations for a directory with a lot of files
 		// we are unnecessarily walking the whole directory recursively
 		// while os will just perform a rename
@@ -560,7 +560,7 @@ func (m *model) pasteItem() {
 		if m.copyItems.cut && !isExternalDiskPath(filePath) {
 			err = moveElement(filePath, filepath.Join(panel.location, filepath.Base(filePath)))
 		} else {
-			// Todo : These error cases are hard to test. We have to somehow make the paste operations fail,
+			// TODO : These error cases are hard to test. We have to somehow make the paste operations fail,
 			// which is time consuming and manual. We should test these with automated testcases
 			err = pasteDir(filePath, filepath.Join(panel.location, filepath.Base(filePath)), id, m)
 			if err != nil {
@@ -594,7 +594,7 @@ func (m *model) pasteItem() {
 }
 
 // Extract compressed file
-// Todo : err should be returned and properly handled by the caller
+// TODO : err should be returned and properly handled by the caller
 func (m *model) extractFile() {
 	var err error
 	panel := &m.fileModel.filePanels[m.filePanelFocusIndex]

src/internal/handle_panel_movement.go

@@ -170,7 +170,7 @@ func (panel *filePanel) singleItemSelect() {
 			// This is inefficient. Once you select 1000 items,
 			// each select / deselect operation can take 1000 operations
 			// It can be easily made constant time.
-			// Todo : (performance)convert panel.selected to a set (map[string]struct{})
+			// TODO : (performance)convert panel.selected to a set (map[string]struct{})
 			panel.selected = removeElementByValue(panel.selected, elementLocation)
 		} else {
 			panel.selected = append(panel.selected, elementLocation)
@@ -195,7 +195,7 @@ func (m *model) toggleFooterController() {
 	if err != nil {
 		slog.Error("Error while updating toggleFooter data", "error", err)
 	}
-	// Todo : Revisit this. Is this really need here, is this correct ?
+	// TODO : Revisit this. Is this really need here, is this correct ?
 	m.setHeightValues(m.fullHeight)
 }
 

src/internal/handle_panel_navigation.go

@@ -28,7 +28,7 @@ func (m *model) createNewFilePanel(location string) error {
 	// But we would have len() here as 1. Hence there would be discrepency here.
 	// Although this is not possible in actual usage, and can be only reproduced in tests.
 	if len(m.fileModel.filePanels) == m.fileModel.maxFilePanel {
-		// Todo : Define as a predefined error in errors.go
+		// TODO : Define as a predefined error in errors.go
 		return errors.New("maximum panel count reached")
 	}