mirror of
https://github.com/jesseduffield/lazygit.git
synced 2024-11-26 09:00:57 +02:00
141 lines
3.4 KiB
Go
141 lines
3.4 KiB
Go
// This "script" generates a file called Keybindings_{{.LANG}}.md
|
|
// in current working directory.
|
|
//
|
|
// The content of this generated file is a keybindings cheatsheet.
|
|
//
|
|
// To generate cheatsheet in english run:
|
|
// LANG=en go run scripts/generate_cheatsheet.go
|
|
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"log"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/jesseduffield/lazygit/pkg/app"
|
|
"github.com/jesseduffield/lazygit/pkg/config"
|
|
"github.com/jesseduffield/lazygit/pkg/gui"
|
|
)
|
|
|
|
type bindingSection struct {
|
|
title string
|
|
bindings []*gui.Binding
|
|
}
|
|
|
|
func main() {
|
|
langs := []string{"pl", "nl", "en"}
|
|
mConfig, _ := config.NewAppConfig("", "", "", "", "", true)
|
|
|
|
for _, lang := range langs {
|
|
os.Setenv("LC_ALL", lang)
|
|
mApp, _ := app.NewApp(mConfig)
|
|
file, err := os.Create(getProjectRoot() + "/docs/keybindings/Keybindings_" + lang + ".md")
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
bindingSections := getBindingSections(mApp)
|
|
content := formatSections(mApp, bindingSections)
|
|
writeString(file, content)
|
|
}
|
|
}
|
|
|
|
func writeString(file *os.File, str string) {
|
|
_, err := file.WriteString(str)
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
}
|
|
|
|
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 formatBinding(binding *gui.Binding) string {
|
|
if binding.Alternative != "" {
|
|
return fmt.Sprintf(" <kbd>%s</kbd>: %s (%s)\n", binding.GetKey(), binding.Description, binding.Alternative)
|
|
}
|
|
return fmt.Sprintf(" <kbd>%s</kbd>: %s\n", binding.GetKey(), binding.Description)
|
|
}
|
|
|
|
func getBindingSections(mApp *app.App) []*bindingSection {
|
|
bindingSections := []*bindingSection{}
|
|
|
|
// TODO: add context-based keybindings
|
|
for _, binding := range mApp.Gui.GetInitialKeybindings() {
|
|
if binding.Description == "" {
|
|
continue
|
|
}
|
|
|
|
viewName := binding.ViewName
|
|
if viewName == "" {
|
|
viewName = "global"
|
|
}
|
|
title := localisedTitle(mApp, viewName)
|
|
|
|
bindingSections = addBinding(title, bindingSections, binding)
|
|
}
|
|
|
|
for contextName, contextBindings := range mApp.Gui.GetContextMap() {
|
|
translatedView := localisedTitle(mApp, contextBindings[0].ViewName)
|
|
translatedContextName := localisedTitle(mApp, contextName)
|
|
title := fmt.Sprintf("%s (%s)", translatedView, translatedContextName)
|
|
|
|
for _, binding := range contextBindings {
|
|
bindingSections = addBinding(title, bindingSections, binding)
|
|
}
|
|
}
|
|
|
|
return bindingSections
|
|
}
|
|
|
|
func addBinding(title string, bindingSections []*bindingSection, binding *gui.Binding) []*bindingSection {
|
|
if binding.Description == "" && binding.Alternative == "" {
|
|
return bindingSections
|
|
}
|
|
|
|
for _, section := range bindingSections {
|
|
if title == section.title {
|
|
section.bindings = append(section.bindings, binding)
|
|
return bindingSections
|
|
}
|
|
}
|
|
|
|
section := &bindingSection{
|
|
title: title,
|
|
bindings: []*gui.Binding{binding},
|
|
}
|
|
|
|
return append(bindingSections, section)
|
|
}
|
|
|
|
func formatSections(mApp *app.App, bindingSections []*bindingSection) string {
|
|
content := fmt.Sprintf("# Lazygit %s\n", mApp.Tr.SLocalize("menu"))
|
|
|
|
for _, section := range bindingSections {
|
|
content += formatTitle(section.title)
|
|
content += "<pre>\n"
|
|
for _, binding := range section.bindings {
|
|
content += formatBinding(binding)
|
|
}
|
|
content += "</pre>\n"
|
|
}
|
|
|
|
return content
|
|
}
|
|
|
|
func getProjectRoot() string {
|
|
dir, err := os.Getwd()
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
return strings.Split(dir, "lazygit")[0] + "lazygit"
|
|
}
|