mirror of
https://github.com/jesseduffield/lazygit.git
synced 2026-08-28 02:24:49 -05:00
Stefan Haller
8731d8a51b
For a long time lazygit has used the term "custom pager" to refer to what's really a "diff renderer". A pager is a program that allows you to view output page by page (hence the name), e.g. less; lazygit's custom diff renderers are not pagers. It used the term only because the feature is implemented using git's GIT_PAGER env var, but that's an implementation detail. Rename the 'git.pagers' config to 'git.diffRenderers', and restructure its elements while we're at it to make things clearer: - Add a 'type' field to explicitly specify which type of diff renderer it is (the two fundamentally different ones are 'stdinFilter' and 'extDiff'). - Add a third type, 'rawGit', which has an 'args' field that makes it easy to use 'git --color-words' as a custom renderer - Unify the old 'pager' and 'externalDiffCommand' fields to a single 'command' field for both types Existing config files are migrated automatically.
97 lines
3.2 KiB
Go
97 lines
3.2 KiB
Go
package config
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/jesseduffield/lazygit/pkg/i18n"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestCurrentDiffRendererName(t *testing.T) {
|
|
tr := i18n.EnglishTranslationSet()
|
|
|
|
scenarios := []struct {
|
|
name string
|
|
diffRendererConfig DiffRendererConfig
|
|
expected string
|
|
}{
|
|
{
|
|
name: "explicit name takes precedence over the command",
|
|
diffRendererConfig: DiffRendererConfig{Name: "delta side-by-side", Command: "delta --side-by-side"},
|
|
expected: "delta side-by-side",
|
|
},
|
|
{
|
|
name: "derived from the first word of the stdinFilter command",
|
|
diffRendererConfig: DiffRendererConfig{Command: "delta --side-by-side"},
|
|
expected: "delta",
|
|
},
|
|
{
|
|
name: "surrounding whitespace in the command is ignored",
|
|
diffRendererConfig: DiffRendererConfig{Command: " diff-so-fancy "},
|
|
expected: "diff-so-fancy",
|
|
},
|
|
{
|
|
name: "derived from the first word of the extDiff command",
|
|
diffRendererConfig: DiffRendererConfig{Type: "extDiff", Command: "difft --color=always"},
|
|
expected: "difft",
|
|
},
|
|
{
|
|
name: "no name can be derived for external diff",
|
|
diffRendererConfig: DiffRendererConfig{Type: "extDiff"},
|
|
expected: tr.ExternalDiffDiffRendererName,
|
|
},
|
|
{
|
|
name: "derived from first argument of rawGit args",
|
|
diffRendererConfig: DiffRendererConfig{Type: "rawGit", Args: []string{"--color-words"}},
|
|
expected: "--color-words",
|
|
},
|
|
{
|
|
name: "no name can be derived for raw diff",
|
|
diffRendererConfig: DiffRendererConfig{Type: "rawGit"},
|
|
expected: tr.DefaultDiffRendererName,
|
|
},
|
|
}
|
|
|
|
for _, s := range scenarios {
|
|
t.Run(s.name, func(t *testing.T) {
|
|
userConfig := &UserConfig{}
|
|
userConfig.Git.DiffRenderers = []DiffRendererConfig{s.diffRendererConfig}
|
|
config := NewDiffRendererConfigManager(func() *UserConfig { return userConfig })
|
|
|
|
assert.Equal(t, s.expected, config.CurrentDiffRendererName(tr))
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestCurrentDiffRendererNameWithoutDiffRenderers(t *testing.T) {
|
|
config := NewDiffRendererConfigManager(func() *UserConfig { return &UserConfig{} })
|
|
|
|
tr := i18n.EnglishTranslationSet()
|
|
assert.Equal(t, tr.DefaultDiffRendererName, config.CurrentDiffRendererName(tr))
|
|
}
|
|
|
|
func TestCycleDiffRenderers(t *testing.T) {
|
|
userConfig := &UserConfig{}
|
|
userConfig.Git.DiffRenderers = []DiffRendererConfig{{Name: "a"}, {Name: "b"}, {Name: "c"}}
|
|
config := NewDiffRendererConfigManager(func() *UserConfig { return userConfig })
|
|
|
|
currentIndex := func() int {
|
|
index, _ := config.CurrentDiffRendererIndex()
|
|
return index
|
|
}
|
|
|
|
assert.Equal(t, 0, currentIndex())
|
|
|
|
config.CycleDiffRenderers()
|
|
assert.Equal(t, 1, currentIndex())
|
|
config.CycleDiffRenderers()
|
|
assert.Equal(t, 2, currentIndex())
|
|
config.CycleDiffRenderers()
|
|
assert.Equal(t, 0, currentIndex(), "cycling forward past the last diff renderer wraps to the first")
|
|
|
|
config.CycleDiffRenderersBackward()
|
|
assert.Equal(t, 2, currentIndex(), "cycling backward past the first diff renderer wraps to the last")
|
|
config.CycleDiffRenderersBackward()
|
|
assert.Equal(t, 1, currentIndex())
|
|
}
|