✨ Allow session windows to be configured (#237)

* Makefile: Used go env command to get output location

* Config: Edited types for window configs

* Tmux: added starting a new windows

* feat: Loaded windows into config

* Tests: Added mock NewWindow implementation. TODO: implement

* fix: renamed toml name of windows (was startup_script because of copy paste)

* fix: typo in tmux wrapper where NewWindow would run new-session

* typo: in lister/config.go error message

* fix: Windows not matching properly with sessions when listing configuration

* fix: windows being detached when created

* fix: array of window confs initialized with an element causing extra window to be created

* model: removed windows from SeshSessions as not needed

* feat: Starting session at first window

* mock: generated mock tmux files

* feat: if window path is not set, use path of the session

* Update README with multiple windows config

* typo: Fixed some typos in README

* connector/tmux.go: add error checks

* fix indentation

* moved loading window configs to connection logic

* removed disable_startup_script for window configuration

* add window name to NewWndow function

* fix: moved new window logic to startup package

---------

Co-authored-by: Josh Medeski <[email protected]>

Author: PiquelChips

Makefile

@@ -6,4 +6,4 @@ test:
 	@go test -cover -bench=. -benchmem -race ./... -coverprofile=coverage.out
 
 build: 
-	@go build -ldflags ${BUILD_FLAGS} -o $(shell echo $$GOPATH)/bin/sesh
+	@go build -ldflags ${BUILD_FLAGS} -o $(shell go env GOPATH)/bin/sesh

README.md

@@ -295,6 +295,30 @@ startup_command = "nvim tmux.conf"
 preview_command = "bat --color=always ~/c/dotfiles/.config/tmux/tmux.conf"
 ```
 
+### Multiple windows
+
+If you want your session to have multiple windows you can define windows in your configuration. You can then use these window layouts in your sessions. These windows can be reused as many times as you want and you can add as many windows to each session as you want.
+
+Note: If you do not specify a path in the window, it will use the session's path.
+
+```toml
+[[session]]
+name = "Downloads 📥"
+path = "~/Downloads"
+startup_command = "ls"
+
+[[session]]
+name = "tmux config"
+path = "~/c/dotfiles/.config/tmux"
+startup_command = "nvim tmux.conf"
+preview_command = "bat --color=always ~/c/dotfiles/.config/tmux/tmux.conf"
+windows = [ "git" ]
+
+[[window]]
+name = "git"
+startup_script = "git pull"
+```
+
 ### Listing Configurations
 
 Session configurations will load by default if no flags are provided (the return after tmux sessions and before zoxide results). If you want to explicitly list them, you can use the `-c` flag.

lister/config.go

@@ -6,7 +6,7 @@ import (
 	"github.com/joshmedeski/sesh/v2/model"
 )
 
-func configKey(name string) string {
+func ConfigKey(name string) string {
 	return fmt.Sprintf("config:%s", name)
 }
 
@@ -15,7 +15,7 @@ func listConfig(l *RealLister) (model.SeshSessions, error) {
 	directory := make(model.SeshSessionMap)
 	for _, session := range l.config.SessionConfigs {
 		if session.Name != "" {
-			key := configKey(session.Name)
+			key := ConfigKey(session.Name)
 			orderedIndex = append(orderedIndex, key)
 			path, err := l.home.ExpandHome(session.Path)
 			if err != nil {
@@ -34,6 +34,7 @@ func listConfig(l *RealLister) (model.SeshSessions, error) {
 				PreviewCommand:        session.PreviewCommand,
 				DisableStartupCommand: session.DisableStartCommand,
 				Tmuxinator:            session.Tmuxinator,
+				WindowNames:           session.Windows,
 			}
 		}
 	}
@@ -44,7 +45,7 @@ func listConfig(l *RealLister) (model.SeshSessions, error) {
 }
 
 func (l *RealLister) FindConfigSession(name string) (model.SeshSession, bool) {
-	key := configKey(name)
+	key := ConfigKey(name)
 	sessions, _ := listConfig(l)
 	if session, exists := sessions.Directory[key]; exists {
 		return session, exists

model/config.go

@@ -6,16 +6,18 @@ type (
 		DefaultSessionConfig DefaultSessionConfig `toml:"default_session"`
 		Blacklist            []string             `toml:"blacklist"`
 		SessionConfigs       []SessionConfig      `toml:"session"`
-		SortOrder            []string             `toml:"sort_order"`
+    SortOrder            []string             `toml:"sort_order"`
+		WindowConfigs        []WindowConfig       `toml:"window"`
 	}
 
 	DefaultSessionConfig struct {
 		// TODO: mention breaking change in v2 release notes
 		// StartupScript  string `toml:"startup_script"`
-		StartupCommand string `toml:"startup_command"`
-		Tmuxp          string `toml:"tmuxp"`
-		Tmuxinator     string `toml:"tmuxinator"`
-		PreviewCommand string `toml:"preview_command"`
+		StartupCommand string   `toml:"startup_command"`
+		Tmuxp          string   `toml:"tmuxp"`
+		Tmuxinator     string   `toml:"tmuxinator"`
+		PreviewCommand string   `toml:"preview_command"`
+		Windows        []string `toml:"windows"`
 	}
 
 	SessionConfig struct {
@@ -24,4 +26,10 @@ type (
 		DisableStartCommand bool   `toml:"disable_startup_command"`
 		DefaultSessionConfig
 	}
+
+	WindowConfig struct {
+		Name               string `toml:"name"`
+		StartupScript      string `toml:"startup_script"`
+		Path               string `toml:"path"`
+	}
 )

model/sesh_session.go

@@ -9,19 +9,22 @@ type (
 	}
 
 	SeshSessionMap map[string]SeshSession
+	SeshWindowMap  map[string]WindowConfig
 
 	SeshSession struct {
 		Src  string // The source of the session (config, tmux, zoxide, tmuxinator)
 		Name string // The display name
 		Path string // The absolute directory path
 
-		StartupCommand        string  // The command to run when the session is started
-		PreviewCommand        string  // The command to run when the session is previewed
-		DisableStartupCommand bool    // Ignore the default startup command if present
-		Tmuxinator            string  // Name of the tmuxinator config
-		Attached              int     // Whether the session is currently attached
-		Windows               int     // The number of windows in the session
-		Score                 float64 // The score of the session (from Zoxide)
+		StartupCommand        string         // The command to run when the session is started
+		PreviewCommand        string         // The command to run when the session is previewed
+		DisableStartupCommand bool           // Ignore the default startup command if present
+		Tmuxinator            string         // Name of the tmuxinator config
+		Attached              int            // Whether the session is currently attached
+		Windows               int            // The number of windows in the session
+		WindowConfigs         []WindowConfig // The windows used in session config
+		WindowNames           []string       // The names of the windows in session config
+		Score                 float64        // The score of the session (from Zoxide)
 	}
 
 	SeshSrcs struct {

seshcli/seshcli.go

@@ -60,7 +60,7 @@ func App(version string) cli.App {
 	// core dependencies
 	ls := ls.NewLs(config, shell)
 	lister := lister.NewLister(config, home, tmux, zoxide, tmuxinator)
-	startup := startup.NewStartup(config, lister, tmux)
+	startup := startup.NewStartup(config, lister, tmux, home)
 	namer := namer.NewNamer(path, git, home)
 	connector := connector.NewConnector(config, dir, home, lister, namer, startup, tmux, zoxide, tmuxinator)
 	icon := icon.NewIcon(config)

startup/startup.go

@@ -3,6 +3,7 @@ package startup
 import (
 	"fmt"
 
+	"github.com/joshmedeski/sesh/v2/home"
 	"github.com/joshmedeski/sesh/v2/lister"
 	"github.com/joshmedeski/sesh/v2/model"
 	"github.com/joshmedeski/sesh/v2/tmux"
@@ -16,10 +17,11 @@ type RealStartup struct {
 	lister lister.Lister
 	tmux   tmux.Tmux
 	config model.Config
+	home   home.Home
 }
 
-func NewStartup(config model.Config, lister lister.Lister, tmux tmux.Tmux) Startup {
-	return &RealStartup{lister, tmux, config}
+func NewStartup(config model.Config, lister lister.Lister, tmux tmux.Tmux, home home.Home) Startup {
+	return &RealStartup{lister, tmux, config, home}
 }
 
 func (s *RealStartup) Exec(session model.SeshSession) (string, error) {
@@ -28,6 +30,48 @@ func (s *RealStartup) Exec(session model.SeshSession) (string, error) {
 		defaultConfigStrategy,
 	}
 
+	windows := make(model.SeshWindowMap)
+	for _, window := range s.config.WindowConfigs {
+		key := lister.ConfigKey(window.Name)
+		var path string = ""
+		var err error = nil
+		if window.Path != "" {
+			path, err = s.home.ExpandHome(window.Path)
+			if err != nil {
+				return "", fmt.Errorf("couldn't expand home: %q", err)
+			}
+		}
+
+		windows[key] = model.WindowConfig{
+			Name:          window.Name,
+			Path:          path,
+			StartupScript: window.StartupScript,
+		}
+	}
+
+	for _, window := range session.WindowNames {
+		windowConfig, ok := windows[lister.ConfigKey(window)]
+		if !ok {
+			return "", fmt.Errorf("window %s is not defined in config", window)
+		}
+		if windowConfig.Path == "" {
+			path, err := s.home.ExpandHome(session.Path)
+			if err != nil {
+				return "", fmt.Errorf("couldn't expand home: %q", err)
+			}
+			windowConfig.Path = path
+		}
+
+		// create the new window
+		if ret, err := s.tmux.NewWindow(windowConfig.Path, windowConfig.Name); err != nil {
+			return ret, err
+		}
+		if ret, err := s.tmux.SendKeys(session.Name, windowConfig.StartupScript); err != nil {
+			return ret, err
+		}
+	}
+	s.tmux.NextWindow()
+
 	for _, strategy := range strategies {
 		if command, err := strategy(s, session); err != nil {
 			return "", fmt.Errorf("failed to determine startup command: %w", err)
@@ -36,5 +80,6 @@ func (s *RealStartup) Exec(session model.SeshSession) (string, error) {
 			return fmt.Sprintf("executing startup command: %s", command), nil
 		}
 	}
+
 	return "", nil // no command to run
 }

tmux/mock_Tmux.go

@@ -9,11 +9,13 @@ import (
 type Tmux interface {
 	ListSessions() ([]*model.TmuxSession, error)
 	NewSession(sessionName string, startDir string) (string, error)
+	NewWindow(startDir string, name string) (string, error)
 	IsAttached() bool
 	AttachSession(targetSession string) (string, error)
 	SendKeys(name string, command string) (string, error)
 	SwitchClient(targetSession string) (string, error)
 	CapturePane(targetSession string) (string, error)
+	NextWindow() (string, error)
 	SwitchOrAttach(name string, opts model.ConnectOpts) (string, error)
 }
 
@@ -42,10 +44,18 @@ func (t *RealTmux) NewSession(sessionName string, startDir string) (string, erro
 	return t.shell.Cmd("tmux", "new-session", "-d", "-s", sessionName, "-c", startDir)
 }
 
+func (t *RealTmux) NewWindow(startDir string, name string) (string, error) {
+	return t.shell.Cmd("tmux", "new-window", "-n", name, "-c", startDir)
+}
+
 func (t *RealTmux) CapturePane(targetSession string) (string, error) {
 	return t.shell.Cmd("tmux", "capture-pane", "-e", "-p", "-t", targetSession)
 }
 
+func (t *RealTmux) NextWindow() (string, error) {
+	return t.shell.Cmd("tmux", "next-window")
+}
+
 func (t *RealTmux) IsAttached() bool {
 	return len(t.os.Getenv("TMUX")) > 0
 }