Use go:generate for generating cheatsheets

This has several benefits:
- it's less code
- we're using the same mechanism to generate all our auto-generated files, so if
  someone wants to add a new one, it's clear which pattern to follow
- we can re-generate all generated files with a single command
  ("go generate ./...", or "make generate")
- we only need a single check on CI to check that all files are up to date (see
  previous commit)
This commit is contained in:
Stefan Haller 2023-09-29 18:42:53 +02:00
parent 5ccc95b76f
commit 7af371701d
14 changed files with 31 additions and 125 deletions

View file

@ -1,10 +1,12 @@
// This "script" generates a file called Keybindings_{{.LANG}}.md
// in current working directory.
//go:generate go run generator.go
// This "script" generates files called Keybindings_{{.LANG}}.md
// in the docs/keybindings directory.
//
// The content of this generated file is a keybindings cheatsheet.
// The content of these generated files is a keybindings cheatsheet.
//
// To generate cheatsheet in english run:
// go run scripts/generate_cheatsheet.go
// To generate the cheatsheets, run:
// go generate pkg/cheatsheet/generate.go
package cheatsheet
@ -42,7 +44,7 @@ type headerWithBindings struct {
}
func CommandToRun() string {
return "go run scripts/cheatsheet/main.go generate"
return "go generate ./..."
}
func GetKeybindingsDir() string {