Improve globbing

Author: xyproto

TODO.md

@@ -4,7 +4,7 @@
 
 - [ ] Add a mode for writing books under Kitty, with the editor to the left and a preview to the right, nice text flow and a typewriter-like user experience.
 - [ ] There is some duplication between this source code and the source code of the `syntax` package. Refactor and fix.
-- [ ] When globbing, prioritize `.sh` over `.bat`, unless on Windows.
+- [x] When globbing, prioritize `.sh` over `.bat`, unless on Windows.
 - [ ] Let the default theme have a 256-color variant that is like the default theme, only nicer.
 - [ ] If Orbiton is launched by a symlink starting with `p` (for `preview`), then act as an auto-reloading Markdown preview program.
 - [ ] `o -b` should also build Go projects, Rust projects etc. (similar to `ctrl-space`), not only C and C++.

v2/glob.go

@@ -0,0 +1,73 @@
+package main
+
+import (
+	"runtime"
+	"sort"
+	"strings"
+
+	"github.com/xyproto/files"
+	"github.com/xyproto/globi"
+)
+
+// editPriority returns a sort weight for a filename when choosing which file to open.
+// Lower values are preferred. Tiers:
+//
+//	0 – regular text file
+//	1 – low-priority extension (.lock, .bak, …)
+//	2 – Windows-only script on a non-Windows platform (.bat, .cmd)
+//	3 – binary file
+func editPriority(filename string) int {
+	if files.IsBinaryAccurate(filename) {
+		return 3
+	}
+	if runtime.GOOS != "windows" && hasSuffix(filename, []string{".bat", ".cmd"}) {
+		return 2
+	}
+	if hasSuffix(filename, probablyDoesNotWantToEditExtensions) || !strings.Contains(filename, ".") {
+		return 1
+	}
+	return 0
+}
+
+// sortByEditPriority sorts filenames so the most desirable file to edit comes first.
+// Within the same priority tier the names are ordered alphabetically.
+func sortByEditPriority(matches []string) {
+	sort.SliceStable(matches, func(i, j int) bool {
+		pi, pj := editPriority(matches[i]), editPriority(matches[j])
+		if pi != pj {
+			return pi < pj
+		}
+		return matches[i] < matches[j]
+	})
+}
+
+// approximateFilename tries to find an existing file that matches the given
+// incomplete filename, using glob expansion and weighted sorting.
+// It returns the best match, or the original name if no match is found.
+func approximateFilename(filename string) string {
+	if strings.HasSuffix(filename, ".") {
+		// Tab-completion left a trailing dot: glob for everything that starts with this prefix
+		matches, err := globi.Glob(filename + "*")
+		if err == nil && len(matches) > 0 {
+			sortByEditPriority(matches)
+			if len(matches[0]) > 0 {
+				return matches[0]
+			}
+		}
+	} else if !strings.Contains(filename, ".") && allLower(filename) {
+		// No dot, all lowercase: more than one file may start with this name
+		matches, err := globi.Glob(filename + "*")
+		if err == nil && len(matches) > 1 {
+			sortByEditPriority(matches)
+			return matches[0]
+		}
+	} else {
+		// Also match eg. "PKGBUILD" if just "Pk" was entered
+		matches, err := globi.Glob(strings.ToTitle(filename) + "*")
+		if err == nil && len(matches) >= 1 {
+			sortByEditPriority(matches)
+			return matches[0]
+		}
+	}
+	return filename
+}

v2/main.go

@@ -16,7 +16,6 @@ import (
 	"github.com/xyproto/digraph"
 	"github.com/xyproto/env/v2"
 	"github.com/xyproto/files"
-	"github.com/xyproto/globi"
 	"github.com/xyproto/megafile"
 	"github.com/xyproto/vt"
 )
@@ -448,58 +447,7 @@ func main() {
 		// Check if the given filename is not a file, symlink or directory
 		if !noApproxMatchFlag {
 			if !files.IsFileOrSymlink(fnord.filename) && !files.IsDir(fnord.filename) {
-				if strings.HasSuffix(fnord.filename, ".") {
-					// If the filename ends with "." and the file does not exist, assume this was a result of tab-completion going wrong.
-					// If there are multiple files that exist that start with the given filename, open the one first in the alphabet (.cpp before .o)
-					matches, err := globi.Glob(fnord.filename + "*")
-					if err == nil && len(matches) > 0 { // no error and at least 1 match
-						// Filter out any binary files
-						matches = files.FilterOutBinaryFilesAccurate(matches)
-						if len(matches) > 0 {
-							sort.Strings(matches)
-							// If the matches contains low priority suffixes, such as ".lock", then move it last
-							matchesRegular := make([]string, 0, len(matches))
-							matchesLowPri := make([]string, 0, len(matches))
-							for _, fn := range matches {
-								if !hasSuffix(fn, probablyDoesNotWantToEditExtensions) && strings.Contains(fn, ".") {
-									matchesRegular = append(matchesRegular, fn)
-								} else {
-									// Store as a low-priority match
-									matchesLowPri = append(matchesLowPri, fn)
-								}
-							}
-							// Combine the regular and the low-priority matches
-							matches = append(matchesRegular, matchesLowPri...)
-							if len(matches) > 0 && len(matches[0]) > 0 {
-								// Use the first filename in the list of matches
-								fnord.filename = matches[0]
-							}
-						}
-					}
-				} else if !strings.Contains(fnord.filename, ".") && allLower(fnord.filename) {
-					// The filename has no ".", is written in lowercase and it does not exist,
-					// but more than one file that starts with the filename  exists. Assume tab-completion failed.
-					matches, err := globi.Glob(fnord.filename + "*")
-					if err == nil && len(matches) > 1 { // no error and more than 1 match
-						// Use the first non-binary match of the sorted results
-						matches = files.FilterOutBinaryFilesAccurate(matches)
-						if len(matches) > 0 {
-							sort.Strings(matches)
-							fnord.filename = matches[0]
-						}
-					}
-				} else {
-					// Also match ie. "PKGBUILD" if just "Pk" was entered
-					matches, err := globi.Glob(strings.ToTitle(fnord.filename) + "*")
-					if err == nil && len(matches) >= 1 { // no error and at least 1 match
-						// Use the first non-binary match of the sorted results
-						matches = files.FilterOutBinaryFilesAccurate(matches)
-						if len(matches) > 0 {
-							sort.Strings(matches)
-							fnord.filename = matches[0]
-						}
-					}
-				}
+				fnord.filename = approximateFilename(fnord.filename)
 			} // !noApproxMatchFlag
 		}
 	}