@@ -5,15 +5,6 @@ The [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) pickers t
55The plugin analyzes the entire class/module hierarchy, including parent classes, traits, interfaces, and other inherited elements, giving you a complete view of the API surface.
66![ demo.gif] ( https://github.com/user-attachments/assets/e9ddda56-912d-4475-b7d6-94c573939db6 )
77
8- ## Features
9-
10- - ** Complete API view** : Display all class/module members including inherited elements
11- - ** Visibility indicators** : Shows access modifiers (public, private, protected) for each member
12- - ** Hierarchical analysis** : Understands inheritance from parent classes, traits, and interfaces
13- - ** Fast navigation** : Quickly jump to any symbol definition
14- - ** Integration with LSP** : Works alongside your language server for accurate symbol information
15- - ** Telescope integration** : Familiar fuzzy-finding interface for efficient filtering
16-
178## Supported Languages
189
1910- PHP
@@ -30,37 +21,37 @@ The plugin analyzes the entire class/module hierarchy, including parent classes,
3021## Installation
3122Using [ lazy.nvim] ( https://github.com/folke/lazy.nvim )
3223``` lua
33- {
24+ { -- Add the clapi plugin with its dependencies
3425 ' markelca/clapi.nvim' ,
35- -- Dev Mode (Clone the repo, update the `dir` value and uncomment the two lines below)
36- -- dir = '~/<dir-where-you-cloned>/clapi.nvim/',
37- -- name = 'clapi',
3826 dependencies = {
3927 ' nvim-telescope/telescope.nvim' ,
4028 ' nvim-treesitter/nvim-treesitter' ,
4129 ' nvim-lua/plenary.nvim' ,
4230 },
31+ },
32+ { -- Add the following to your telescope configuration
33+ ' nvim-telescope/telescope.nvim' ,
4334 config = function ()
44- -- Enable the clapi extension adding the following line to your telescope configuration:
45- pcall (require (' telescope' ).load_extension ' clapi' )
46-
47- -- Optionally you can set up a keymap to run the picker
48- vim .keymap .set (' n' , ' <leader>sa' , require (' clapi' ).builtin , { desc = ' [S]earch [A]pi' })
49-
5035 -- Configurations for the clapi picker
5136 require (' telescope' ).setup {
5237 extensions = {
5338 clapi = {
5439 -- Additional options can be configured here
55- -- show_inherited = true, -- Set to false to only show members defined in the current class
56- -- default_visibility = "public", -- Filter by default visibility (public, protected, private)
40+ show_inherited = true , -- Set to false to only show members defined in the current class
41+ default_visibility = " public" , -- Filter by default visibility (public, protected, private)
5742 },
5843 },
5944 }
45+ -- Enable the clapi extension adding the following line to your telescope configuration:
46+ pcall (require (' telescope' ).load_extension ' clapi' )
47+ -- Optionally you can set up a keymap to run the picker
48+ vim .keymap .set (' n' , ' <leader>sa' , require (' clapi' ).builtin , { desc = ' [S]earch [A]pi' })
6049 end ,
6150}
6251```
63- Full example in my nvim config repository: [ nvim] ( https://github.com/MarkelCA/nvim/blob/master/lua/plugins/clapi.lua )
52+ Full example in my [ nvim] ( https://github.com/markelca/nvim ) config repository:
53+ - [ clapi] ( https://github.com/markelca/nvim/blob/master/lua/plugins/clapi.lua )
54+ - [ telescope] ( https://github.com/markelca/nvim/blob/master/lua/plugins/telescope.lua )
6455
6556## Usage
6657
@@ -129,4 +120,4 @@ Contributions are welcome! Please feel free to submit a Pull Request.
1291204 . Push to the branch
1301215 . Submit a pull request
131122
132- For adding support for a new language, check the ` lua/clapi/parser/ ` directory for examples.
123+ For adding support for a new language, check the ` lua/clapi/parser/ ` directory for examples.
0 commit comments