File: commit.go

package info (click to toggle)
lazygit 0.50.0%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,808 kB
  • sloc: sh: 128; makefile: 76
file content (155 lines) | stat: -rw-r--r-- 3,600 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
package models

import (
	"fmt"

	"github.com/jesseduffield/lazygit/pkg/utils"
	"github.com/samber/lo"
	"github.com/fsmiamoto/git-todo-parser/todo"
)

// Special commit hash for empty tree object
const EmptyTreeCommitHash = "4b825dc642cb6eb9a060e54bf8d69288fbee4904"

type CommitStatus uint8

const (
	StatusNone CommitStatus = iota
	StatusUnpushed
	StatusPushed
	StatusMerged
	StatusRebasing
	StatusCherryPickingOrReverting
	StatusConflicted
	StatusReflog
)

const (
	// Conveniently for us, the todo package starts the enum at 1, and given
	// that it doesn't have a "none" value, we're setting ours to 0
	ActionNone todo.TodoCommand = 0
)

type Divergence uint8

// For a divergence log (left/right comparison of two refs) this is set to
// either DivergenceLeft or DivergenceRight for each commit; for normal
// commit views it is always DivergenceNone.
const (
	DivergenceNone Divergence = iota
	DivergenceLeft
	DivergenceRight
)

// Commit : A git commit
type Commit struct {
	hash          *string
	Name          string
	Tags          []string
	ExtraInfo     string // something like 'HEAD -> master, tag: v0.15.2'
	AuthorName    string // something like 'Jesse Duffield'
	AuthorEmail   string // something like 'jessedduffield@gmail.com'
	UnixTimestamp int64

	// Hashes of parent commits (will be multiple if it's a merge commit)
	parents []*string

	Status     CommitStatus
	Action     todo.TodoCommand
	Divergence Divergence // set to DivergenceNone unless we are showing the divergence view
}

type NewCommitOpts struct {
	Hash          string
	Name          string
	Status        CommitStatus
	Action        todo.TodoCommand
	Tags          []string
	ExtraInfo     string
	AuthorName    string
	AuthorEmail   string
	UnixTimestamp int64
	Divergence    Divergence
	Parents       []string
}

func NewCommit(hashPool *utils.StringPool, opts NewCommitOpts) *Commit {
	return &Commit{
		hash:          hashPool.Add(opts.Hash),
		Name:          opts.Name,
		Status:        opts.Status,
		Action:        opts.Action,
		Tags:          opts.Tags,
		ExtraInfo:     opts.ExtraInfo,
		AuthorName:    opts.AuthorName,
		AuthorEmail:   opts.AuthorEmail,
		UnixTimestamp: opts.UnixTimestamp,
		Divergence:    opts.Divergence,
		parents:       lo.Map(opts.Parents, func(s string, _ int) *string { return hashPool.Add(s) }),
	}
}

func (c *Commit) Hash() string {
	return *c.hash
}

func (c *Commit) HashPtr() *string {
	return c.hash
}

func (c *Commit) ShortHash() string {
	return utils.ShortHash(c.Hash())
}

func (c *Commit) FullRefName() string {
	return c.Hash()
}

func (c *Commit) RefName() string {
	return c.Hash()
}

func (c *Commit) ShortRefName() string {
	return c.Hash()[:7]
}

func (c *Commit) ParentRefName() string {
	if c.IsFirstCommit() {
		return EmptyTreeCommitHash
	}
	return c.RefName() + "^"
}

func (c *Commit) Parents() []string {
	return lo.Map(c.parents, func(s *string, _ int) string { return *s })
}

func (c *Commit) ParentPtrs() []*string {
	return c.parents
}

func (c *Commit) IsFirstCommit() bool {
	return len(c.parents) == 0
}

func (c *Commit) ID() string {
	return c.RefName()
}

func (c *Commit) Description() string {
	return fmt.Sprintf("%s %s", c.Hash()[:7], c.Name)
}

func (c *Commit) IsMerge() bool {
	return len(c.parents) > 1
}

// returns true if this commit is not actually in the git log but instead
// is from a TODO file for an interactive rebase.
func (c *Commit) IsTODO() bool {
	return c.Action != ActionNone
}

func IsHeadCommit(commits []*Commit, index int) bool {
	return !commits[index].IsTODO() && (index == 0 || commits[index-1].IsTODO())
}