fix: use correct query for function with 0 or more comments before

Author: TheLeoP

lua/refactoring/refactor/extract_func.lua

@@ -583,14 +583,13 @@ end
 ---@param config refactor.Config
 M.extract_func = function(range_type, config)
   local get_extracted_range = require("refactoring.utils").get_extracted_range
-  local get_extracted_lines = require("refactoring.utils").get_extracted_lines
   local input = require("refactoring.utils").input
 
   local opts = config.refactor.extract_func
 
   local buf = api.nvim_get_current_buf()
   local extracted_range = get_extracted_range(buf, range_type)
-  local lines = get_extracted_lines(range_type)
+  local lines = vim.fn.getregion(vim.fn.getpos "'[", vim.fn.getpos "']", { type = range_type })
 
   local task = async.run(function()
     local fn_name = opts.input and table.remove(opts.input, 1) or input { prompt = "Function name: " }
@@ -612,14 +611,13 @@ end
 ---@param config refactor.Config
 M.extract_func_to_file = function(range_type, config)
   local get_extracted_range = require("refactoring.utils").get_extracted_range
-  local get_extracted_lines = require("refactoring.utils").get_extracted_lines
   local input = require("refactoring.utils").input
 
   local opts = config.refactor.extract_func
 
   local buf = api.nvim_get_current_buf()
   local extracted_range = get_extracted_range(buf, range_type)
-  local lines = get_extracted_lines(range_type)
+  local lines = vim.fn.getregion(vim.fn.getpos "'[", vim.fn.getpos "']", { type = range_type })
 
   local task = async.run(function()
     local file_name = opts.input and table.remove(opts.input)

lua/refactoring/refactor/inline_func.lua

@@ -201,8 +201,8 @@ function M.inline_func(_, config)
     local definitions = unpack(results[1]) ---@type refactor.QfItem[]
     local references = unpack(results[2]) ---@type refactor.QfItem[]
 
-    local match_info = get_processed_match_info(definitions, references, lang)
-    if not match_info then return end
+    local match_info_by_buf = get_processed_match_info(definitions, references, lang)
+    if not match_info_by_buf then return end
 
     ---@class refactor.inline_func.DefinitionWithFunctionInfo
     ---@field definition refactor.QfItem
@@ -215,7 +215,7 @@ function M.inline_func(_, config)
         function(d)
           local buf = vim.fn.bufadd(d.filename)
 
-          local match_info = match_info[buf]
+          local match_info = match_info_by_buf[buf]
           -- TODO: add range.vimscript
           local d_range = range(d.lnum - 1, d.col - 1, d.end_lnum - 1, d.end_col - 1, { buf = buf })
           local function_info = iter(match_info.functions):find(
@@ -266,14 +266,18 @@ function M.inline_func(_, config)
     ---@field reference refactor.QfItem
     ---@field function_call_info refactor.FunctionCallInfo
 
+    -- TODO: some LSPs (like lua_ls) may give a reference to a symbol that is
+    -- not a function_call (i.e. the variable declaration on `require`). Maybe
+    -- give a warning and do nothing if there are no
+    -- `references_with_function_call_info` (?
     ---@type refactor.inline_func.ReferenceWithFunctionCallInfo[]
     local references_with_function_call_info = iter(references)
       :map(
         ---@param r refactor.QfItem
         function(r)
           local buf = vim.fn.bufadd(r.filename)
 
-          local match_info = match_info[buf]
+          local match_info = match_info_by_buf[buf]
           -- TODO: add range.vimscript
           local r_range = range(r.lnum - 1, r.col - 1, r.end_lnum - 1, r.end_col - 1, { buf = buf })
           local function_call_info = iter(match_info.function_calls):find(
@@ -303,9 +307,12 @@ function M.inline_func(_, config)
     else
       body_end_row, body_end_col = function_info.returns_info[1]["return"]:start()
     end
+    local body_range = range(body_start_row, body_start_col, body_end_row, body_end_col, { buf = in_buf })
+    local b_srow, b_scol, b_erow, b_ecol = body_range:to_extmark()
 
-    local body_lines_without_return =
-      api.nvim_buf_get_text(in_buf, body_start_row, body_start_col, body_end_row, body_end_col, {})
+    local body_lines_without_return = api.nvim_buf_get_text(in_buf, b_srow, b_scol, b_erow, b_ecol, {})
+    -- NOTE: can't use `indent()` because first line may not have any indent because of treesitter
+    -- TODO: use `indent()` without the first line and then add the first line
     local body_without_return = iter(body_lines_without_return)
       :map(
         ---@param line string

lua/refactoring/refactor/inline_var.lua

@@ -173,16 +173,16 @@ function M.inline_var(_, config)
     local definitions = unpack(results[1]) ---@type refactor.QfItem[]
     local references = unpack(results[2]) ---@type refactor.QfItem[]
 
-    local match_info = get_match_info(definitions, references, lang)
-    if not match_info then return end
+    local match_info_by_buf = get_match_info(definitions, references, lang)
+    if not match_info_by_buf then return end
 
     ---@type {definition: refactor.QfItem, info: refactor.ProcessedVariableInfo}[]
     local definitions_with_info = iter(definitions)
       :map(
         ---@param d refactor.QfItem
         function(d)
           local definition_buf = vim.fn.bufadd(d.filename)
-          local variables_info = match_info[definition_buf].variables
+          local variables_info = match_info_by_buf[definition_buf].variables
           local definition_info = get_definition_info(d, variables_info)
           return { definition = d, info = definition_info }
         end
@@ -242,7 +242,7 @@ function M.inline_var(_, config)
           -- TODO: add range.vimscript
           local reference_range = range(r.lnum - 1, r.col - 1, r.end_lnum - 1, r.end_col - 1, { buf = reference_buf })
 
-          local references_info = match_info[reference_buf].references
+          local references_info = match_info_by_buf[reference_buf].references
           local reference_info = iter(references_info):find(
             ---@param ri refactor.ReferenceInfo
             function(ri)

lua/refactoring/utils.lua

@@ -297,15 +297,6 @@ function M.get_extracted_range(buf, range_type)
   return range(range_start[1], range_start[2], range_end[1], range_end[2], { buf = buf })
 end
 
--- TODO: rename this everywhere (and the resulting var) to a more general name.
--- `extracted_range` comes from the `extratc_func` refactor, but it's now used
--- in multiple (all?) refactors
--- TODO: inline this instead?
----@param range_type 'v'|'V'|''
-function M.get_extracted_lines(range_type)
-  return vim.fn.getregion(vim.fn.getpos "'[", vim.fn.getpos "']", { type = range_type })
-end
-
 -- TODO: maybe use Info sufix for all of these types
 ---@class refactor.TsInfo
 ---@field debug_paths refactor.DebugPath[]

queries/c/extract_func.scm

@@ -84,5 +84,7 @@
     (_) @scope)) @scope.outside
 
 (translation_unit
-  ((comment)* @output.comment
-    (function_definition) @output.function))
+  _*
+  (comment)* @output.comment
+  .
+  (function_definition) @output.function)

queries/c_sharp/extract_func.scm

@@ -46,16 +46,20 @@
     (_) @scope.inside)) @scope
 
 (compilation_unit
-  ((comment)* @output.comment
-    (global_statement
-      (local_function_statement) @output.function)))
+  _*
+  (comment)* @output.comment
+  .
+  (global_statement
+    (local_function_statement) @output.function))
 
 (compilation_unit
   (class_declaration
     (declaration_list
-      ((comment)* @output.comment
-        [
-          (method_declaration)
-          (constructor_declaration)
-        ] @output.function)))
+      _*
+      (comment)* @output.comment
+      .
+      [
+        (method_declaration)
+        (constructor_declaration)
+      ] @output.function))
   (#set! method true))

queries/ecma/extract_func.scm

@@ -90,26 +90,34 @@
 
 ; function a() {}
 (program
-  ((comment)* @output.comment
-    (function_declaration) @output.function))
+  _*
+  (comment)* @output.comment
+  .
+  (function_declaration) @output.function)
 
 ; const a = ()=>{}
 (program
-  ((comment)* @output.comment
-    (lexical_declaration
-      (variable_declarator
-        (arrow_function))) @output.function))
+  _*
+  (comment)* @output.comment
+  .
+  (lexical_declaration
+    (variable_declarator
+      (arrow_function))) @output.function)
 
 ; a = ()=>{}
 (program
-  ((comment)* @output.comment
-    (expression_statement
-      (assignment_expression
-        (arrow_function))) @output.function))
+  _*
+  (comment)* @output.comment
+  .
+  (expression_statement
+    (assignment_expression
+      (arrow_function))) @output.function)
 
 (program
   (class_declaration
     (class_body
-      ((comment)* @output.comment
-        (method_definition) @output.function)))
+      _*
+      (comment)* @output.comment
+      .
+      (method_definition) @output.function))
   (#set! method true))

queries/go/extract_func.scm

@@ -119,16 +119,20 @@
     (_) @scope.inside)) @scope
 
 (source_file
-  ((comment)* @output.comment
-    (function_declaration) @output.function))
+  _*
+  (comment)* @output.comment
+  .
+  (function_declaration) @output.function)
 
 (source_file
-  ((comment)* @output.comment
-    (method_declaration
-      receiver: (parameter_list
-        (parameter_declaration
-          name: (identifier) @_struct_var_name
-          type: (pointer_type
-            (type_identifier) @_struct_name)))) @output.function)
+  _*
+  (comment)* @output.comment
+  .
+  (method_declaration
+    receiver: (parameter_list
+      (parameter_declaration
+        name: (identifier) @_struct_var_name
+        type: (pointer_type
+          (type_identifier) @_struct_name)))) @output.function
   (#set! struct_name @_struct_name)
   (#set! struct_var_name @_struct_var_name))

queries/lua/extract_func.scm

@@ -1,22 +1,27 @@
 ; local a = function() end
 (chunk
-  ((comment)* @output.comment
-    (variable_declaration
-      (assignment_statement
-        (expression_list
-          (function_definition)))) @output.function))
+  _*
+  (comment)* @output.comment
+  .
+  (variable_declaration
+    (assignment_statement
+      (expression_list
+        (function_definition)))) @output.function)
 
 ; a = function() end
 (chunk
-  ((comment)* @output.comment
-    (assignment_statement
-      (expression_list
-        (function_definition))) @output.function))
+  _*
+  (comment)* @output.comment
+  (assignment_statement
+    (expression_list
+      (function_definition))) @output.function)
 
 ; function a() end
 (chunk
-  ((comment)* @output.comment
-    (function_declaration) @output.function))
+  _*
+  (comment)* @output.comment
+  .
+  (function_declaration) @output.function)
 
 ; foo = bar
 (assignment_statement

queries/lua/inline_func.scm

@@ -1,4 +1,5 @@
 ((comment)* @function.comment
+  .
   (function_declaration
     parameters: (parameters
       (identifier) @function.arg
@@ -7,6 +8,7 @@
     body: (block) @function.body) @function)
 
 ((comment)* @function.comment
+  .
   (variable_declaration
     (assignment_statement
       (expression_list
@@ -19,13 +21,13 @@
 
 (return_statement
   (expression_list
-    (identifier) @return.value
+    (_) @return.value
     (","
-      (identifier) @return.value)*)?) @return
+      (_) @return.value)*)?) @return
 
 ; b()
 ((function_call
-  name: (identifier) @function_call.name
+  name: (_) @function_call.name
   arguments: (arguments
     .
     (_) @function_call.arg
@@ -37,12 +39,12 @@
 ; a = b()
 ((assignment_statement
   (variable_list
-    name: (identifier) @function_call.return_value
+    name: (_) @function_call.return_value
     (","
-      name: (identifier) @function_call.return_value)*)
+      name: (_) @function_call.return_value)*)
   (expression_list
     value: (function_call
-      name: (identifier) @function_call.name
+      name: (_) @function_call.name
       arguments: (arguments
         .
         (_) @function_call.arg
@@ -55,12 +57,12 @@
 (variable_declaration
   (assignment_statement
     (variable_list
-      name: (identifier) @function_call.return_value
+      name: (_) @function_call.return_value
       (","
-        name: (identifier) @function_call.return_value)*)
+        name: (_) @function_call.return_value)*)
     (expression_list
       value: (function_call
-        name: (identifier) @function_call.name
+        name: (_) @function_call.name
         arguments: (arguments
           .
           (_) @function_call.arg