Add new feature: Vim mode

app/app.go

@@ -42,7 +42,8 @@ func SetupApplicationWithAccount(app *tview.Application, account string) {
 			configuration.Token = configuration.GetAccountToken(account)
 		}
 
-		shortcutsLoadError := shortcuts.Load()
+		shortcutsLoadError := shortcuts.Load(app.VimMode)
+		shortcuts.InjectVim(app.VimMode)
 		if shortcutsLoadError != nil {
 			panic(shortcutsLoadError)
 		}
@@ -128,6 +129,7 @@ func SetupApplicationWithAccount(app *tview.Application, account string) {
 			window.RegisterCommand(serverCreateCmd)
 			window.RegisterCommand(commandimpls.NewServerCommand(serverJoinCmd, serverLeaveCmd, serverCreateCmd))
 			window.RegisterCommand(commandimpls.NewNickSetCmd(discord, window))
+			window.RegisterCommand(commandimpls.NewVimCmd(app.VimMode))
 			tfaEnableCmd := commandimpls.NewTFAEnableCommand(window, discord)
 			tfaDisableCmd := commandimpls.NewTFADisableCommand(discord)
 			tfaBackupGetCmd := commandimpls.NewTFABackupGetCmd(discord, window)

appveyor.yml

@@ -2,7 +2,6 @@ clone_folder: c:\gopath\src\github.com\Bios-Marcel\cordless
 
 environment:
   GOPATH: c:\gopath
-  GO111MODULE: on
 build: off
 stack: go 1.13
 
@@ -16,4 +15,4 @@ build_script:
 
 test_script:
   - go vet ./...
-  - go test ./...
+  - go test ./...

commands/commandimpls/vim.go

@@ -0,0 +1,75 @@
+package commandimpls
+
+import (
+	"fmt"
+	"io"
+
+	"github.com/Bios-Marcel/cordless/util/vim"
+)
+
+const (
+	vimOpenHelpPage = `[::b]NAME
+	vim-mode - minor vim mode for cordless
+
+[::b]SYNOPSIS
+	[::b]Normal Mode: Navigate around the containers with hjkl.
+	Perform some usual commands inside text box input, as pasting, moving cursor or such.
+	Press ESC anywhere to return to normal mode.
+
+	[::b]Insert Mode: Type inside box input, perform actions inside chatview.
+	Insert without any key restriction inside the text box using insert mode.
+	Inside chat view, perform useful commands such as editing message "i" or replying to user "a"
+
+	[::b]Visual Mode: Move around everywhere with vim keys.
+	This mode allows to use hjkl pretty much anywhere inside the app. Due to some restrictions, this is
+	the only mode that officially supports using hjkl anywhere.
+	Also allows using same commands as insert mode inside chat view, or selecting text inside text input.
+
+
+[::b]DESCRIPTION
+	This is a minor mode for vim. See all the shorcuts with Ctrl K, and edit them inside shortcuts/shortcuts.go
+	Toggle vim with vim on/off/enable/disable
+`
+)
+
+type VimHelp struct {
+	vimMode	*vim.Vim
+}
+
+func NewVimCmd(vimMode *vim.Vim) *VimHelp {
+	return &VimHelp{vimMode: vimMode}
+}
+
+// PrintHelp prints a static help page for this command
+func (v VimHelp) PrintHelp(writer io.Writer) {
+	fmt.Fprintln(writer, vimOpenHelpPage)
+}
+
+func (v VimHelp) Execute(writer io.Writer, parameters []string) {
+	if len(parameters) < 1 {
+		fmt.Fprintf(writer, "You did not specify any parameter for this command.")
+		return
+	}
+	switch parameters[0] {
+	case "on","enable":
+		v.vimMode.CurrentMode = vim.NormalMode
+		fmt.Fprintf(writer, "Vim mode has been enabled.\n")
+	case "off","disable":
+		v.vimMode.CurrentMode = vim.NormalMode
+		v.vimMode.CurrentMode = vim.Disabled
+		fmt.Fprintf(writer, "Vim mode has been disabled.\n")
+	default:
+		fmt.Fprintf(writer, "Parameter %s not recognized.", parameters[0])
+	}
+}
+
+// Name returns the primary name for this command. This name will also be
+// used for listing the command in the commandlist.
+func (v VimHelp) Name() string {
+	return "vim"
+}
+
+// Aliases are a list of aliases for this command. There might be none.
+func (v VimHelp) Aliases() []string {
+	return []string{"vim", "vim-mode"}
+}

config/config.go

@@ -155,6 +155,8 @@ type Config struct {
 	// download files to. If FileOpenSaveFilesPermanently has been set to
 	// true, then all opened files are saved in this folder for example.
 	FileDownloadSaveLocation string
+
+	VimEnabled bool
 }
 
 // Account has a name and a token. The name is just for the users recognition.
@@ -211,6 +213,7 @@ func createDefaultConfig() *Config {
 		FileOpenHandlers:                            make(map[string]string),
 		FileOpenSaveFilesPermanently:                false,
 		FileDownloadSaveLocation:                    "~/Downloads",
+		VimEnabled: false,
 	}
 }
 

go.mod

@@ -9,6 +9,7 @@ require (
 	github.com/Bios-Marcel/shortnotforlong v1.1.1
 	github.com/alecthomas/chroma v0.7.3
 	github.com/atotto/clipboard v0.1.2
+	github.com/bunyk/gokeybr v0.0.0-20201019133936-f9e4ed3fdc5d // indirect
 	github.com/gdamore/tcell/v2 v2.0.0
 	github.com/gen2brain/beeep v0.0.0-20200526185328-e9c15c258e28
 	github.com/google/go-github/v29 v29.0.3
@@ -20,6 +21,8 @@ require (
 	github.com/robertkrimen/otto v0.0.0-20200922221731-ef014fd054ac
 	github.com/sergi/go-diff v1.1.0
 	github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966
+	golang.org/x/tools v0.0.0-20201112171726-b38955972a18 // indirect
+	golang.org/x/tools/gopls v0.5.2 // indirect
 	gopkg.in/sourcemap.v1 v1.0.5 // indirect
 	rsc.io/qr v0.2.0
 )

main.go

@@ -63,7 +63,7 @@ func main() {
 		fmt.Printf("You are running cordless version %s\nKeep in mind that this version might not be correct for manually built versions, as those can contain additional commits.\n", version.Version)
 	} else {
 		//App that will be reused throughout the process runtime.
-		tviewApp := tview.NewApplication()
+		tviewApp := tview.NewApplication(config.Current.VimEnabled)
 
 		if accountToUse != nil && *accountToUse != "" {
 			app.SetupApplicationWithAccount(tviewApp, *accountToUse)