amend! Add config git.baseBranches

Add config git.mainBranches

It defaults to {"master", "main"}, but can be set to whatever branch names
are used as base branches, e.g. {"master", "devel", "v1.0-hotfixes"}. It is
used for color-coding the shas in the commit list, i.e. to decide whether
commits are green or yellow.

Author: stefanhaller

docs/Config.md

@@ -88,10 +88,9 @@ git:
     # displays the whole git graph by default in the commits panel (equivalent to passing the `--all` argument to `git log`)
     showWholeGraph: false
   skipHookPrefix: WIP
-  # The main branches. We colour commits green if
-  # they belong to one of these branches, so that you can easily see which commits are
-  # unique to your branch (coloured in yellow)
-  baseBranches: [master, main]
+  # The main branches. We colour commits green if they belong to one of these branches, 
+  # so that you can easily see which commits are unique to your branch (coloured in yellow)
+  mainBranches: [master, main]
   autoFetch: true
   autoRefresh: true
   branchLogCmd: 'git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --'

pkg/commands/git_commands/commit_loader.go

@@ -33,10 +33,10 @@ type CommitLoader struct {
 	readFile      func(filename string) ([]byte, error)
 	walkFiles     func(root string, fn filepath.WalkFunc) error
 	dotGitDir     string
-	// List of base branches that exist in the repo, quoted for direct use in a git command.
+	// List of main branches that exist in the repo, quoted for direct use in a git command.
 	// We use these to obtain the merge base of the branch.
-	// When nil, we're yet to obtain the list of base branches.
-	quotedBaseBranches *string
+	// When nil, we're yet to obtain the list of main branches.
+	quotedMainBranches *string
 }
 
 // making our dependencies explicit for the sake of easier testing
@@ -53,7 +53,7 @@ func NewCommitLoader(
 		readFile:           os.ReadFile,
 		walkFiles:          filepath.Walk,
 		dotGitDir:          dotGitDir,
-		quotedBaseBranches: nil,
+		quotedMainBranches: nil,
 	}
 }
 
@@ -365,38 +365,37 @@ func (self *CommitLoader) setCommitMergedStatuses(refName string, commits []*mod
 }
 
 func (self *CommitLoader) getMergeBase(refName string) string {
-	if self.quotedBaseBranches == nil {
-		self.quotedBaseBranches = lo.ToPtr(self.getExistingBaseBranches())
+	if self.quotedMainBranches == nil {
+		self.quotedMainBranches = lo.ToPtr(self.getExistingMainBranches())
 	}
 
-	if *self.quotedBaseBranches == "" {
+	if *self.quotedMainBranches == "" {
 		return ""
 	}
 
-	// We pass all configured base branches to the merge-base call; git will
+	// We pass all configured main branches to the merge-base call; git will
 	// return the base commit for the closest one.
 	output, err := self.cmd.New(fmt.Sprintf("git merge-base %s %s",
-		self.cmd.Quote(refName), *self.quotedBaseBranches)).DontLog().RunWithOutput()
+		self.cmd.Quote(refName), *self.quotedMainBranches)).DontLog().RunWithOutput()
 	if err != nil {
-		// If there's an error, it must be because one of the base branches that
-		// used to exist when we called getExistingBaseBranches() was deleted
+		// If there's an error, it must be because one of the main branches that
+		// used to exist when we called getExistingMainBranches() was deleted
 		// meanwhile. To fix this for next time, throw away our cache.
-		self.quotedBaseBranches = nil
+		self.quotedMainBranches = nil
 	}
 	return ignoringWarnings(output)
 }
 
