feat: add verbose option (#116)

Author: hakonharnes

lua/img-clip/config.lua

@@ -17,6 +17,9 @@ local defaults = {
     use_absolute_path = false, ---@type boolean
     relative_to_current_file = false, ---@type boolean
 
+    -- show warning messages
+    verbose = true, ---@type boolean | fun(): boolean
+
     -- template options
     template = "$FILE_PATH", ---@type string
     url_encode_path = false, ---@type boolean

lua/img-clip/util.lua

@@ -57,17 +57,15 @@ M.has = function(feature)
 end
 
 ---@param msg string
----@param verbose boolean?
-M.warn = function(msg, verbose)
-  if M.verbose or verbose then
+M.warn = function(msg)
+  if config.get_opt("verbose") then
     vim.notify(msg, vim.log.levels.WARN, { title = "img-clip" })
   end
 end
 
 ---@param msg string
----@param verbose boolean?
-M.error = function(msg, verbose)
-  if M.verbose or verbose then
+M.error = function(msg)
+  if config.get_opt("verbose") then
     vim.notify(msg, vim.log.levels.ERROR, { title = "img-clip" })
   end
 end

tests/config_spec.lua

@@ -13,6 +13,7 @@ describe("config", function()
     assert.equals("assets", config.get_opt("dir_path"))
     assert.equals("%Y-%m-%d-%H-%M-%S", config.get_opt("file_name"))
     assert.equals("png", config.get_opt("extension"))
+    assert.is_true(config.get_opt("verbose"))
     assert.is_false(config.get_opt("url_encode_path"))
     assert.is_false(config.get_opt("use_absolute_path"))
     assert.is_false(config.get_opt("relative_to_current_file"))

vimdoc.md

@@ -92,6 +92,9 @@ The plugin is highly configurable. Please refer to the default configuration bel
     use_absolute_path = false, ---@type boolean | fun(): boolean
     relative_to_current_file = false, ---@type boolean | fun(): boolean
 
+    -- logging options
+    verbose = true, ---@type boolean | fun(): boolean
+
     -- template options
     template = "$FILE_PATH", ---@type string | fun(context: table): string
     url_encode_path = false, ---@type boolean | fun(): boolean