Merge pull request #322 from teddylear/print-var-norm-mode-split-cmd

feat: add option for print_var for normal mode attempt to find var under cursor

Author: pranavrao145

README.md

@@ -101,10 +101,10 @@ are supported (with individual support for each function may vary):
   - **Print var:** Automated insertion of print statement to print a variable
     at a given point in the code. This map can be made with either visual or
     normal mode:
-    - Using this function in normal mode will automatically find the variable
-      under the cursor and print it.
     - Using this function in visual mode will print out whatever is in the
       visual selection.
+    - Setting `{ normal = true }` to the function will automatically find the variable
+      under the cursor and print it from normal mode without needing visual mode at all
   - **Cleanup:** Automated cleanup of all print statements generated by the
     plugin
 
@@ -294,5 +294,9 @@ require('refactoring').setup({
         c = true,
         java = true,
     },
+    -- custom print_var_statements by language
+    print_var_statements = {}
+    -- custom printf_statements by language
+    printf_statements = {}
 })
 ```

lua/refactoring/debug/print_var.lua

@@ -10,41 +10,33 @@ local debug_utils = require("refactoring.debug.debug_utils")
 local ensure_code_gen = require("refactoring.tasks.ensure_code_gen")
 local get_select_input = require("refactoring.get_select_input")
 
-local function get_variable()
-    local variable_region = Region:from_current_selection()
-    if
-        variable_region.start_col == 0
-        and variable_region.end_col == 0
-        and variable_region.start_row == 0
-        and variable_region.end_row == 0
-    then
+local function get_variable(opts, point)
+    if opts.normal then
         local bufnr = 0
         local root_lang_tree = parsers.get_parser(bufnr)
-        local current_pos = Point:from_cursor()
-        local line = current_pos.row
-        local col = current_pos.col
-        variable_region.start_row = current_pos.row
+        local row = point.row
+        local col = point.col
         local lang_tree = root_lang_tree:language_for_range({
-            current_pos.row,
-            current_pos.col,
-            current_pos.row,
-            current_pos.col,
+            point.row,
+            point.col,
+            point.row,
+            point.col,
         })
         for _, tree in ipairs(lang_tree:trees()) do
             local root = tree:root()
-            if
-                root and ts_utils.is_in_node_range(root, current_pos.row, col)
-            then
-                root:named_descendant_for_range(line, col, line, col)
+            if root and ts_utils.is_in_node_range(root, row, col) then
+                root:named_descendant_for_range(row, col, row, col)
             end
         end
         local node = ts_utils.get_node_at_cursor()
         local filetype = vim.bo[bufnr].filetype
+        -- TODO: Can we do something with treesitter files here?
         if filetype == "php" then
             return "$" .. ts_utils.get_node_text(node)[1]
         end
         return ts_utils.get_node_text(node)[1]
     end
+    local variable_region = Region:from_current_selection()
     return variable_region:get_text()[1]
 end
 
@@ -66,8 +58,12 @@ local function printDebug(bufnr, config)
             opts.below = true
             point.col = opts.below and 100000 or 1
 
+            if opts.normal == nil then
+                opts.normal = false
+            end
+
             -- Get variable text
-            local variable = get_variable()
+            local variable = get_variable(opts, point)
             local indent
             if refactor.ts.allows_indenting_task then
                 local indent_amount = get_indent_amount(refactor)

lua/refactoring/tests/debug/print_var/c/simple-function-nor-mode/print_var.opts

@@ -0,0 +1 @@
+true

lua/refactoring/tests/debug/print_var/cpp/simple-function-nor-mode/print_var.opts

@@ -0,0 +1 @@
+true

lua/refactoring/tests/debug/print_var/go/simple-function-nor-mode/print_var.opts

@@ -0,0 +1 @@
+true

lua/refactoring/tests/debug/print_var/js/simple-function-nor-mode/print_var.opts

@@ -0,0 +1 @@
+true

lua/refactoring/tests/debug/print_var/lua/simple-function-nor-mode/print_var.opts

@@ -0,0 +1 @@
+true

lua/refactoring/tests/debug/print_var/php/simple-function-nor-mode/print_var.opts

@@ -0,0 +1 @@
+true

lua/refactoring/tests/debug/print_var/py/simple-function-nor-mode/print_var.opts

@@ -0,0 +1 @@
+true

lua/refactoring/tests/debug_spec.lua

@@ -34,23 +34,25 @@ local function set_config_options(filename_prefix, filename_extension)
             string.format("%s.config", filename_prefix)
         )
 
-        local filetypes = {
-            ["ts"] = "typescript",
-            ["js"] = "javascript",
-            ["py"] = "python",
-        }
-
-        -- get the real filetype from the above table if possible
-        local real_filetype = filetypes[filename_extension]
-            or filename_extension
-
-        local printf_statements = {}
-        printf_statements[real_filetype] = { config_values[1] }
-        Config:get():set_printf_statements(printf_statements)
-
-        local print_var_statements = {}
-        print_var_statements[real_filetype] = { config_values[1] }
-        Config:get():set_print_var_statements(print_var_statements)
+        if config_values[1] ~= "" then
+            local filetypes = {
+                ["ts"] = "typescript",
+                ["js"] = "javascript",
+                ["py"] = "python",
+            }
+
+            -- get the real filetype from the above table if possible
+            local real_filetype = filetypes[filename_extension]
+                or filename_extension
+
+            local printf_statements = {}
+            printf_statements[real_filetype] = { config_values[1] }
+            Config:get():set_printf_statements(printf_statements)
+
+            local print_var_statements = {}
+            print_var_statements[real_filetype] = { config_values[1] }
+            Config:get():set_print_var_statements(print_var_statements)
+        end
     end
 end
 
@@ -77,6 +79,29 @@ local function get_debug_operation(path)
     return temp[#temp]
 end
 
+local function get_func_opts(filename_prefix)
+    local opts_file_name = string.format("%s.opts", filename_prefix)
+
+    local opts_file = Path:new(
+        cwd,
+        "lua",
+        "refactoring",
+        "tests",
+        opts_file_name
+    )
+
+    local opts = {}
+    if opts_file:exists() then
+        local opts_values = test_utils.get_contents(opts_file_name)
+
+        if opts_values[1] ~= nil then
+            opts["normal"] = true
+        end
+    end
+
+    return opts
+end
+
 describe("Debug", function()
     for_each_file(function(file)
         a.it(string.format("printf: %s", file), function()
@@ -102,7 +127,9 @@ describe("Debug", function()
             test_utils.run_commands(filename_prefix)
             Config.get():set_test_bufnr(bufnr)
 
-            debug[debug_operation]({})
+            local func_opts = get_func_opts(filename_prefix)
+
+            debug[debug_operation](func_opts)
             async.util.scheduler()
             local lines = vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)
             eq(expected, lines)