summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--Keybindings_en.md114
-rw-r--r--pkg/gui/context.go4
-rw-r--r--pkg/gui/keybindings.go110
-rw-r--r--pkg/i18n/english.go45
-rw-r--r--scripts/generate_cheatsheet.go50
5 files changed, 281 insertions, 42 deletions
diff --git a/Keybindings_en.md b/Keybindings_en.md
new file mode 100644
index 000000000..ff91437df
--- /dev/null
+++ b/Keybindings_en.md
@@ -0,0 +1,114 @@
+# Lazygit menu
+
+## Global
+
+<pre>
+ <kbd>m</kbd>: view merge/rebase options
+ <kbd>P</kbd>: push
+ <kbd>p</kbd>: pull
+ <kbd>R</kbd>: refresh
+</pre>
+
+## Status
+
+<pre>
+ <kbd>e</kbd>: edit config file
+ <kbd>o</kbd>: open config file
+ <kbd>u</kbd>: check for update
+ <kbd>s</kbd>: switch to a recent repo
+</pre>
+
+## Files
+
+<pre>
+ <kbd>c</kbd>: commit changes
+ <kbd>A</kbd>: amend last commit
+ <kbd>C</kbd>: commit changes using git editor
+ <kbd>space</kbd>: toggle staged
+ <kbd>d</kbd>: delete if untracked / checkout if tracked
+ <kbd>e</kbd>: edit file
+ <kbd>o</kbd>: open file
+ <kbd>i</kbd>: add to .gitignore
+ <kbd>r</kbd>: refresh files
+ <kbd>s</kbd>: stash files
+ <kbd>S</kbd>: soft reset to last commit
+ <kbd>a</kbd>: stage/unstage all
+ <kbd>t</kbd>: add patch
+ <kbd>D</kbd>: reset hard and remove untracked files
+ <kbd>enter</kbd>: stage individual hunks/lines
+ <kbd>f</kbd>: fetch
+</pre>
+
+## Branches
+
+<pre>
+ <kbd>space</kbd>: checkout
+ <kbd>o</kbd>: create pull request
+ <kbd>c</kbd>: checkout by name
+ <kbd>F</kbd>: force checkout
+ <kbd>n</kbd>: new branch
+ <kbd>d</kbd>: delete branch
+ <kbd>r</kbd>: rebase branch
+ <kbd>M</kbd>: merge into currently checked out branch
+ <kbd>f</kbd>: fast-forward this branch from its upstream
+</pre>
+
+## Commits
+
+<pre>
+ <kbd>s</kbd>: squash down
+ <kbd>r</kbd>: rename commit
+ <kbd>R</kbd>: rename commit with editor
+ <kbd>g</kbd>: reset to this commit
+ <kbd>f</kbd>: fixup commit
+ <kbd>d</kbd>: delete commit
+ <kbd>J</kbd>: move commit down one
+ <kbd>K</kbd>: move commit up one
+ <kbd>e</kbd>: edit commit
+ <kbd>A</kbd>: amend commit with staged changes
+ <kbd>p</kbd>: pick commit (when mid-rebase)
+ <kbd>t</kbd>: revert commit
+ <kbd>c</kbd>: copy commit (cherry-pick)
+ <kbd>C</kbd>: copy commit range (cherry-pick)
+ <kbd>v</kbd>: paste commits (cherry-pick)
+</pre>
+
+## Stash
+
+<pre>
+ <kbd>space</kbd>: apply
+ <kbd>g</kbd>: pop
+ <kbd>d</kbd>: drop
+</pre>
+
+## Main (Normal)
+
+<pre>
+ <kbd>PgDn</kbd>: scroll down
+ <kbd>PgUp</kbd>: scroll up
+</pre>
+
+## Main (Staging)
+
+<pre>
+ <kbd>esc</kbd>: return to files panel
+ <kbd>▲</kbd>: select previous line
+ <kbd>▼</kbd>: select next line
+ <kbd>◄</kbd>: select previous hunk
+ <kbd>►</kbd>: select next hunk
+ <kbd>space</kbd>: stage line
+ <kbd>a</kbd>: stage hunk
+</pre>
+
+## Main (Merging)
+
+<pre>
+ <kbd>esc</kbd>: return to files panel
+ <kbd>space</kbd>: pick hunk
+ <kbd>b</kbd>: pick both hunks
+ <kbd>◄</kbd>: select previous conflict
+ <kbd>►</kbd>: select next conflict
+ <kbd>▲</kbd>: select top hunk
+ <kbd>▼</kbd>: select bottom hunk
+ <kbd>z</kbd>: undo
+</pre>
diff --git a/pkg/gui/context.go b/pkg/gui/context.go
index d349286cf..861ffc0be 100644
--- a/pkg/gui/context.go
+++ b/pkg/gui/context.go
@@ -38,7 +38,7 @@ func (gui *Gui) changeContext(viewName, context string) error {
return nil
}
- contextMap := gui.getContextMap()
+ contextMap := gui.GetContextMap()
gui.g.DeleteKeybindings(viewName)
@@ -53,7 +53,7 @@ func (gui *Gui) changeContext(viewName, context string) error {
}
func (gui *Gui) setInitialContexts() error {
- contextMap := gui.getContextMap()
+ contextMap := gui.GetContextMap()
initialContexts := map[string]string{
"main": "merging",
diff --git a/pkg/gui/keybindings.go b/pkg/gui/keybindings.go
index 3992513ef..6084d26e7 100644
--- a/pkg/gui/keybindings.go
+++ b/pkg/gui/keybindings.go
@@ -13,6 +13,7 @@ type Binding struct {
Key interface{} // FIXME: find out how to get `gocui.Key | rune`
Modifier gocui.Modifier
Description string
+ panic bool
}
// GetDisplayStrings returns the display string of a file
@@ -31,6 +32,10 @@ func (b *Binding) GetKey() string {
key = int(b.Key.(gocui.Key))
}
+ if b.panic {
+ panic(key)
+ }
+
// special keys
switch key {
case 27:
@@ -39,6 +44,18 @@ func (b *Binding) GetKey() string {
return "enter"
case 32:
return "space"
+ case 65514:
+ return "►"
+ case 65515:
+ return "◄"
+ case 65517:
+ return "▲"
+ case 65516:
+ return "▼"
+ case 65508:
+ return "PgUp"
+ case 65507:
+ return "PgDn"
}
return string(key)
@@ -461,11 +478,12 @@ func (gui *Gui) GetInitialKeybindings() []*Binding {
return bindings
}
+// GetCurrentKeybindings gets the list of keybindings given the current context
func (gui *Gui) GetCurrentKeybindings() []*Binding {
bindings := gui.GetInitialKeybindings()
viewName := gui.currentViewName(gui.g)
currentContext := gui.State.Contexts[viewName]
- contextBindings := gui.getContextMap()[viewName][currentContext]
+ contextBindings := gui.GetContextMap()[viewName][currentContext]
return append(bindings, contextBindings...)
}
@@ -484,9 +502,24 @@ func (gui *Gui) keybindings(g *gocui.Gui) error {
return nil
}
-func (gui *Gui) getContextMap() map[string]map[string][]*Binding {
+func (gui *Gui) GetContextMap() map[string]map[string][]*Binding {
return map[string]map[string][]*Binding{
"main": {
+ "normal": {
+ {
+ ViewName: "main",
+ Key: gocui.MouseWheelDown,
+ Modifier: gocui.ModNone,
+ Handler: gui.scrollDownMain,
+ Description: gui.Tr.SLocalize("ScrollDown"),
+ }, {
+ ViewName: "main",
+ Key: gocui.MouseWheelUp,
+ Modifier: gocui.ModNone,
+ Handler: gui.scrollUpMain,
+ Description: gui.Tr.SLocalize("ScrollUp"),
+ },
+ },
"staging": {
{
ViewName: "main",
@@ -495,15 +528,17 @@ func (gui *Gui) getContextMap() map[string]map[string][]*Binding {
Handler: gui.handleStagingEscape,
Description: gui.Tr.SLocalize("EscapeStaging"),
}, {
- ViewName: "main",
- Key: gocui.KeyArrowUp,
- Modifier: gocui.ModNone,
- Handler: gui.handleStagingPrevLine,
+ ViewName: "main",
+ Key: gocui.KeyArrowUp,
+ Modifier: gocui.ModNone,
+ Handler: gui.handleStagingPrevLine,
+ Description: gui.Tr.SLocalize("PrevLine"),
}, {
- ViewName: "main",
- Key: gocui.KeyArrowDown,
- Modifier: gocui.ModNone,
- Handler: gui.handleStagingNextLine,
+ ViewName: "main",
+ Key: gocui.KeyArrowDown,
+ Modifier: gocui.ModNone,
+ Handler: gui.handleStagingNextLine,
+ Description: gui.Tr.SLocalize("NextLine"),
}, {
ViewName: "main",
Key: 'k',
@@ -516,14 +551,26 @@ func (gui *Gui) getContextMap() map[string]map[string][]*Binding {
Handler: gui.handleStagingNextLine,
}, {
ViewName: "main",
- Key: gocui.KeyArrowLeft,
+ Key: gocui.MouseWheelUp,
Modifier: gocui.ModNone,
- Handler: gui.handleStagingPrevHunk,
+ Handler: gui.handleStagingPrevLine,
}, {
ViewName: "main",
- Key: gocui.KeyArrowRight,
+ Key: gocui.MouseWheelDown,
Modifier: gocui.ModNone,
- Handler: gui.handleStagingNextHunk,
+ Handler: gui.handleStagingNextLine,
+ }, {
+ ViewName: "main",
+ Key: gocui.KeyArrowLeft,
+ Modifier: gocui.ModNone,
+ Handler: gui.handleStagingPrevHunk,
+ Description: gui.Tr.SLocalize("PrevHunk"),
+ }, {
+ ViewName: "main",
+ Key: gocui.KeyArrowRight,
+ Modifier: gocui.ModNone,
+ Handler: gui.handleStagingNextHunk,
+ Description: gui.Tr.SLocalize("NextHunk"),
}, {
ViewName: "main",
Key: 'h',
@@ -550,10 +597,11 @@ func (gui *Gui) getContextMap() map[string]map[string][]*Binding {
},
"merging": {
{
- ViewName: "main",
- Key: gocui.KeyEsc,
- Modifier: gocui.ModNone,
- Handler: gui.handleEscapeMerge,
+ ViewName: "main",
+ Key: gocui.KeyEsc,
+ Modifier: gocui.ModNone,
+ Handler: gui.handleEscapeMerge,
+ Description: gui.Tr.SLocalize("EscapeStaging"),
}, {
ViewName: "main",
Key: gocui.KeySpace,
@@ -567,25 +615,31 @@ func (gui *Gui) getContextMap() map[string]map[string][]*Binding {
Handler: gui.handlePickBothHunks,
Description: gui.Tr.SLocalize("PickBothHunks"),
}, {
- ViewName: "main",
- Key: gocui.KeyArrowLeft,
- Modifier: gocui.ModNone,
- Handler: gui.handleSelectPrevConflict,
+ ViewName: "main",
+ Key: gocui.KeyArrowLeft,
+ Modifier: gocui.ModNone,
+ Handler: gui.handleSelectPrevConflict,
+ Description: gui.Tr.SLocalize("PrevConflict"),
}, {
ViewName: "main",
Key: gocui.KeyArrowRight,
Modifier: gocui.ModNone,
Handler: gui.handleSelectNextConflict,
+
+ Description: gui.Tr.SLocalize("NextConflict"),
}, {
ViewName: "main",
Key: gocui.KeyArrowUp,
- Modifier: gocui.ModNone,
- Handler: gui.handleSelectTop,
+
+ Modifier: gocui.ModNone,
+ Handler: gui.handleSelectTop,
+ Description: gui.Tr.SLocalize("SelectTop"),
}, {
- ViewName: "main",
- Key: gocui.KeyArrowDown,
- Modifier: gocui.ModNone,
- Handler: gui.handleSelectBottom,
+ ViewName: "main",
+ Key: gocui.KeyArrowDown,
+ Modifier: gocui.ModNone,
+ Handler: gui.handleSelectBottom,
+ Description: gui.Tr.SLocalize("SelectBottom"),
}, {
ViewName: "main",
Key: 'h',
diff --git a/pkg/i18n/english.go b/pkg/i18n/english.go
index 74d9bfb7d..7195c5f0d 100644
--- a/pkg/i18n/english.go
+++ b/pkg/i18n/english.go
@@ -46,6 +46,18 @@ func addEnglish(i18nObject *i18n.Bundle) error {
ID: "MergingMainTitle",
Other: "Resolve merge conflicts",
}, &i18n.Message{
+ ID: "MainTitle",
+ Other: "Main",
+ }, &i18n.Message{
+ ID: "StagingTitle",
+ Other: "Staging",
+ }, &i18n.Message{
+ ID: "MergingTitle",
+ Other: "Merging",
+ }, &i18n.Message{
+ ID: "NormalTitle",
+ Other: "Normal",
+ }, &i18n.Message{
ID: "CommitMessage",
Other: "Commit message",
}, &i18n.Message{
@@ -588,6 +600,39 @@ func addEnglish(i18nObject *i18n.Bundle) error {
}, &i18n.Message{
ID: "CannotRebaseOntoFirstCommit",
Other: "You cannot interactive rebase onto the first commit",
+ }, &i18n.Message{
+ ID: "Donate",
+ Other: "Donate",
+ }, &i18n.Message{
+ ID: "PrevLine",
+ Other: "select previous line",
+ }, &i18n.Message{
+ ID: "NextLine",
+ Other: "select next line",
+ }, &i18n.Message{
+ ID: "PrevHunk",
+ Other: "select previous hunk",
+ }, &i18n.Message{
+ ID: "NextHunk",
+ Other: "select next hunk",
+ }, &i18n.Message{
+ ID: "PrevConflict",
+ Other: "select previous conflict",
+ }, &i18n.Message{
+ ID: "NextConflict",
+ Other: "select next conflict",
+ }, &i18n.Message{
+ ID: "SelectTop",
+ Other: "select top hunk",
+ }, &i18n.Message{
+ ID: "SelectBottom",
+ Other: "select bottom hunk",
+ }, &i18n.Message{
+ ID: "ScrollDown",
+ Other: "scroll down",
+ }, &i18n.Message{
+ ID: "ScrollUp",
+ Other: "scroll up",
},
)
}
diff --git a/scripts/generate_cheatsheet.go b/scripts/generate_cheatsheet.go
index d42088d6b..92d5880a5 100644
--- a/scripts/generate_cheatsheet.go
+++ b/scripts/generate_cheatsheet.go
@@ -16,6 +16,7 @@ import (
"github.com/jesseduffield/lazygit/pkg/app"
"github.com/jesseduffield/lazygit/pkg/config"
+ "github.com/jesseduffield/lazygit/pkg/gui"
)
func writeString(file *os.File, str string) {
@@ -25,27 +26,36 @@ func writeString(file *os.File, str string) {
}
}
-func getTitle(mApp *app.App, viewName string) string {
- viewTitle := strings.Title(viewName) + "Title"
- translatedTitle := mApp.Tr.SLocalize(viewTitle)
- formattedTitle := fmt.Sprintf("\n## %s\n\n", translatedTitle)
- return formattedTitle
+func localisedTitle(mApp *app.App, str string) string {
+ viewTitle := strings.Title(str) + "Title"
+ return mApp.Tr.SLocalize(viewTitle)
}
+func formatTitle(title string) string {
+ return fmt.Sprintf("\n## %s\n\n", title)
+}
+
+func writeBinding(file *os.File, binding *gui.Binding) {
+ info := fmt.Sprintf(" <kbd>%s</kbd>: %s\n", binding.GetKey(), binding.Description)
+ writeString(file, info)
+}
+
+// I should really just build an array of tuples, one thing with a string and the other with a list of bindings, and then build them like that.
+
func main() {
- mConfig, _ := config.NewAppConfig("", "", "", "", "", new(bool))
- mApp, _ := app.Setup(mConfig)
+ mConfig, _ := config.NewAppConfig("", "", "", "", "", true)
+ mApp, _ := app.NewApp(mConfig)
lang := mApp.Tr.GetLanguage()
file, _ := os.Create("Keybindings_" + lang + ".md")
current := ""
writeString(file, fmt.Sprintf("# Lazygit %s\n", mApp.Tr.SLocalize("menu")))
- writeString(file, getTitle(mApp, "global"))
+ writeString(file, formatTitle(localisedTitle(mApp, "global")))
writeString(file, "<pre>\n")
// TODO: add context-based keybindings
- for _, binding := range mApp.Gui.GetKeybindings() {
+ for _, binding := range mApp.Gui.GetInitialKeybindings() {
if binding.Description == "" {
continue
}
@@ -53,13 +63,29 @@ func main() {
if binding.ViewName != current {
current = binding.ViewName
writeString(file, "</pre>\n")
- writeString(file, getTitle(mApp, current))
+ writeString(file, formatTitle(localisedTitle(mApp, current)))
writeString(file, "<pre>\n")
}
- info := fmt.Sprintf(" <kbd>%s</kbd>: %s\n", binding.GetKey(), binding.Description)
- writeString(file, info)
+ writeBinding(file, binding)
}
writeString(file, "</pre>\n")
+
+ for view, contexts := range mApp.Gui.GetContextMap() {
+ for contextName, contextBindings := range contexts {
+ translatedView := localisedTitle(mApp, view)
+ translatedContextName := localisedTitle(mApp, contextName)
+ writeString(file, fmt.Sprintf("\n## %s (%s)\n\n", translatedView, translatedContextName))
+ writeString(file, "<pre>\n")
+ for _, binding := range contextBindings {
+ if binding.Description == "" {
+ continue
+ }
+
+ writeBinding(file, binding)
+ }
+ writeString(file, "</pre>\n")
+ }
+ }
}
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-07 07:43:25 +0000