Add proper system for bundled cheatsheets

Author: sudormrfbin

README.md

@@ -67,16 +67,9 @@ Your cheatsheet file is a simple text file with the name `cheatsheet.txt` found
 `~/.config/nvim/` (`~/AppData/Local/nvim/` if you're on Windows) alongside your
 `init.vim`. Use the `:CheatsheetEdit` command to open it in a buffer to edit.
 
-A [builtin cheatsheet](./doc/cheatsheet-default.txt) lists most of the useful
-inbuilt vim mappings and commands, useful for people still finding their way
-around the editor (and for others wanting to scratch the occasional
-I've-been-using-vim-for-years-but-forgot-how-to-scroll-horizontally itch).
-Disable it with `let g:cheatsheet_use_default = v:false`.
-
 | Telescope mappings | Description                                 |
 | ---                | ---                                         |
 | `<C-E>`            | Edit user cheatsheet à la `:CheatsheetEdit` |
-| `<C-D>`            | Toggle `g:cheatsheet_use_default`           |
 | `<C-Y>`            | Yank the cheatcode                          |
 | `Enter`            | Fill in the command line; see below         |
 
@@ -90,6 +83,44 @@ Since `cheatsheet.nvim` provides it's own commands,  it is not required to
 "load" `cheatsheet.nvim` with Telescope which is usually required for plugins
 using Telescope.
 
+## Configuration
+
+```lua
+local defaults = {
+    -- Whether to show bundled cheatsheets
+
+    -- For generic cheatsheets like default, unicode, nerd-fonts, etc
+    bundled_cheatsheets = true,
+    -- bundled_cheatsheets = {
+    --     enabled = {},
+    --     disabled = {},
+    -- },
+
+    -- For plugin specific cheatsheets
+    bundled_plugin_cheatsheets = true,
+    -- bundled_plugin_cheatsheets = {
+    --     enabled = {},
+    --     disabled = {},
+    -- }
+}
+```
+
+`bundled_cheatsheets` and `bundled_plugin_cheatsheets` can also be tables to
+have more fine grained control:
+
+```lua
+local defaults = {
+    bundled_cheatsheets = {
+        -- only show the default cheatsheet
+        enabled = { "default" },
+    },
+    bundled_plugin_cheatsheets = {
+        -- show cheatsheets for all plugins except gitsigns
+        disabled = { "gitsigns.nvim" },
+    }
+}
+```
+
 ## `cheatsheet.txt` File Format
 
 - `#` starts a normal comment, blank lines are ignored.

lua/cheatsheet/config.lua

@@ -0,0 +1,36 @@
+local M = {}
+
+-- NOTE: Watch out for bugs in cheatsheet.get_cheatsheet_files if
+-- defaults is modified in the future
+local defaults = {
+    -- Whether to show bundled cheatsheets
+
+    -- For generic cheatsheets like default, unicode, nerd-fonts, etc
+    -- bundled_cheatsheets = {
+    --     enabled = {},
+    --     disabled = {},
+    -- },
+    bundled_cheatsheets = true,
+    -- For plugin specific cheatsheets
+    -- bundled_plugin_cheatsheets = {
+    --     enabled = {},
+    --     disabled = {},
+    -- }
+    bundled_plugin_cheatsheets = true,
+}
+
+M.options = {}
+
+function M.setup(opts)
+    opts = opts or {}
+    for key, val in pairs(defaults) do
+        if opts[key] == nil then
+            opts[key] = val
+        end
+    end
+    M.options = opts
+end
+
+M.setup()
+
+return M

lua/cheatsheet/init.lua

@@ -1,16 +1,62 @@
 local utils = require('cheatsheet.utils')
+local config = require('cheatsheet.config')
 -- plenary is only used for telescope specific code
 local has_path, path = pcall(require, "plenary.path")
 
 local M = {}
+
+M.setup = function(opts)
+    config.setup(opts)
+end
+
 -- Get `cheatsheet.txt` files from any directory in runtimepath
+-- Inlcudes bundled cheatsheets if configured to do so.
+-- @param *opts* config.optsa like table
 -- @return array of filepaths
-M.get_cheatsheet_files = function()
-    local cheats = vim.api.nvim_get_runtime_file("cheatsheet.txt", true)
+M.get_cheatsheet_files = function(opts)
+    opts = opts or config.options
+
+    -- Insert elements from `from_tbl` into `ins_tbl`. If `include` is a bool,
+    -- it controls appending everything in `from_tbl` to `ins_tbl`. If it is a
+    -- table, Use `pattern` to extract a match from an element in `from_tbl`
+    -- and insert only if match is present in `include.enabled` or not present
+    -- in `include.disabled`.
+    local function filter_insert(ins_tbl, from_tbl, pattern, include)
+        if include == false then return end
+
+        if include == true then
+            for _, file in ipairs(from_tbl) do
+                table.insert(ins_tbl, file)
+            end
+            return
+        end
+        assert(type(include) == "table", "Invalid table format")
 
-    if utils.is_using_default_cheatsheet() then
-        table.insert(cheats, utils.get_default_cheatsheet())
+        if include.enabled ~= nil then
+            for _, element in ipairs(from_tbl) do
+                local match = element:match(pattern)
+                if utils.has_value(include.enabled, match) then
+                    table.insert(ins_tbl, element)
+                end
+            end
+        elseif include.disabled ~= nil then
+            for _, element in ipairs(from_tbl) do
+                local match = element:match(pattern)
+                print(match)
+                if not utils.has_value(include.disabled, match) then
+                    table.insert(ins_tbl, element)
+                end
+            end
+        end
     end
+
+    local cheats = vim.api.nvim_get_runtime_file("cheatsheet.txt", true)
+    local bundled = utils.get_bundled_cheatsheets()
+    local bundled_plugins = utils.get_bundled_plugin_cheatsheets()
+
+    filter_insert(cheats, bundled, '.+/cheatsheets/cheatsheet%-(.+)%.txt', opts.bundled_cheatsheets)
+    filter_insert(cheats, bundled_plugins, '.+/cheatsheets/plugins/cheatsheet%-(.+)%.txt', opts.bundled_plugin_cheatsheets)
+
     -- https://github.com/neovim/neovim/issues/14294
     -- returned table may have duplicated entries
     return utils.dedupe_array(cheats)

lua/cheatsheet/telescope.lua

@@ -121,15 +121,6 @@ M.pick_cheat = function(opts)
                         utils.edit_user_cheatsheet()
                     end
                 )
-                map(
-                    'i', '<C-D>', function()
-                        -- _close with keepinsert=true to support opening another
-                        -- telescope window (here same window) from current one
-                        actions._close(prompt_bufnr, true)
-                        utils.toggle_use_default_cheatsheet()
-                        M.pick_cheat()
-                    end
-                )
                 map(
                     'i', '<C-Y>', function()
                         actions.close(prompt_bufnr)

lua/cheatsheet/utils.lua

@@ -19,6 +19,13 @@ M.dedupe_array = function(array)
     return result
 end
 
+M.has_value = function(tbl, value)
+    for _, val in  pairs(tbl) do
+        if val == value then return true end
+    end
+    return false
+end
+
 -- Get the user's cheatsheet.txt located in config directory (~/.config/nvim)
 M.get_user_cheatsheet = function()
     return vim.fn.stdpath("config") .. "/cheatsheet.txt"
@@ -29,25 +36,18 @@ M.edit_user_cheatsheet = function()
     vim.api.nvim_command(":edit " .. M.get_user_cheatsheet())
 end
 
--- Get the cheatsheet included with the plugin containing a generic vim cheatsheet
--- @return path to defautl cheatsheet
-M.get_default_cheatsheet = function()
-    return vim.api.nvim_get_runtime_file("doc/cheatsheet-default.txt", false)[1]
-end
-
-M.is_using_default_cheatsheet = function()
-    local var_is_defined, use_default = pcall(
-        vim.api.nvim_get_var, 'cheatsheet_use_default'
-    )
-    if var_is_defined and use_default then return true end
-    return false
-
+-- Get the list of cheatsheets bundled with this plugin,
+-- from cheatsheets/. Does not include plugin cheatsheets.
+-- @return Array of cheatsheet filepaths
+M.get_bundled_cheatsheets = function()
+    return vim.api.nvim_get_runtime_file("cheatsheets/cheatsheet-*.txt", true)
 end
 
-M.toggle_use_default_cheatsheet = function()
-    vim.api.nvim_set_var(
-        'cheatsheet_use_default', not M.is_using_default_cheatsheet()
-    )
+-- Get the list of plugin cheatsheets bundled with this plugin,
+-- from cheatsheets/plugins/
+-- @return Array of cheatsheet filepaths
+M.get_bundled_plugin_cheatsheets = function()
+    return vim.api.nvim_get_runtime_file("cheatsheets/plugins/cheatsheet-*.txt", true)
 end
 
 return M

plugin/cheatsheet.vim

@@ -14,9 +14,6 @@ if mapcheck("<leader>?", "n") == ""
   nnoremap <unique> <leader>? :<C-U>Cheatsheet<CR>
 endif
 
-" Include doc/cheatsheet-default.txt
-let g:cheatsheet_use_default = v:true
-
 highlight default link cheatComment Comment
 highlight default link cheatMetadataComment Comment
 highlight default link cheatMetadataTag Include