-func (self *CommitLoader) getExistingBaseBranches() string {
-	quotedBaseBranches := strings.Join(
-		lo.FilterMap(self.UserConfig.Git.BaseBranches,
+func (self *CommitLoader) getExistingMainBranches() string {
+	return strings.Join(
+		lo.FilterMap(self.UserConfig.Git.MainBranches,
 			func(branchName string, _ int) (string, bool) {
 				quotedRef := self.cmd.Quote("refs/heads/" + branchName)
 				if err := self.cmd.New(fmt.Sprintf("git rev-parse --verify --quiet %s", quotedRef)).DontLog().Run(); err != nil {
 					return "", false
 				}
 				return quotedRef, true
 			}), " ")
-	return quotedBaseBranches
 }
 
 func ignoringWarnings(commandOutput string) string {

pkg/commands/git_commands/commit_loader_test.go

@@ -33,7 +33,7 @@ func TestGetCommits(t *testing.T) {
 		logOrder        string
 		rebaseMode      enums.RebaseMode
 		opts            GetCommitsOptions
-		baseBranches    []string
+		mainBranches    []string
 	}
 
 	scenarios := []scenario{
@@ -66,13 +66,13 @@ func TestGetCommits(t *testing.T) {
 			logOrder:     "topo-order",
 			rebaseMode:   enums.REBASE_MODE_NONE,
 			opts:         GetCommitsOptions{RefName: "HEAD", IncludeRebaseCommits: false},
-			baseBranches: []string{"master", "main"},
+			mainBranches: []string{"master", "main"},
 			runner: oscommands.NewFakeRunner(t).
 				// here it's seeing which commits are yet to be pushed
 				Expect(`git merge-base "HEAD" "HEAD"@{u}`, "b21997d6b4cbdf84b149d8e6a2c4d06a8e9ec164", nil).
 				// here it's actually getting all the commits in a formatted form, one per line
 				Expect(`git log "HEAD" --topo-order --oneline --pretty=format:"%H%x00%at%x00%aN%x00%ae%x00%d%x00%p%x00%s" --abbrev=40 --no-show-signature --`, commitsOutput, nil).
-				// here it's testing which of the configured base branches exist
+				// here it's testing which of the configured main branches exist
 				Expect(`git rev-parse --verify --quiet "refs/heads/master"`, "", nil).               // this one does
 				Expect(`git rev-parse --verify --quiet "refs/heads/main"`, "", errors.New("error")). // this one doesn't
 				// here it's seeing where our branch diverged from the master branch so that we can mark that commit and parent commits as 'merged'
@@ -195,17 +195,17 @@ func TestGetCommits(t *testing.T) {
 			expectedError: nil,
 		},
 		{
-			testName:     "should not call merge-base for baseBranches if none exist",
+			testName:     "should not call merge-base for mainBranches if none exist",
 			logOrder:     "topo-order",
 			rebaseMode:   enums.REBASE_MODE_NONE,
 			opts:         GetCommitsOptions{RefName: "HEAD", IncludeRebaseCommits: false},
-			baseBranches: []string{"master", "main"},
+			mainBranches: []string{"master", "main"},
 			runner: oscommands.NewFakeRunner(t).
 				// here it's seeing which commits are yet to be pushed
 				Expect(`git merge-base "HEAD" "HEAD"@{u}`, "b21997d6b4cbdf84b149d8e6a2c4d06a8e9ec164", nil).
 				// here it's actually getting all the commits in a formatted form, one per line
 				Expect(`git log "HEAD" --topo-order --oneline --pretty=format:"%H%x00%at%x00%aN%x00%ae%x00%d%x00%p%x00%s" --abbrev=40 --no-show-signature --`, singleCommitOutput, nil).
-				// here it's testing which of the configured base branches exist; neither does
+				// here it's testing which of the configured main branches exist; neither does
 				Expect(`git rev-parse --verify --quiet "refs/heads/master"`, "", errors.New("error")).
 				Expect(`git rev-parse --verify --quiet "refs/heads/main"`, "", errors.New("error")),
 
@@ -228,17 +228,17 @@ func TestGetCommits(t *testing.T) {
 			expectedError: nil,
 		},
 		{
-			testName:     "should call merge-base for all base branches that exist",
+			testName:     "should call merge-base for all main branches that exist",
 			logOrder:     "topo-order",
 			rebaseMode:   enums.REBASE_MODE_NONE,
 			opts:         GetCommitsOptions{RefName: "HEAD", IncludeRebaseCommits: false},
-			baseBranches: []string{"master", "main", "develop", "1.0-hotfixes"},
+			mainBranches: []string{"master", "main", "develop", "1.0-hotfixes"},
 			runner: oscommands.NewFakeRunner(t).
 				// here it's seeing which commits are yet to be pushed
 				Expect(`git merge-base "HEAD" "HEAD"@{u}`, "b21997d6b4cbdf84b149d8e6a2c4d06a8e9ec164", nil).
 				// here it's actually getting all the commits in a formatted form, one per line
 				Expect(`git log "HEAD" --topo-order --oneline --pretty=format:"%H%x00%at%x00%aN%x00%ae%x00%d%x00%p%x00%s" --abbrev=40 --no-show-signature --`, singleCommitOutput, nil).
-				// here it's testing which of the configured base branches exist
+				// here it's testing which of the configured main branches exist
 				Expect(`git rev-parse --verify --quiet "refs/heads/master"`, "", nil).
 				Expect(`git rev-parse --verify --quiet "refs/heads/main"`, "", errors.New("error")).
 				Expect(`git rev-parse --verify --quiet "refs/heads/develop"`, "", nil).
@@ -309,7 +309,7 @@ func TestGetCommits(t *testing.T) {
 				},
 			}
 
-			common.UserConfig.Git.BaseBranches = scenario.baseBranches
+			common.UserConfig.Git.MainBranches = scenario.mainBranches
 			commits, err := builder.GetCommits(scenario.opts)
 
 			assert.Equal(t, scenario.expectedCommits, commits)

pkg/config/user_config.go

@@ -76,7 +76,7 @@ type GitConfig struct {
 	Paging              PagingConfig                  `yaml:"paging"`
 	Commit              CommitConfig                  `yaml:"commit"`
 	Merging             MergingConfig                 `yaml:"merging"`
-	BaseBranches        []string                      `yaml:"baseBranches"`
+	MainBranches        []string                      `yaml:"mainBranches"`
 	SkipHookPrefix      string                        `yaml:"skipHookPrefix"`
 	AutoFetch           bool                          `yaml:"autoFetch"`
 	AutoRefresh         bool                          `yaml:"autoRefresh"`
@@ -444,7 +444,7 @@ func GetDefaultConfig() *UserConfig {
 				ShowWholeGraph: false,
 			},
 			SkipHookPrefix:      "WIP",
-			BaseBranches:        []string{"master", "main"},
+			MainBranches:        []string{"master", "main"},
 			AutoFetch:           true,
 			AutoRefresh:         true,
 			BranchLogCmd:        "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",