chore: add note about global config for plugin

jellydn · Oct 29, 2023 · 61c23d6 · 61c23d6
1 parent b444548
commit 61c23d6
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/lua/hurl/init.lua b/lua/hurl/init.lua
@@ -1,16 +1,18 @@
---- Global configuration for hurl.nvim
-_HURL_CFG = {
+--- Default configuration for hurl.nvim
+local default_config = {
   debug = false,
   mode = 'split',
 }
+--- Global configuration for entire plugin, easy to access from anywhere
+_HURL_CFG = default_config
 local M = {}
 
 --- Setup hurl.nvim
 ---@param options (table | nil)
 --       - debug: (boolean | nil) default: false.
 --       - mode: ('popup' | 'split') default: popup.
 function M.setup(options)
-  _HURL_CFG = vim.tbl_extend('force', _HURL_CFG, options or {})
+  _HURL_CFG = vim.tbl_extend('force', _HURL_CFG, options or default_config)
 
   require('hurl.main').setup()
 end