chore!: Deprecate global-level ignore_treesitter option - closes #100

Author: andrewferrier

lua/debugprint/options.lua

@@ -27,7 +27,6 @@ local GLOBAL_OPTION_DEFAULTS = {
     display_counter = true,
     display_snippet = true,
     move_to_debugline = false,
-    ignore_treesitter = false,
     filetypes = require("debugprint.filetypes"),
     print_tag = "DEBUGPRINT",
 }
@@ -43,7 +42,6 @@ local validate_global_opts = function(o)
         display_counter = { o.display_counter, { "function", "boolean" } },
         display_snippet = { o.display_snippet, "boolean" },
         move_to_debugline = { o.move_to_debugline, "boolean" },
-        ignore_treesitter = { o.ignore_treesitter, "boolean" },
         filetypes = { o.filetypes, "table" },
         print_tag = { o.print_tag, "string" },
     })
@@ -149,6 +147,16 @@ M.get_and_validate_global_opts = function(opts)
         end
     end
 
+    if opts["ignore_treesitter"] ~= nil then
+        vim.deprecate(
+            "`ignore_treesitter` option",
+            "`*_alwaysprompt` keymappings",
+            "4.0, see ':help debugprint.nvim-keymappings-and-commands' for more information",
+            "debugprint.nvim",
+            false
+        )
+    end
+
     return global_opts
 end
 

lua/debugprint/types.lua

@@ -13,12 +13,12 @@
 ---@field display_counter? boolean
 ---@field display_snippet? boolean
 ---@field move_to_debugline? boolean
----@field ignore_treesitter? boolean
 ---@field filetypes? FileTypeConfig[]
 ---@field print_tag? string
 ---Deprecated
 ---@field create_keymaps? boolean
 ---@field create_commands? boolean
+---@field ignore_treesitter? boolean
 
 ---@class FunctionOptions
 ---@field above boolean