From 970d9932c5c6fd8db4e0928f2236c747de39556d Mon Sep 17 00:00:00 2001
From: Omar Zeghouani <omarzeghouanii@gmail.com>
Date: Fri, 20 Aug 2021 13:29:07 +0100
Subject: [PATCH] Add help message for keybinds

---
 README.md                      | 1 +
 doc/symbols-outline.txt        | 1 +
 lua/symbols-outline.lua        | 3 +++
 lua/symbols-outline/config.lua | 8 +++++++-
 4 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f143339..8ca07c5 100644
--- a/README.md
+++ b/README.md
@@ -112,4 +112,5 @@ vim.g.symbols_outline = {
 | K          | Show current symbol preview                        |
 | r          | Rename symbol                                      |
 | a          | Code actions                                       |
+| ?          | Show help message                                  |
 
diff --git a/doc/symbols-outline.txt b/doc/symbols-outline.txt
index b08ba1f..70d80c4 100644
--- a/doc/symbols-outline.txt
+++ b/doc/symbols-outline.txt
@@ -236,6 +236,7 @@ symbol_blacklist
 | K          | Show current symbol preview                        |
 | r          | Rename symbol                                      |
 | a          | Code actions                                       |
+| ?          | Show help message                                  |
 
 ================================================================================
 vim:tw=79:ts=8:ft=help:norl
diff --git a/lua/symbols-outline.lua b/lua/symbols-outline.lua
index 74d54f7..e4b11ff 100644
--- a/lua/symbols-outline.lua
+++ b/lua/symbols-outline.lua
@@ -223,6 +223,9 @@ local function setup_keymaps(bufnr)
     -- code actions
     nmap(config.options.keymaps.code_actions,
          ":lua require('symbols-outline.code_action').show_code_actions()<Cr>")
+    -- show help
+    nmap(config.options.keymaps.show_help,
+         ":lua require('symbols-outline.config').show_help()<Cr>")
     -- close outline
     nmap(config.options.keymaps.close, ":bw!<Cr>")
 end
diff --git a/lua/symbols-outline/config.lua b/lua/symbols-outline/config.lua
index 27a7029..f1ea43e 100644
--- a/lua/symbols-outline/config.lua
+++ b/lua/symbols-outline/config.lua
@@ -18,7 +18,8 @@ local defaults = {
         hover_symbol = "<C-space>",
         preview_symbol = "K",
         rename_symbol = "r",
-        code_actions = "a"
+        code_actions = "a",
+        show_help = "?",
     },
     lsp_blacklist = {},
     symbol_blacklist = {},
@@ -93,6 +94,11 @@ function M.is_client_blacklisted(client_id)
     return has_value(M.options.lsp_blacklist, client.name)
 end
 
+function M.show_help()
+    print "Current keymaps:"
+    print(vim.inspect(M.options.keymaps))
+end
+
 function M.setup(options)
     M.options = vim.tbl_deep_extend("force", {}, defaults, options or {})
 end