refactor!: Use namespace-prefixed type names - closes #161

Author: andrewferrier

lua/debugprint/filetype_config.lua

@@ -2,8 +2,8 @@ local M = {}
 
 local utils = require("debugprint.utils")
 
----@param fn function(DebugprintFileTypeConfigParams):DebugprintFileTypeConfig
----@return DebugprintFileTypeConfig
+---@param fn function(debugprint.FileTypeConfigParams):debugprint.FileTypeConfig
+---@return debugprint.FileTypeConfig
 local get_function_wrapped_config = function(fn)
     local bufnr = vim.fn.bufnr()
 
@@ -16,15 +16,15 @@ local get_function_wrapped_config = function(fn)
     return result
 end
 
----@param filetypes DebugprintFileTypeConfigOrDynamic[]
----@return DebugprintFileTypeConfig?
+---@param filetypes debugprint.FileTypeConfigOrDynamic[]
+---@return debugprint.FileTypeConfig?
 M.get = function(filetypes)
     local effective_filetypes = utils.get_effective_filetypes()
     local config = {}
     local found_config = false
 
     for _, effective_filetype in ipairs(effective_filetypes) do
-        ---@type DebugprintFileTypeConfigOrDynamic
+        ---@type debugprint.FileTypeConfigOrDynamic
         local entry = filetypes[effective_filetype]
 
         if entry ~= nil then
@@ -37,7 +37,7 @@ M.get = function(filetypes)
             else
                 filetype_contents = entry
             end
-            ---@cast filetype_contents DebugprintFileTypeConfig
+            ---@cast filetype_contents debugprint.FileTypeConfig
 
             -- Combine all valid configs into the same object. This seems to
             -- make sense as an approach; the only case where I've found where

lua/debugprint/filetypes.lua

@@ -7,7 +7,7 @@
 -- added/removed standalone, or to ensure that the statements are visible by
 -- default. Explanations are given below in comments below in some cases.
 
