Merge pull request #28 from theHamsta/configure-keybinding

feat: make keybindings configurable and show help on "?"

README.md

@@ -31,7 +31,19 @@ require "nvim-treesitter.configs".setup {
     enable = true,
     disable = {},
     updatetime = 25, -- Debounced time for highlighting nodes in the playground from source code
-    persist_queries = false -- Whether the query persists across vim sessions
+    persist_queries = false, -- Whether the query persists across vim sessions
+    keybindings = {
+      toggle_query_editor = 'o',
+      toggle_hl_groups = 'i',
+      toggle_injected_languages = 't',
+      toggle_anonymous_nodes = 'a',
+      toggle_language_display = 'I',
+      focus_language = 'f',
+      unfocus_language = 'F',
+      update = 'R',
+      goto_node = '<cr>',
+      show_help = '?',
+    },
   }
 }
 ```

lua/nvim-treesitter-playground.lua

@@ -6,7 +6,19 @@ function M.init()
     playground = {
       module_path = "nvim-treesitter-playground.internal",
       updatetime = 25,
-      persist_queries = false
+      persist_queries = false,
+      keybindings = {
+        toggle_query_editor = 'o',
+        toggle_hl_groups = 'i',
+        toggle_injected_languages = 't',
+        toggle_anonymous_nodes = 'a',
+        toggle_language_display = 'I',
+        focus_language = 'f',
+        unfocus_language = 'F',
+        update = 'R',
+        goto_node = '<cr>',
+        show_help = '?',
+      },
     },
     query_linter = {
       module_path = "nvim-treesitter-playground.query_linter",

lua/nvim-treesitter-playground/internal.lua

@@ -176,15 +176,11 @@ local function setup_buf(for_buf)
   vim.cmd(string.format([[autocmd BufWinEnter <buffer=%d> lua require'nvim-treesitter-playground.internal'.update(%d)]], buf, for_buf))
   vim.cmd 'augroup END'
 
-  api.nvim_buf_set_keymap(buf, 'n', 'o', string.format(':lua require "nvim-treesitter-playground.internal".toggle_query_editor(%d)<CR>', for_buf), { silent = true })
-  api.nvim_buf_set_keymap(buf, 'n', 'i', string.format(':lua require "nvim-treesitter-playground.internal".toggle_hl_groups(%d)<CR>', for_buf), { silent = true })
-  api.nvim_buf_set_keymap(buf, 'n', 't', string.format(':lua require "nvim-treesitter-playground.internal".toggle_injected_languages(%d)<CR>', for_buf), { silent = true })
-  api.nvim_buf_set_keymap(buf, 'n', 'a', string.format(':lua require "nvim-treesitter-playground.internal".toggle_anonymous_nodes(%d)<CR>', for_buf), { silent = true })
-  api.nvim_buf_set_keymap(buf, 'n', 'I', string.format(':lua require "nvim-treesitter-playground.internal".toggle_language_display(%d)<CR>', for_buf), { silent = true })
-  api.nvim_buf_set_keymap(buf, 'n', 'f', string.format(':lua require "nvim-treesitter-playground.internal".focus_language(%d)<CR>', for_buf), { silent = true })
-  api.nvim_buf_set_keymap(buf, 'n', 'F', string.format(':lua require "nvim-treesitter-playground.internal".unfocus_language(%d)<CR>', for_buf), { silent = true })
-  api.nvim_buf_set_keymap(buf, 'n', 'R', string.format(':lua require "nvim-treesitter-playground.internal".update(%d)<CR>', for_buf), { silent = true })
-  api.nvim_buf_set_keymap(buf, 'n', '<cr>', string.format(':lua require "nvim-treesitter-playground.internal".goto_node(%d)<CR>', for_buf), { silent = true })
+  local config = configs.get_module("playground")
+
+  for k, v in pairs(config.keybindings) do
+    api.nvim_buf_set_keymap(buf, 'n', v, string.format(':lua require "nvim-treesitter-playground.internal".%s(%d)<CR>', k, for_buf), { silent = true })
+  end
   api.nvim_buf_attach(buf, false, {
     on_detach = function() clear_entry(for_buf) end
   })
@@ -621,6 +617,15 @@ function M.render(bufnr)
   end
 end
 
+function M.show_help()
+  local function filter(item, path)
+      if path[#path] == vim.inspect.METATABLE then return end
+      return item
+    end
+  print("Current keybindings:")
+  print(vim.inspect(configs.get_module('playground').keybindings, {process=filter}))
+end
+
 function M.get_entries()
   return M._entries
 end