Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make commit author length configurable, take 2 #3688

Merged
merged 2 commits into from
Jun 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/Config.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,10 +185,11 @@ gui:
# If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.
showFileIcons: true

# Whether to show full author names or their shortened form in the commit graph.
# One of 'auto' (default) | 'full' | 'short'
# If 'auto', initials will be shown in small windows, and full names - in larger ones.
commitAuthorFormat: auto
# Length of author name in (non-expanded) commits view. 2 means show initials only.
commitAuthorShortLength: 2

# Length of author name in expanded commits view. 2 means show initials only.
commitAuthorLongLength: 17

# Length of commit hash in commits view. 0 shows '*' if NF icons aren't on.
commitHashLength: 8
Expand Down
11 changes: 6 additions & 5 deletions pkg/config/user_config.go
Original file line number Diff line number Diff line change
Expand Up @@ -125,10 +125,10 @@ type GuiConfig struct {
NerdFontsVersion string `yaml:"nerdFontsVersion" jsonschema:"enum=2,enum=3,enum="`
// If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.
ShowFileIcons bool `yaml:"showFileIcons"`
// Whether to show full author names or their shortened form in the commit graph.
// One of 'auto' (default) | 'full' | 'short'
// If 'auto', initials will be shown in small windows, and full names - in larger ones.
CommitAuthorFormat string `yaml:"commitAuthorFormat" jsonschema:"enum=auto,enum=short,enum=full"`
// Length of author name in (non-expanded) commits view. 2 means show initials only.
CommitAuthorShortLength int `yaml:"commitAuthorShortLength"`
// Length of author name in expanded commits view. 2 means show initials only.
CommitAuthorLongLength int `yaml:"commitAuthorLongLength"`
// Length of commit hash in commits view. 0 shows '*' if NF icons aren't on.
CommitHashLength int `yaml:"commitHashLength" jsonschema:"minimum=0"`
// If true, show commit hashes alongside branch names in the branches view.
Expand Down Expand Up @@ -687,7 +687,6 @@ func GetDefaultConfig() *UserConfig {
UnstagedChangesColor: []string{"red"},
DefaultFgColor: []string{"default"},
},
CommitAuthorFormat: "auto",
CommitLength: CommitLengthConfig{Show: true},
SkipNoStagedFilesWarning: false,
ShowListFooter: true,
Expand All @@ -699,6 +698,8 @@ func GetDefaultConfig() *UserConfig {
ShowIcons: false,
NerdFontsVersion: "",
ShowFileIcons: true,
CommitAuthorShortLength: 2,
CommitAuthorLongLength: 17,
CommitHashLength: 8,
ShowBranchCommitHash: false,
ShowDivergenceFromBaseBranch: "none",
Expand Down
5 changes: 0 additions & 5 deletions pkg/config/user_config_validation.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@ import (
)

func (config *UserConfig) Validate() error {
if err := validateEnum("gui.commitAuthorFormat", config.Gui.CommitAuthorFormat,
[]string{"auto", "short", "full"}); err != nil {
return err
}

if err := validateEnum("gui.statusPanelView", config.Gui.StatusPanelView,
[]string{"dashboard", "allBranchesLog"}); err != nil {
return err
Expand Down
35 changes: 29 additions & 6 deletions pkg/gui/presentation/authors/authors.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,16 @@ import (
"github.com/mattn/go-runewidth"
)

type authorNameCacheKey struct {
authorName string
truncateTo int
}

// if these being global variables causes trouble we can wrap them in a struct
// attached to the gui state.
var (
authorInitialCache = make(map[string]string)
authorNameCache = make(map[string]string)
authorNameCache = make(map[authorNameCacheKey]string)
authorStyleCache = make(map[string]style.TextStyle)
)

Expand All @@ -37,19 +42,37 @@ func ShortAuthor(authorName string) string {
return value
}

func LongAuthor(authorName string) string {
if value, ok := authorNameCache[authorName]; ok {
func LongAuthor(authorName string, length int) string {
cacheKey := authorNameCacheKey{authorName: authorName, truncateTo: length}
if value, ok := authorNameCache[cacheKey]; ok {
return value
}

paddedAuthorName := utils.WithPadding(authorName, 17, utils.AlignLeft)
truncatedName := utils.TruncateWithEllipsis(paddedAuthorName, 17)
paddedAuthorName := utils.WithPadding(authorName, length, utils.AlignLeft)
truncatedName := utils.TruncateWithEllipsis(paddedAuthorName, length)
value := AuthorStyle(authorName).Sprint(truncatedName)
authorNameCache[authorName] = value
authorNameCache[cacheKey] = value

return value
}

// AuthorWithLength returns a representation of the author that fits into a
// given maximum length:
// - if the length is less than 2, it returns an empty string
// - if the length is 2, it returns the initials
// - otherwise, it returns the author name truncated to the maximum length
func AuthorWithLength(authorName string, length int) string {
if length < 2 {
return ""
}

if length == 2 {
return ShortAuthor(authorName)
}

return LongAuthor(authorName, length)
}

func AuthorStyle(authorName string) style.TextStyle {
if value, ok := authorStyleCache[authorName]; ok {
return value
Expand Down
25 changes: 24 additions & 1 deletion pkg/gui/presentation/authors/authors_test.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
package authors

import "testing"
import (
"testing"

"github.com/jesseduffield/lazygit/pkg/utils"
"github.com/stretchr/testify/assert"
)

func TestGetInitials(t *testing.T) {
for input, expectedOutput := range map[string]string{
Expand All @@ -18,3 +23,21 @@ func TestGetInitials(t *testing.T) {
}
}
}

func TestAuthorWithLength(t *testing.T) {
scenarios := []struct {
authorName string
length int
expectedOutput string
}{
{"Jesse Duffield", 0, ""},
{"Jesse Duffield", 1, ""},
{"Jesse Duffield", 2, "JD"},
{"Jesse Duffield", 3, "Je…"},
{"Jesse Duffield", 10, "Jesse Duf…"},
{"Jesse Duffield", 14, "Jesse Duffield"},
}
for _, s := range scenarios {
assert.Equal(t, s.expectedOutput, utils.Decolorise(AuthorWithLength(s.authorName, s.length)))
}
}
14 changes: 5 additions & 9 deletions pkg/gui/presentation/commits.go
Original file line number Diff line number Diff line change
Expand Up @@ -440,15 +440,11 @@ func displayCommit(
mark = fmt.Sprintf("%s ", willBeRebased)
}

var authorFunc func(string) string
switch common.UserConfig.Gui.CommitAuthorFormat {
case "short":
authorFunc = authors.ShortAuthor
case "full":
authorFunc = authors.LongAuthor
default:
authorFunc = lo.Ternary(fullDescription, authors.LongAuthor, authors.ShortAuthor)
authorLength := common.UserConfig.Gui.CommitAuthorShortLength
if fullDescription {
authorLength = common.UserConfig.Gui.CommitAuthorLongLength
}
author := authors.AuthorWithLength(commit.AuthorName, authorLength)

cols := make([]string, 0, 7)
cols = append(
Expand All @@ -458,7 +454,7 @@ func displayCommit(
bisectString,
descriptionString,
actionString,
authorFunc(commit.AuthorName),
author,
graphLine+mark+tagString+theme.DefaultTextColor.Sprint(name),
)

Expand Down
18 changes: 9 additions & 9 deletions schema/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -332,15 +332,15 @@
"description": "If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.",
"default": true
},
"commitAuthorFormat": {
"type": "string",
"enum": [
"auto",
"short",
"full"
],
"description": "Whether to show full author names or their shortened form in the commit graph.\nOne of 'auto' (default) | 'full' | 'short'\nIf 'auto', initials will be shown in small windows, and full names - in larger ones.",
"default": "auto"
"commitAuthorShortLength": {
"type": "integer",
"description": "Length of author name in (non-expanded) commits view. 2 means show initials only.",
"default": 2
},
"commitAuthorLongLength": {
"type": "integer",
"description": "Length of author name in expanded commits view. 2 means show initials only.",
"default": 17
},
"commitHashLength": {
"type": "integer",
Expand Down
Loading