add cheatsheet check script

3 files changed, 27 insertions, 321 deletions

diff --git a/scripts/cheatsheet/main.go b/scripts/cheatsheet/main.go
new file mode 100644
index 000000000..bccf3324a
--- /dev/null
+++ b/scripts/cheatsheet/main.go
@@ -0,0 +1,27 @@
+package main
+
+import (
+	"fmt"
+	"log"
+	"os"
+
+	"github.com/jesseduffield/lazygit/pkg/cheatsheet"
+)
+
+func main() {
+	if len(os.Args) < 2 {
+		log.Fatal("Please provide a command: one of 'generate', 'check'")
+	}
+
+	command := os.Args[1]
+
+	switch command {
+	case "generate":
+		cheatsheet.Generate()
+		fmt.Printf("\nGenerated cheatsheets in %s\n", cheatsheet.GetDir())
+	case "check":
+		cheatsheet.Check()
+	default:
+		log.Fatal("\nUnknown command. Expected one of 'generate', 'check'")
+	}
+}
diff --git a/scripts/generate_cheatsheet.go b/scripts/generate_cheatsheet.go
deleted file mode 100644
index fc188b6f9..000000000
--- a/scripts/generate_cheatsheet.go
+++ /dev/null
@@ -1,258 +0,0 @@
-// 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"
-	"sort"
-	"strings"
-
-	"github.com/jesseduffield/lazygit/pkg/app"
-	"github.com/jesseduffield/lazygit/pkg/config"
-	"github.com/jesseduffield/lazygit/pkg/gui"
-	"github.com/jesseduffield/lazygit/pkg/i18n"
-)
-
-type bindingSection struct {
-	title    string
-	bindings []*gui.Binding
-}
-
-func main() {
-	translationSetsByLang := i18n.GetTranslationSets()
-	mConfig := config.NewDummyAppConfig()
-
-	for lang := range translationSetsByLang {
-		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.Tr, bindingSections)
-		content = fmt.Sprintf("# This file is auto-generated. To update, make the changes in the "+
-			"pkg/i18n directory and then run `go run scripts/generate_cheatsheet.go` from the project root.\n\n%s", content)
-		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 {
-	tr := mApp.Tr
-
-	contextTitleMap := map[string]string{
-		"global":         tr.GlobalTitle,
-		"navigation":     tr.NavigationTitle,
-		"branches":       tr.BranchesTitle,
-		"localBranches":  tr.LocalBranchesTitle,
-		"files":          tr.FilesTitle,
-		"status":         tr.StatusTitle,
-		"submodules":     tr.SubmodulesTitle,
-		"subCommits":     tr.SubCommitsTitle,
-		"remoteBranches": tr.RemoteBranchesTitle,
-		"remotes":        tr.RemotesTitle,
-		"reflogCommits":  tr.ReflogCommitsTitle,
-		"tags":           tr.TagsTitle,
-		"commitFiles":    tr.CommitFilesTitle,
-		"commitMessage":  tr.CommitMessageTitle,
-		"commits":        tr.CommitsTitle,
-		"confirmation":   tr.ConfirmationTitle,
-		"credentials":    tr.CredentialsTitle,
-		"information":    tr.InformationTitle,
-		"main":           tr.MainTitle,
-		"patchBuilding":  tr.PatchBuildingTitle,
-		"merging":        tr.MergingTitle,
-		"normal":         tr.NormalTitle,
-		"staging":        tr.StagingTitle,
-		"menu":           tr.MenuTitle,
-		"search":         tr.SearchTitle,
-		"secondary":      tr.SecondaryTitle,
-		"stash":          tr.StashTitle,
-		"suggestions":    tr.SuggestionsCheatsheetTitle,
-		"extras":         tr.ExtrasTitle,
-	}
-
-	title, ok := contextTitleMap[str]
-	if !ok {
-		panic(fmt.Sprintf("title not found for %s", str))
-	}
-
-	return title
-}
-
-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", gui.GetKeyDisplay(binding.Key), binding.Description, binding.Alternative)
-	}
-	return fmt.Sprintf("  <kbd>%s</kbd>: %s\n", gui.GetKeyDisplay(binding.Key), binding.Description)
-}
-
-func getBindingSections(mApp *app.App) []*bindingSection {
-	bindingSections := []*bindingSection{}
-
-	bindings := mApp.Gui.GetInitialKeybindings()
-
-	type contextAndViewType struct {
-		subtitle string
-		title    string
-	}
-
-	contextAndViewBindingMap := map[contextAndViewType][]*gui.Binding{}
-
-outer:
-	for _, binding := range bindings {
-		if binding.Tag == "navigation" {
-			key := contextAndViewType{subtitle: "", title: "navigation"}
-			existing := contextAndViewBindingMap[key]
-			if existing == nil {
-				contextAndViewBindingMap[key] = []*gui.Binding{binding}
-			} else {
-				for _, navBinding := range contextAndViewBindingMap[key] {
-					if navBinding.Description == binding.Description {
-						continue outer
-					}
-				}
-				contextAndViewBindingMap[key] = append(contextAndViewBindingMap[key], binding)
-			}
-
-			continue outer
-		}
-
-		contexts := []string{}
-		if len(binding.Contexts) == 0 {
-			contexts = append(contexts, "")
-		} else {
-			contexts = append(contexts, binding.Contexts...)
-		}
-
-		for _, context := range contexts {
-			key := contextAndViewType{subtitle: context, title: binding.ViewName}
-			existing := contextAndViewBindingMap[key]
-			if existing == nil {
-				contextAndViewBindingMap[key] = []*gui.Binding{binding}
-			} else {
-				contextAndViewBindingMap[key] = append(contextAndViewBindingMap[key], binding)
-			}
-		}
-	}
-
-	type groupedBindingsType struct {
-		contextAndView contextAndViewType
-		bindings       []*gui.Binding
-	}
-
-	groupedBindings := make([]groupedBindingsType, len(contextAndViewBindingMap))
-
-	for contextAndView, contextBindings := range contextAndViewBindingMap {
-		groupedBindings = append(groupedBindings, groupedBindingsType{contextAndView: contextAndView, bindings: contextBindings})
-	}
-
-	sort.Slice(groupedBindings, func(i, j int) bool {
-		first := groupedBindings[i].contextAndView
-		second := groupedBindings[j].contextAndView
-		if first.title == "" {
-			return true
-		}
-		if second.title == "" {
-			return false
-		}
-		if first.title == "navigation" {
-			return true
-		}
-		if second.title == "navigation" {
-			return false
-		}
-		return first.title < second.title || (first.title == second.title && first.subtitle < second.subtitle)
-	})
-
-	for _, group := range groupedBindings {
-		contextAndView := group.contextAndView
-		contextBindings := group.bindings
-		mApp.Log.Info("viewname: " + contextAndView.title + ", context: " + contextAndView.subtitle)
-		viewName := contextAndView.title
-		if viewName == "" {
-			viewName = "global"
-		}
-		translatedView := localisedTitle(mApp, viewName)
-		var title string
-		if contextAndView.subtitle == "" {
-			addendum := " " + mApp.Tr.Panel
-			if viewName == "global" || viewName == "navigation" {
-				addendum = ""
-			}
-			title = fmt.Sprintf("%s%s", translatedView, addendum)
-		} else {
-			translatedContextName := localisedTitle(mApp, contextAndView.subtitle)
-			title = fmt.Sprintf("%s %s (%s)", translatedView, mApp.Tr.Panel, 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(tr *i18n.TranslationSet, bindingSections []*bindingSection) string {
-	content := fmt.Sprintf("# Lazygit %s\n", tr.Keybindings)
-
-	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"
-}
diff --git a/scripts/push_new_patch/main.go b/scripts/push_new_patch/main.go
deleted file mode 100755
index a26f2b676..000000000
--- a/scripts/push_new_patch/main.go
+++ /dev/null
@@ -1,63 +0,0 @@
-// call from project root with
-// go run scripts/push_new_patch/main.go
-
-// goreleaser expects a $GITHUB_TOKEN env variable to be defined
-// in order to push the release got github
-
-package main
-
-import (
-	"fmt"
-	"io/ioutil"
-	"log"
-	"os"
-	"strconv"
-	"strings"
-
-	"github.com/jesseduffield/lazygit/pkg/secureexec"
-)
-
-func main() {
-	version, err := ioutil.ReadFile("VERSION")
-	if err != nil {
-		log.Panicln(err.Error())
-	}
-	stringVersion := string(version)
-	fmt.Println("VERSION was " + stringVersion)
-
-	runCommand("git", "pull")
-
-	splitVersion := strings.Split(stringVersion, ".")
-	patch := splitVersion[len(splitVersion)-1]
-	newPatch, _ := strconv.Atoi(patch)
-	splitVersion[len(splitVersion)-1] = strconv.FormatInt(int64(newPatch)+1, 10)
-	newVersion := strings.Join(splitVersion, ".")
-
-	err = ioutil.WriteFile("VERSION", []byte(newVersion), 0644)
-	if err != nil {
-		log.Panicln(err.Error())
-	}
-
-	runCommand("git", "add", "VERSION")
-	runCommand("git", "commit", "-m", "bump version to "+newVersion, "--", "VERSION")
-	runCommand("git", "push")
-	runCommand("git", "tag", newVersion)
-	runCommand("git", "push", "origin", newVersion)
-	runCommand("goreleaser", "--rm-dist")
-	runCommand("rm", "-rf", "dist")
-}
-
-func runCommand(args ...string) {
-	fmt.Println(strings.Join(args, " "))
-	cmd := secureexec.Command(args[0], args[1:]...)
-	cmd.Stdout = os.Stdout
-	cmd.Stderr = os.Stderr
-	err := cmd.Start()
-	if err != nil {
-		panic(err.Error())
-	}
-	err = cmd.Wait()
-	if err != nil {
-		panic(err.Error())
-	}
-}