Merge pull request #2 from ThePrimeagen/master

Merge latest origin changes

Author: olimorris

README.md

@@ -55,8 +55,8 @@ use {
 ### Supported Languages<a name="supported-languages"></a>
 
 Given that this is a work in progress, the languages supported for the
-operations listed below is **constantly changing**. As of now, these languages are
-supported (with individual support for each function may vary):
+operations listed below is **constantly changing**. As of now, these languages
+are supported (with individual support for each function may vary):
 
 - TypeScript
 - JavaScript
@@ -72,22 +72,41 @@ supported (with individual support for each function may vary):
 - Support for various common refactoring operations
   - **106: Extract Function**
     - In visual mode, extracts the selected code to a separate function
-    - Optionally prompts for function param types and return types (see [configuration for type prompt operations](#config-prompt))
+    - Optionally prompts for function param types and return types (see
+      [configuration for type prompt operations](#config-prompt))
     - Also possible to Extract Block.
-    - Both Extract Function and Extract Block have the capability to extract to a separate file.
+    - Both Extract Function and Extract Block have the capability to extract to
+      a separate file.
   - **119: Extract Variable**
-    - In visual mode, extracts occurences of a selected expression to its own variable, replacing occurences of that expression with the variable
+    - In visual mode, extracts occurences of a selected expression to its own
+      variable, replacing occurences of that expression with the variable
   - **123: Inline Variable**
     - Inverse of extract variable
     - Replaces all occurences of a variable with its value
-    - Cursor must be on an identifier for this function to work
+    - Can be used in normal mode or visual mode
+      - Using this function in normal mode will automatically find the variable
+        under the cursor and inline it
+      - Using this function in visual mode will find the variable(s) in the
+        visual selection.
+        - If there is more than one variable in the selection, the plugin will
+          prompt for which variable to inline,
+        - If there is only one variable in the visual selection, it will
+          automatically inline that variable
 
 ### Debug Features<a name="debug-features"></a>
 
 - Also comes with various useful features for debugging
-  - **Printf:** Automated insertion of print statement to mark the calling of a function
-  - **Print var:** Automated insertion of print statement to print a variable at a given point in the code
-  - **Cleanup:** Automated cleanup of all print statements generated by the plugin
+  - **Printf:** Automated insertion of print statement to mark the calling of a
+    function
+  - **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 visual mode will print out whatever is in the
+      visual selection.
+    - Passing `{ 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
 
 ## Configuration<a name="configuration"></a>
 
@@ -102,6 +121,37 @@ setup function.
 require('refactoring').setup({})
 ```
 
+Here are all the available options for the setup function and their defaults:
+
+```lua
+require('refactoring').setup({
+    prompt_func_return_type = {
+        go = false,
+        java = false,
+
+        cpp = false,
+        c = false,
+        h = false,
+        hpp = false,
+        cxx = false,
+    },
+    prompt_func_param_type = {
+        go = false,
+        java = false,
+
+        cpp = false,
+        c = false,
+        h = false,
+        hpp = false,
+        cxx = false,
+    },
+    printf_statements = {},
+    print_var_statements = {},
+})
+```
+
+See each of the sections below for details on each configuration option.
+
 ### Configuration for Refactoring Operations<a name="config-refactoring"></a>
 
 #### Using Direct Remaps<a name="config-refactoring-direct"></a>
@@ -144,13 +194,14 @@ vim.api.nvim_set_keymap(
 )
 ```
 
-This remap should also be made in **visual mode**, or functionality for some refactors will not work properly.
+This remap should also be made in **visual mode**, or functionality for some
+refactors will not work properly.
 
 #### Using Telescope<a name="config-refactoring-telescope"></a>
 
-If you would prefer to use Telescope to choose a refactor when you're in visual mode,
-you can do so use using the **Telescope extension.** Here is an example config
-for this setup:
+If you would prefer to use Telescope to choose a refactor when you're in visual
+mode, you can do so use using the **Telescope extension.** Here is an example
+config for this setup:
 
 ```lua
 -- load refactoring Telescope extension
@@ -167,7 +218,8 @@ vim.api.nvim_set_keymap(
 
 ### Configuration for Debug Operations<a name="config-debug"></a>
 
-Finally, you can configure remaps for the debug operations of this plugin like this:
+Finally, you can configure remaps for the debug operations of this plugin like
+this:
 
 ```lua
 -- You can also use below = true here to to change the position of the printf
@@ -179,7 +231,11 @@ vim.api.nvim_set_keymap(
 	{ noremap = true }
 )
 
--- Print var: this remap should be made in visual mode
+-- Print var
+
+-- Remap in normal mode and passing { normal = true } will automatically find the variable under the cursor and print it
+vim.api.nvim_set_keymap("n", "<leader>rv", ":lua require('refactoring').debug.print_var({ normal = true })<CR>", { noremap = true })
+-- Remap in visual mode will print whatever is in the visual selection
 vim.api.nvim_set_keymap("v", "<leader>rv", ":lua require('refactoring').debug.print_var({})<CR>", { noremap = true })
 
 -- Cleanup function: this remap should be made in normal mode
@@ -193,7 +249,8 @@ functionalities.
 
 ##### Customizing Printf Statements<a name="config-debug-stringification-printf"></a>
 
-You can add to the printf statements for any language by adding something like the below to your configuration:
+You can add to the printf statements for any language by adding something like
+the below to your configuration:
 
 ```lua
 require('refactoring').setup({
@@ -236,8 +293,10 @@ sequence like this: `%%s`. For an example custom print var statement, go to
 [this folder](lua/refactoring/tests/debug/print_var), select your language, and
 view `multiple-statements/print_var.config`.
 
-**Note:** for either of these functions, if you have multiple statements
-(including the default), the plugin will prompt for which one should be inserted.
+**Note:** for either of these functions, if you have multiple custom
+statements, the plugin will prompt for which one should be inserted. If you
+just have one custom statement in your config, it will override the default
+automatically.
 
 ### Configuration for Type Prompt Operations<a name="config-prompt"></a>
 

lua/refactoring/config/init.lua

@@ -30,8 +30,8 @@ local default_formatting = {
 
 local default_prompt_func_param_type = {
     go = false,
+    java = false,
 
-    -- All of the cs
     cpp = false,
     c = false,
     h = false,
@@ -41,6 +41,13 @@ local default_prompt_func_param_type = {
 
 local default_prompt_func_return_type = {
     go = false,
+    java = false,
+
+    cpp = false,
+    c = false,
+    h = false,
+    hpp = false,
+    cxx = false,
 }
 
 local default_printf_statements = {}

lua/refactoring/debug/cleanup.lua

@@ -22,13 +22,27 @@ local function cleanup(bufnr, config)
             end
 
             for row_num, line in ipairs(lines) do
-                local region = Region:from_values(
-                    bufnr,
-                    row_num,
-                    1,
-                    row_num,
-                    100000
-                )
+                local region
+                if row_num ~= 1 then
+                    region = Region:from_values(
+                        bufnr,
+                        row_num - 1,
+                        100000,
+                        row_num,
+                        100000
+                    )
+                else
+                    print(
+                        "NOTE! Can't delete first line of file, leaving blank"
+                    )
+                    region = Region:from_values(
+                        bufnr,
+                        row_num,
+                        1,
+                        row_num,
+                        100000
+                    )
+                end
 
                 if opts.printf then
                     if

lua/refactoring/debug/print_var.lua

@@ -4,15 +4,46 @@ local Region = require("refactoring.region")
 local refactor_setup = require("refactoring.tasks.refactor_setup")
 local post_refactor = require("refactoring.tasks.post_refactor")
 local lsp_utils = require("refactoring.lsp_utils")
+local ts_utils = require("nvim-treesitter.ts_utils")
+local parsers = require("nvim-treesitter.parsers")
 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 function get_variable(opts, point)
+    if opts.normal then
+        local bufnr = 0
+        local root_lang_tree = parsers.get_parser(bufnr)
+        local row = point.row
+        local col = point.col
+        local lang_tree = root_lang_tree:language_for_range({
+            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, 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
 
+local function get_indent_amount(refactor)
+    return refactor.whitespace.cursor / refactor.whitespace.tabstop
+end
+
 local function printDebug(bufnr, config)
     return Pipeline
         :from_task(refactor_setup(bufnr, config))
@@ -27,8 +58,20 @@ 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)
+                indent = refactor.code.indent({
+                    indent_width = refactor.whitespace.tabstop,
+                    indent_amount = indent_amount,
+                })
+            end
 
             local debug_path = debug_utils.get_debug_path(refactor, point)
             local prefix = string.format("%s %s:", debug_path, variable)
@@ -42,17 +85,17 @@ local function printDebug(bufnr, config)
             local print_var_statement
 
             if custom_print_var_statements then
-                local all_statements = vim.list_extend(
-                    default_print_var_statement,
-                    custom_print_var_statements
-                )
-                print_var_statement = get_select_input(
-                    all_statements,
-                    "print_var: Select a statement to insert:",
-                    function(item)
-                        return item
-                    end
-                )
+                if #custom_print_var_statements > 1 then
+                    print_var_statement = get_select_input(
+                        custom_print_var_statements,
+                        "print_var: Select a statement to insert:",
+                        function(item)
+                            return item
+                        end
+                    )
+                else
+                    print_var_statement = custom_print_var_statements[1]
+                end
             else
                 print_var_statement = default_print_var_statement[1]
             end
@@ -64,12 +107,23 @@ local function printDebug(bufnr, config)
             }
 
             local print_statement = refactor.code.print_var(print_var_opts)
-                .. refactor.code.comment("__AUTO_GENERATED_PRINT_VAR__")
+
+            local statement
+            if indent ~= nil then
+                local temp = {}
+                temp[1] = indent
+                temp[2] = print_statement
+                statement = table.concat(temp, "")
+            else
+                statement = print_statement
+            end
 
             refactor.text_edits = {
                 lsp_utils.insert_new_line_text(
                     Region:from_point(point),
-                    print_statement,
+                    statement
+                        .. " "
+                        .. refactor.code.comment("__AUTO_GENERATED_PRINT_VAR__"),
                     opts
                 ),
             }