----@type DebugprintFileTypeConfig
+---@type debugprint.FileTypeConfig
 local shell = {
     left = '>&2 echo "',
     right = '"',
@@ -32,7 +32,7 @@ docker.left = "RUN " .. docker.left
 -- NodeJS. See
 -- https://github.com/andrewferrier/debugprint.nvim/issues/72#issuecomment-1902469694
 -- for some other discussion on this.
----@type DebugprintFileTypeConfig
+---@type debugprint.FileTypeConfig
 local js = {
     left = 'console.warn("',
     right = '")',
@@ -52,15 +52,15 @@ local js = {
     end,
 }
 
----@type DebugprintFileTypeConfig
+---@type debugprint.FileTypeConfig
 local cs = {
     left = 'System.Console.Error.WriteLine($"',
     right = '");',
     mid_var = "{",
     right_var = '}");',
 }
 
----@type DebugprintFileTypeConfig[]
+---@type debugprint.FileTypeConfig[]
 return {
     ["apex"] = {
         left = "System.debug('",

lua/debugprint/highlight.lua

@@ -21,7 +21,7 @@ local setup_highlight_buffer = function(print_tag, bufnr)
     end
 end
 
----@param filetypes DebugprintFileTypeConfig[]
+---@param filetypes debugprint.FileTypeConfig[]
 ---@param print_tag string
 M.setup_highlight = function(filetypes, print_tag)
     vim.api.nvim_set_hl(0, "DebugPrintLine", { link = "Debug", default = true })

lua/debugprint/init.lua

@@ -27,7 +27,7 @@ local get_debugline_tag_and_counter = function(display_counter)
     return tag_and_counter
 end
 
----@param fileconfig DebugprintFileTypeConfig
+---@param fileconfig debugprint.FileTypeConfig
 ---@return function|boolean?, boolean?, boolean?
 local get_display_options = function(fileconfig)
     local display_counter
@@ -54,8 +54,8 @@ local get_display_options = function(fileconfig)
     return display_counter, display_location, display_snippet
 end
 
----@param opts DebugprintFunctionOptionsInternal
----@param fileconfig DebugprintFileTypeConfig
+---@param opts debugprint.FunctionOptionsInternal
+---@param fileconfig debugprint.FileTypeConfig
 ---@return string
 local get_debugline_textcontent = function(opts, fileconfig)
     local current_line_nr = vim.api.nvim_win_get_cursor(0)[1]
@@ -112,8 +112,8 @@ local get_debugline_textcontent = function(opts, fileconfig)
     return line
 end
 
----@param opts DebugprintFunctionOptionsInternal
----@param fileconfig DebugprintFileTypeConfig
+---@param opts debugprint.FunctionOptionsInternal
+---@param fileconfig debugprint.FileTypeConfig
 ---@return string
 local construct_debugprint_line = function(opts, fileconfig)
     local line_to_insert
@@ -142,7 +142,7 @@ local construct_debugprint_line = function(opts, fileconfig)
     return line_to_insert
 end
 
----@param opts DebugprintFunctionOptionsInternal
+---@param opts debugprint.FunctionOptionsInternal
 ---@return string
 local get_debugprint_line = function(opts)
     local line_to_insert
@@ -164,7 +164,7 @@ local get_debugprint_line = function(opts)
     return line_to_insert
 end
 
----@param opts DebugprintFunctionOptionsInternal
+---@param opts debugprint.FunctionOptionsInternal
 ---@param keys string
 local add_to_register = function(opts, keys)
     utils_register.set_register(keys)
@@ -190,7 +190,7 @@ local add_to_register = function(opts, keys)
     end
 end
 
----@param opts DebugprintFunctionOptionsInternal
+---@param opts debugprint.FunctionOptionsInternal
 ---@return nil
 local handle_debugprint_line = function(opts)
     -- Inserting the leading space from the current line effectively acts as a
@@ -244,11 +244,11 @@ local debugprint_insertkeys = function(keys, insert)
     end
 end
 
----@param opts? DebugprintFunctionOptions
+---@param opts? debugprint.FunctionOptions
 ---@return nil
 M.debugprint = function(opts)
     opts = require("debugprint.options").get_and_validate_function_opts(opts)
-    ---@cast opts DebugprintFunctionOptionsInternal
+    ---@cast opts debugprint.FunctionOptionsInternal
 
     opts.register = require("debugprint.utils.register").register_named()
 
@@ -294,7 +294,7 @@ M.debugprint = function(opts)
     end
 end
 
----@param opts DebugprintCommandOpts
+---@param opts debugprint.CommandOpts
 ---@return nil
 M.deleteprints = function(opts)
     if global_opts.print_tag == "" then
@@ -343,7 +343,7 @@ M.deleteprints = function(opts)
     end
 end
 
----@param opts DebugprintCommandOpts
+---@param opts debugprint.CommandOpts
 ---@return nil
 M.toggle_comment_debugprints = function(opts)
     if global_opts.print_tag == "" then
@@ -384,7 +384,7 @@ M.toggle_comment_debugprints = function(opts)
     end
 end
 
----@param opts? DebugprintGlobalOptions
+---@param opts? debugprint.GlobalOptions
 ---@return nil
 M.setup = function(opts)
     global_opts =
@@ -407,12 +407,12 @@ M.setup = function(opts)
     end
 end
 
----@return DebugprintGlobalOptions
+---@return debugprint.GlobalOptions
 M._get_global_opts = function()
     return global_opts
 end
 
----@param filetypes DebugprintFileTypeConfigOrDynamic[]
+---@param filetypes debugprint.FileTypeConfigOrDynamic[]
 ---@return nil
 M.add_custom_filetypes = function(filetypes)
     vim.validate({

lua/debugprint/options.lua

@@ -1,6 +1,6 @@
 local M = {}
 
----@type DebugprintGlobalOptions
+---@type debugprint.GlobalOptions
 local GLOBAL_OPTION_DEFAULTS = {
     keymaps = {
         normal = {
@@ -39,7 +39,7 @@ local GLOBAL_OPTION_DEFAULTS = {
     print_tag = "DEBUGPRINT",
 }
 
----@param o DebugprintGlobalOptions
+---@param o debugprint.GlobalOptions
 ---@return nil
 local validate_global_opts = function(o)
     local STRING_FALSE_NIL = { "string", "boolean", "nil" }
@@ -131,7 +131,7 @@ local FUNCTION_OPTION_DEFAULTS = {
     insert = false,
 }
 
----@param o DebugprintFunctionOptions
+---@param o debugprint.FunctionOptions
 ---@return nil
 local validate_function_opts = function(o)
     vim.validate({
@@ -143,8 +143,8 @@ local validate_function_opts = function(o)
     })
 end
 
----@param opts? DebugprintGlobalOptions
----@return DebugprintGlobalOptions
+---@param opts? debugprint.GlobalOptions
+---@return debugprint.GlobalOptions
 M.get_and_validate_global_opts = function(opts)
     opts = opts or {}
 
@@ -195,8 +195,8 @@ M.get_and_validate_global_opts = function(opts)
     return global_opts
 end
 
----@param opts? DebugprintFunctionOptions
----@return DebugprintFunctionOptions
+---@param opts? debugprint.FunctionOptions
+---@return debugprint.FunctionOptions
 M.get_and_validate_function_opts = function(opts)
     local func_opts = vim.tbl_deep_extend(
         "force",

lua/debugprint/setup.lua

@@ -22,7 +22,7 @@ local create_command = function(name, command, opts)
     end
 end
 
----@param global_opts DebugprintGlobalOptions
+---@param global_opts debugprint.GlobalOptions
 ---@return nil
 M.map_keys_and_commands = function(global_opts)
     map_key("n", global_opts.keymaps.normal.plain_below, {

lua/debugprint/types.lua

@@ -2,7 +2,7 @@
 
 ---@meta types
 
----@class DebugprintFileTypeConfig
+---@class debugprint.FileTypeConfig
 ---@field left string
 ---@field right string
 ---@field mid_var string
@@ -12,36 +12,36 @@
 ---@field display_location? boolean
 ---@field display_snippet? boolean
 
----@class DebugprintFileTypeConfigParams
+---@class debugprint.FileTypeConfigParams
 ---@field effective_filetypes string[]
 ---@field file_path string
 ---@field bufnr integer
 
----@alias DebugprintFileTypeConfigOrDynamic DebugprintFileTypeConfig |
----                                         function(DebugprintFileTypeConfigParams):DebugprintFileTypeConfig)
+---@alias debugprint.FileTypeConfigOrDynamic debugprint.FileTypeConfig |
+---                                          function(debugprint.FileTypeConfigParams):debugprint.FileTypeConfig)
 
----@class DebugprintGlobalOptions
----@field keymaps? DebugprintKeymapOptions
----@field commands? DebugprintCommandOptions
+---@class debugprint.GlobalOptions
+---@field keymaps? debugprint.KeymapOptions
+---@field commands? debugprint.CommandOptions
 ---@field display_counter? boolean|function():string
 ---@field display_location? boolean
 ---@field display_snippet? boolean
 ---@field move_to_debugline? boolean
 ---@field notify_for_registers? boolean
 ---@field highlight_lines? boolean
----@field filetypes? DebugprintFileTypeConfigOrDynamic[]
+---@field filetypes? debugprint.FileTypeConfigOrDynamic[]
 ---@field print_tag? string
 ---Deprecated
 ---@field create_keymaps? boolean
 ---@field create_commands? boolean
 ---@field ignore_treesitter? boolean
 
----@class DebugprintKeymapOptions
----@field normal? DebugprintKeymapNormalOptions
----@field insert? DebugprintKeymapInsertOptions
----@field visual? DebugprintKeymapVisualOptions
+---@class debugprint.KeymapOptions
+---@field normal? debugprint.KeymapNormalOptions
+---@field insert? debugprint.KeymapInsertOptions
+---@field visual? debugprint.KeymapVisualOptions
 
----@class DebugprintKeymapNormalOptions
+---@class debugprint.KeymapNormalOptions
 ---@field plain_below? string|false
 ---@field plain_above? string|false
 ---@field variable_below? string|false
@@ -53,31 +53,31 @@
 ---@field delete_debug_prints? string|false
 ---@field toggle_comment_debug_prints? string|false
 
----@class DebugprintKeymapInsertOptions
+---@class debugprint.KeymapInsertOptions
 ---@field plain? string|false
 ---@field variable? string|false
 
----@class DebugprintKeymapVisualOptions
+---@class debugprint.KeymapVisualOptions
 ---@field variable_below? string|false
 ---@field variable_above? string|false
 
----@class DebugprintCommandOptions
+---@class debugprint.CommandOptions
 ---@field delete_debug_prints? string|false
 ---@field toggle_comment_debug_prints? string|false
 ---@field reset_debug_prints_counter? string|false
 
----@class DebugprintFunctionOptions
+---@class debugprint.FunctionOptions
 ---@field above? boolean
 ---@field variable? boolean
 ---@field ignore_treesitter? boolean
 ---@field insert? boolean
 ---@field motion? boolean
 
----@class DebugprintFunctionOptionsInternal: DebugprintFunctionOptions
+---@class debugprint.FunctionOptionsInternal: debugprint.FunctionOptions
 ---@field variable_name? string
 ---@field register? string
 
----@class DebugprintCommandOpts
+---@class debugprint.CommandOpts
 ---@field line1 integer
 ---@field line2 integer
 ---@field range 1|2

lua/debugprint/utils/buffer.lua

@@ -132,7 +132,7 @@ M.is_modifiable = function()
     end
 end
 
----@param opts DebugprintCommandOpts
+---@param opts debugprint.CommandOpts
 ---@return string[],integer
 M.get_command_lines_to_handle = function(opts)
     local lines_to_consider

lua/debugprint/utils/init.lua

@@ -17,7 +17,7 @@ local get_node_at_cursor = function()
     end
 end
 
----@param filetype_config DebugprintFileTypeConfig
+---@param filetype_config debugprint.FileTypeConfig
 ---@return string?
 local find_treesitter_variable = function(filetype_config)
     local node_at_cursor = get_node_at_cursor()
@@ -34,7 +34,7 @@ local find_treesitter_variable = function(filetype_config)
 end
 
 ---@param ignore_treesitter boolean
----@param filetype_config DebugprintFileTypeConfig
+---@param filetype_config debugprint.FileTypeConfig
 ---@return string?
 M.get_variable_name = function(ignore_treesitter, filetype_config)
     local variable_name = utils_buffer.get_visual_selection()