show_inherited option

Author: markelca

doc/clapi.txt

@@ -99,12 +99,15 @@ The clapi picker accepts the following options:
   - `bufnr`: Buffer number (defaults to current buffer)
   - `path_display`: How to display paths
   - `entry_maker`: Custom entry maker function
+  - `show_inherited`: Whether to show inherited members from parent classes,
+    traits, and interfaces (defaults to true)
 
 Example configuration: >lua
   require('telescope').setup {
     extensions = {
       clapi = {
         -- Default configuration options
+        show_inherited = true, -- Set to false to only show members defined in the current class
       },
     },
   }
@@ -128,6 +131,9 @@ Parameters:
     - `bufnr` (number, optional): Buffer number, defaults to current buffer (0)
     - `path_display` (table|string, optional): How to display paths
     - `entry_maker` (function, optional): Custom entry maker function
+    - `show_inherited` (boolean, optional): Show inherited members from parent classes,
+      traits, and interfaces. Defaults to true. Set to false to only show members
+      defined in the current class.
 
 Returns: nil
 
@@ -150,7 +156,8 @@ Basic usage: >lua
 Advanced usage with custom options: >lua
   -- Open the API picker with specific options
   require('clapi').builtin({
-    path_display = { "smart" }
+    path_display = { "smart" },
+    show_inherited = false -- Only show members defined in the current class
   })
 <
 

lua/clapi/finder.lua

@@ -13,11 +13,20 @@ local M = {}
 ---@param opts.bufnr? integer Buffer number, defaults to current buffer (0)
 ---@param opts.path_display? table|string How to display paths
 ---@param opts.entry_maker? function Custom entry maker function
+---@param opts.show_inherited? boolean Show inherited members, defaults to true
 ---@return nil
 M.builtin = function(opts)
 	opts = opts or {}
 	opts.bufnr = opts.bufnr or 0
 	opts.path_display = { "hidden" }
