✨ Add ability to configure sorting of sources (#241)

* sorting the sources
* moving sorting to the sources file
* tests for sortSources()
* using sort_order from toml configuration
* readme documentation
* remove code comment
* returning a new slice, using stable sort

Author: evheath

README.md

@@ -234,6 +234,28 @@ blacklist = ["scratch"]
 > [!NOTE] 
 > Works great with [tmux-floatx](https://github.com/omerxx/tmux-floax)
 
+### Sorting
+
+If you'd like to change the order of the sessions shown, you can configure `sort_order` in your `sesh.toml` file
+
+```toml
+sort_order = [
+    "tmuxinator", # show first
+    "config",
+    "tmux",
+    "zoxide", # show last
+]
+```
+
+The default order is `tmux`, `config`, `tmuxinator`, and then `zoxide`.
+
+You can omit session types if you only care about the order of specific ones.
+
+```toml
+sort_order = [
+  "config", # resulting order: config, tmux, tmuxinator, zoxide
+]
+```
 ### Default Session
 
 The default session can be configured to run a command when connecting to a session. This is useful for running a dev server or starting a tmux plugin.

lister/list.go

@@ -30,6 +30,7 @@ func (l *RealLister) List(opts ListOptions) (model.SeshSessions, error) {
 	fullOrderedIndex := make([]string, 0)
 
 	srcsOrderedIndex := srcs(opts)
+	srcsOrderedIndex = sortSources(srcsOrderedIndex, l.config.SortOrder)
 
 	for _, src := range srcsOrderedIndex {
 		sessions, err := srcStrategies[src](l)

lister/srcs.go

@@ -1,5 +1,35 @@
 package lister
 
+import (
+	"cmp"
+	"math"
+	"slices"
+	"strings"
+)
+
+// returns a sorted list of sources based on the provided sort order.
+func sortSources(sources, sortOrder []string) []string {
+	if sortOrder == nil || len(sortOrder) == 0 {
+		return sources
+	}
+	m := make(map[string]int)
+	for i, s := range sortOrder {
+		m[strings.ToLower(s)] = i
+	}
+	getOrder := func(s string) int {
+		if order, exists := m[strings.ToLower(s)]; exists {
+			return order
+		} else {
+			return math.MaxInt
+		}
+	}
+	result := slices.Clone(sources)
+	slices.SortStableFunc(result, func(a, b string) int {
+		return cmp.Compare(getOrder(a), getOrder(b))
+	})
+	return result
+}
+
 func srcs(opts ListOptions) []string {
 	var srcs []string
 	count := 0

lister/srcs_test.go

@@ -6,6 +6,45 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
+func TestSortSources(t *testing.T) {
+	defaultSources := []string{"tmux", "config", "tmuxinator", "zoxide"}
+	tests := map[string]struct {
+		sortOrder []string
+		expected  []string
+	}{
+		"a normal configuration": {
+			sortOrder: []string{"tmuxinator", "zoxide", "config", "tmux"},
+			expected:  []string{"tmuxinator", "zoxide", "config", "tmux"},
+		},
+		"empty configuration": {
+			sortOrder: []string{},
+			expected:  []string{"tmux", "config", "tmuxinator", "zoxide"},
+		},
+		"partial configuration": {
+			sortOrder: []string{"tmuxinator"},
+			expected:  []string{"tmuxinator", "tmux", "config", "zoxide"},
+		},
+		"superfluous elements": {
+			sortOrder: []string{"tmuxinator", "apple", "zoxide", "banana", "config", "chocolate", "tmux"},
+			expected:  []string{"tmuxinator", "zoxide", "config", "tmux"},
+		},
+		"configuration with capitalization": {
+			sortOrder: []string{"tMuxiNator", "Zoxide", "conFIg", "tmux"},
+			expected:  []string{"tmuxinator", "zoxide", "config", "tmux"},
+		},
+		"configuration with duplicate elements": {
+			sortOrder: []string{"tmuxinator", "zoxide", "tmuxinator", "config", "tmuxinator", "tmux", "tmuxinator", "tmuxinator"},
+			expected:  []string{"zoxide", "config", "tmux", "tmuxinator"},
+		},
+	}
+	for name, tt := range tests {
+		t.Run(name, func(t *testing.T) {
+			actual := sortSources(defaultSources, tt.sortOrder)
+			assert.Equal(t, tt.expected, actual)
+		})
+	}
+}
+
 func TestSrcs(t *testing.T) {
 	tests := []struct {
 		name     string

model/config.go

@@ -6,6 +6,7 @@ type (
 		DefaultSessionConfig DefaultSessionConfig `toml:"default_session"`
 		Blacklist            []string             `toml:"blacklist"`
 		SessionConfigs       []SessionConfig      `toml:"session"`
+		SortOrder            []string             `toml:"sort_order"`
 	}
 
 	DefaultSessionConfig struct {