feat: configurable key bindings (#255)

* test(config): add more fields to the config file to test the new behavior

* feat(command): add more option fields to the commands struct to config the navigation key bindings

* feat(config): add more fields to the config object to read the navigation keybindings from the config file

* feat(tui): add a way to read the navigation keybindings rather than the constant values from tcell

* feat(root): add default keybindings to keep backward compatibility

* docs(readme): add documentation for the key bindings configuration

* chore(form): ignore key bindings field so dblab can enter in form mode

* fix: fix typo

* refactor: move non-navigation key bindings a level above on the KeyBinding structs

* docs(mkdocs): add key binding config documentation to the mkdocs

Author: danvergara

.dblab.yaml

@@ -35,3 +35,14 @@ database:
     password: "5@klkbN#ABC"
     user: "SA"
 limit: 50
+keybindings:
+  run-query: 'Ctrl-Space'
+  structure: 'Ctrl-S'
+  indexes: 'Ctrl-I'
+  constraints: 'Ctrl-T'
+  clear-editor: 'Ctrl-D'
+  navigation:
+    up: 'Ctrl-K'
+    down: 'Ctrl-J'
+    left: 'Ctrl-H'
+    right: 'Ctrl-L'

README.md

@@ -27,6 +27,7 @@ __Interactive client for PostgreSQL, MySQL, SQLite3, Oracle and SQL Server.__
 - [Usage](#usage)
     - [SSH Tunnel](#ssh-tunnel)
     - [Configuration](#configuration)
+        - [Key bindings configuration](#key-bindings-configuration) 
 - [Navigation](#navigation)
     - [Key Bindings](#key-bindings)
 - [Contribute](#contribute)
@@ -253,7 +254,11 @@ $ dblab --config
 $ dblab --config --cfg-name "prod"
 ```
 
-`.dblab.yaml` example:
+#### Key bindings configuration
+
+Key bindings can be configured through the `.dblab.yaml` file. There is a field called `keybindings` where key bindings can be modified. See the example to see the full list of the key bindings subject to change. The file shows the default values. The list of the available key bindings belongs to the [tcell](https://github.com/gdamore/tcell) library. Specifically, see the [KeyNames map](https://github.com/gdamore/tcell/blob/781586687ddb57c9d44727dc9320340c4d049b11/key.go#L83), for an accurate reference.
+
+#### .dblab.yaml example
 
 ```yaml
 database:
@@ -310,6 +315,17 @@ database:
     ssh-pass: "password"
 # should be greater than 0, otherwise the app will error out
 limit: 50
+keybindings:
+  run-query: 'Ctrl-Space'
+  structure: 'Ctrl-S'
+  indexes: 'Ctrl-I'
+  constraints: 'Ctrl-T'
+  clear-editor: 'Ctrl-D'
+  navigation:
+    up: 'Ctrl-K'
+    down: 'Ctrl-J'
+    left: 'Ctrl-H'
+    right: 'Ctrl-L'
 ```
 
 Or for sqlite:
@@ -325,6 +341,8 @@ Only the `host` and `ssl` fields are optionals. `127.0.0.1` and `disable`, respe
 
 ## Navigation
 
+The key bindings are now configurable, see [Key bindings configuration](#key-bindings-configuration) to learn how to replace existing key bindings. It's worth noting that key bindings are only configurable through the configuration file, there is no flags to do so. If you don't replace them through the configuration file, the information below remains the same, otherwise, just replace the new key binding with the existing information for the default one.
+
 If the query panel is active, type the desired query and press <kbd>Ctrl+Space</kbd> to see the results on the rows panel below.
 Otherwise, you might me located at the tables panel, then you can navigate by using the arrows <kbd>Up</kbd> and <kbd>Down</kbd> (or the keys <kbd>k</kbd> and <kbd>j</kbd> respectively). If you want to see the rows of a table, press <kbd>Enter</kbd>. To see the the schema of a table, locate yourself on the `rows` panel and press <kbd>Ctrl+S</kbd> to switch to the `structure` panel, then switch <kbd>Ctrl+S</kbd> to switch back.
 The same can be achieved for the `constraints` view by pressing <kbd>Ctrl+F</kbd> to go back and forth between the `rows` and the `constraints` panels.

cmd/root.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"github.com/gdamore/tcell/v2"
 	"github.com/spf13/cobra"
 
 	"github.com/danvergara/dblab/pkg/app"
@@ -29,17 +30,20 @@ var (
 	sslkey      string
 	sslpassword string
 	sslrootcert string
+
 	// SSH Tunnel.
 	sshHost          string
 	sshPort          string
 	sshUser          string
 	sshPass          string
 	sshKey           string
 	sshKeyPassphrase string
+
 	// oracle specific.
 	traceFile string
 	sslVerify string
 	wallet    string
+
 	// sql server.
 	encrypt                string
 	trustServerCertificate string
@@ -90,6 +94,19 @@ func NewRootCmd() *cobra.Command {
 					SSHPass:                sshPass,
 					SSHKeyFile:             sshKey,
 					SSHKeyPassphrase:       sshKeyPassphrase,
+					TUIKeyBindings: command.TUIKeyBindings{
+						RunQuery:    tcell.KeyCtrlSpace,
+						Structure:   tcell.KeyCtrlS,
+						Indexes:     tcell.KeyCtrlI,
+						Constraints: tcell.KeyCtrlT,
+						ClearEditor: tcell.KeyCtrlD,
+						Navigation: command.TUINavigationBindgins{
+							Up:    tcell.KeyCtrlK,
+							Down:  tcell.KeyCtrlJ,
+							Left:  tcell.KeyCtrlH,
+							Right: tcell.KeyCtrlL,
+						},
+					},
 				}
 
 				if form.IsEmpty(opts) {

docs/usage.md

@@ -265,7 +265,12 @@ dbladb --config
 dblab --config --cfg-name "prod"
 ```
 
-`.dblab.yaml` example:
+#### Key bindings configuration
+
+Key bindings can be configured through the `.dblab.yaml` file. There is a field called `keybindings` where key bindings can be modified. See the example to see the full list of the key bindings subject to change. The file shows the default values. The list of the available key bindings belongs to the [tcell](https://github.com/gdamore/tcell) library. Specifically, see the [KeyNames map](https://github.com/gdamore/tcell/blob/781586687ddb57c9d44727dc9320340c4d049b11/key.go#L83), for an accurate reference.
+
+
+#### .dblab.yaml example
 
 ```{ .yaml .copy } 
 database:
@@ -322,6 +327,17 @@ database:
     ssh-pass: "password"
 # should be greater than 0, otherwise the app will error out
 limit: 50
+keybindings:
+  run-query: 'Ctrl-Space'
+  structure: 'Ctrl-S'
+  indexes: 'Ctrl-I'
+  constraints: 'Ctrl-T'
+  clear-editor: 'Ctrl-D'
+  navigation:
+    up: 'Ctrl-K'
+    down: 'Ctrl-J'
+    left: 'Ctrl-H'
+    right: 'Ctrl-L'
 ```
 
 Or for sqlite:

pkg/app/app.go

@@ -40,7 +40,7 @@ func New(opts command.Options) (*App, error) {
 		return nil, err
 	}
 
-	t, err := tui.New(c)
+	t, err := tui.New(tui.WithClient(c), tui.WithKeyBinding(&opts.TUIKeyBindings))
 	if err != nil {
 		return nil, err
 	}

pkg/command/command.go

@@ -1,6 +1,10 @@
 package command
 
-import "os"
+import (
+	"os"
+
+	"github.com/gdamore/tcell/v2"
+)
 
 // Options is a struct that stores the provided commands by the user.
 type Options struct {
@@ -36,6 +40,24 @@ type Options struct {
 	Encrypt                string
 	TrustServerCertificate string
 	ConnectionTimeout      string
+	// TUI keybidings.
+	TUIKeyBindings TUIKeyBindings
+}
+
+type TUIKeyBindings struct {
+	RunQuery    tcell.Key
+	Structure   tcell.Key
+	Indexes     tcell.Key
+	Constraints tcell.Key
+	ClearEditor tcell.Key
+	Navigation  TUINavigationBindgins
+}
+
+type TUINavigationBindgins struct {
+	Up    tcell.Key
+	Down  tcell.Key
+	Left  tcell.Key
+	Right tcell.Key
 }
 
 // SetDefault returns a Options struct and fills the empty

pkg/config/.dblab.yaml

@@ -49,3 +49,14 @@ database:
     ssh-user: "ssh-user"
     ssh-pass: "password"
 limit: 50
+keybindings:
+  run-query: 'Ctrl-Space'
+  structure: 'Ctrl-S'
+  indexes: 'Ctrl-I'
+  constraints: 'Ctrl-T'
+  clear-editor: 'Ctrl-D'
+  navigation:
+    up: 'Ctrl-K'
+    down: 'Ctrl-J'
+    left: 'Ctrl-H'
+    right: 'Ctrl-L'

pkg/config/config.go

@@ -7,6 +7,7 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/gdamore/tcell/v2"
 	"github.com/golang-migrate/migrate/v4"
 	"github.com/golang-migrate/migrate/v4/database/sqlite3"
 	"github.com/golang-migrate/migrate/v4/source/file"
@@ -19,14 +20,15 @@ import (
 
 // Config struct is used to store the db connection data.
 type Config struct {
-	Database []Database
-	User     string
-	Pswd     string
-	Host     string
-	Port     string
-	DBName   string
-	Driver   string
-	Limit    uint `fig:"limit" default:"100"`
+	Database    []Database
+	User        string
+	Pswd        string
+	Host        string
+	Port        string
+	DBName      string
+	Driver      string
+	Limit       uint `fig:"limit" default:"100"`
+	KeyBindings KeyBindings
 }
 
 type Database struct {
@@ -67,6 +69,33 @@ type Database struct {
 	ConnectionTimeout      string `fig:"connection-timeout"`
 }
 
+type KeyBindings struct {
+	RunQuery    string `fig:"run-query"    default:"Ctrl-Space"`
+	Structure   string `fig:"structure"    default:"Ctrl-S"`
+	Indexes     string `fig:"indexes"      default:"Ctrl-I"`
+	Constraints string `fig:"constraints"  default:"Ctrl-T"`
+	ClearEditor string `fig:"clear-editor" default:"Ctrl-D"`
+	Navigation  NavigationBindgins
+}
+
+type NavigationBindgins struct {
+	Up    string `fig:"up"    default:"Ctrl-K"`
+	Down  string `fig:"down"  default:"Ctrl-J"`
+	Left  string `fig:"left"  default:"Ctrl-H"`
+	Right string `fig:"right" default:"Ctrl-L"`
+}
+
+// swapKeyNames swap keys and values of the tcell.KeyNames map.
+func swapKeyNames[K comparable, V comparable](m map[K]V) map[V]K {
+	reversed := make(map[V]K, len(m))
+
+	for k, v := range m {
+		reversed[v] = k
+	}
+
+	return reversed
+}
+
 // New returns a config instance the with db connection data inplace based on the flags of a cobra command.
 func New(cmd *cobra.Command) *Config {
 	conf := &Config{}
@@ -116,6 +145,11 @@ func Init(configName string) (command.Options, error) {
 		db = cfg.Database[0]
 	}
 
+	swapedKeyNames := swapKeyNames(tcell.KeyNames)
+	// This entry is missing in the tcell.KeyNames.
+	swapedKeyNames["Ctrl-H"] = tcell.KeyCtrlH
+	swapedKeyNames["Ctrl-I"] = tcell.KeyCtrlI
+
 	opts = command.Options{
 		Driver:                 db.Driver,
 		Host:                   db.Host,
@@ -142,6 +176,19 @@ func Init(configName string) (command.Options, error) {
 		SSHPass:                db.SSHPass,
 		SSHKeyFile:             db.SSHKeyFile,
 		SSHKeyPassphrase:       db.SSHKeyPassphrase,
+		TUIKeyBindings: command.TUIKeyBindings{
+			RunQuery:    tcell.Key(swapedKeyNames[cfg.KeyBindings.RunQuery]),
+			Structure:   tcell.Key(swapedKeyNames[cfg.KeyBindings.Structure]),
+			Constraints: tcell.Key(swapedKeyNames[cfg.KeyBindings.Constraints]),
+			Indexes:     tcell.Key(swapedKeyNames[cfg.KeyBindings.Indexes]),
+			ClearEditor: tcell.Key(swapedKeyNames[cfg.KeyBindings.ClearEditor]),
+			Navigation: command.TUINavigationBindgins{
+				Up:    tcell.Key(swapedKeyNames[cfg.KeyBindings.Navigation.Up]),
+				Down:  tcell.Key(swapedKeyNames[cfg.KeyBindings.Navigation.Down]),
+				Left:  tcell.Key(swapedKeyNames[cfg.KeyBindings.Navigation.Left]),
+				Right: tcell.Key(swapedKeyNames[cfg.KeyBindings.Navigation.Right]),
+			},
+		},
 	}
 
 	return opts, nil