+
+	-- Get extension configuration
+	local telescope_config = require("telescope.config").values
+	local ext_config = telescope_config.extensions and telescope_config.extensions.clapi or {}
+
+	-- Set show_inherited default value (true if not specified)
+	opts.show_inherited = vim.F.if_nil(opts.show_inherited, ext_config.show_inherited, true)
+
 	async.run(function()
 		local results = parser.parse_file(opts)
 		if not results then

lua/clapi/parser/init.lua

@@ -41,10 +41,12 @@ end
 ---Get parent class file and parse its definitions
 ---@param opts table Options for parsing
 ---@param opts.bufnr? integer Buffer number, defaults to current buffer (0)
+---@param opts.show_inherited? boolean Whether to include inherited members from grandparents, defaults to true
 ---@return table|nil definitions List of definitions from parent class or nil if error
 local get_parent_file = async.wrap(function(opts, callback)
 	opts = opts or {}
 	opts.bufnr = opts.bufnr or 0
+	opts.show_inherited = vim.F.if_nil(opts.show_inherited, true)
 
 	local filetype = tsparsers.get_buf_lang(opts.bufnr)
 	local parser = vim.treesitter.get_parser(opts.bufnr, filetype)
@@ -108,7 +110,12 @@ local get_parent_file = async.wrap(function(opts, callback)
 					-- error already printed in get_file_from_position
 					callback(nil)
 				end
-				local defs = M.parse_file({ filename = filepath, class_name = class_name })
+				-- Pass the show_inherited option to parse_file for recursive parent parsing
+				local defs = M.parse_file({
+					filename = filepath,
+					class_name = class_name,
+					show_inherited = opts.show_inherited
+				})
 				for _, value in pairs(defs) do
 					if value["visibility"] ~= "private" then
 						table.insert(result, value)
@@ -127,10 +134,12 @@ end, 2)
 ---@param opts.class_name? string Name of the class to filter results
 ---@param opts.filetype? string Force filetype instead of detecting from extension
 ---@param opts.query_str? string Custom query string instead of loading from queries
+---@param opts.show_inherited? boolean Whether to include inherited members, defaults to true
 ---@return table|nil results List of symbols found or nil if error
 M.parse_file = async.wrap(function(opts, callback)
 	opts = opts or {}
 	opts.class_name = opts.class_name and string.format("%s::", opts.class_name) or ""
+	opts.show_inherited = vim.F.if_nil(opts.show_inherited, true)
 
 	if opts.filename and opts.bufnr then
 		utils.notify("parse_file", {
@@ -258,19 +267,27 @@ M.parse_file = async.wrap(function(opts, callback)
 		end
 	end
 
-	async.run(function()
-		local parent_defs = get_parent_file({ bufnr = opts.bufnr })
-		if not parent_defs then
-			-- error already printed somewhere
-			callback(result)
-			return
-		end
-		for _, value in pairs(parent_defs) do
-			table.insert(result, value)
-		end
+	-- Only include inherited members if show_inherited is true
+	if opts.show_inherited then
+		async.run(function()
+			local parent_defs = get_parent_file({ 
+				bufnr = opts.bufnr,
+				show_inherited = opts.show_inherited
+			})
+			if not parent_defs then
+				-- error already printed somewhere
+				callback(result)
+				return
+			end
+			for _, value in pairs(parent_defs) do
+				table.insert(result, value)
+			end
 
+			callback(result)
+		end)
+	else
 		callback(result)
-	end)
+	end
 end, 2)
 
-return M
+return M

tests/manual/show_inherited_spec.lua

@@ -0,0 +1,67 @@
+local parser = require("clapi.parser")
+local lsp = require("clapi.lsp")
+
+-- Mock functions to avoid actual LSP call dependency
+local old_get_file = lsp.get_file_from_position
+lsp.get_file_from_position = function()
+  return "/home/markel/estudio/lua/clapi.nvim/tests/clapi/functional/resources/code/java/example/src/com/example/shared/AggregateRoot.java"
+end
+
+-- This test verifies that the show_inherited option works correctly
+local function test_show_inherited_option()
+  -- Test with default (show_inherited = true)
+  local course_file = "/home/markel/estudio/lua/clapi.nvim/tests/clapi/functional/resources/code/java/example/src/com/example/course/Course.java"
+  local results_with_inherited = parser.parse_file({ filename = course_file })
+  
+  -- Results should contain items from both Course.java and AggregateRoot.java
+  local found_course_method = false
+  local found_aggregate_method = false
+  
+  for _, item in ipairs(results_with_inherited) do
+    if item.name == "getTitle" then
+      found_course_method = true
+    elseif item.name == "getId" then
+      found_aggregate_method = true
+    end
+  end
+  
+  print("Test with show_inherited = true (default):")
+  print("Found Course.getTitle: " .. tostring(found_course_method))
+  print("Found AggregateRoot.getId: " .. tostring(found_aggregate_method))
+  print("")
+  
+  -- Test with show_inherited = false
+  local results_without_inherited = parser.parse_file({ 
+    filename = course_file,
+    show_inherited = false
+  })
+  
+  -- Results should only contain items from Course.java
+  found_course_method = false
+  found_aggregate_method = false
+  
+  for _, item in ipairs(results_without_inherited) do
+    if item.name == "getTitle" then
+      found_course_method = true
+    elseif item.name == "getId" then
+      found_aggregate_method = true
+    end
+  end
+  
+  print("Test with show_inherited = false:")
+  print("Found Course.getTitle: " .. tostring(found_course_method))
+  print("Found AggregateRoot.getId: " .. tostring(found_aggregate_method))
+  print("")
+  
+  -- Restore original function
+  lsp.get_file_from_position = old_get_file
+  
+  return (found_course_method and found_aggregate_method) ~= (found_course_method and not found_aggregate_method)
+end
+
+print("\n---------- Testing show_inherited option ----------")
+local success = test_show_inherited_option()
+print("Test " .. (success and "PASSED" or "FAILED"))
+print("---------------------------------------------------\n")
+
+return success