Skip to content

Commit 9d95eae

Browse files
committed
Fixed and included some things in the README
1 parent 5fbd6cd commit 9d95eae

1 file changed

Lines changed: 13 additions & 8 deletions

File tree

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Using [lazy.nvim](https://github.com/folke/lazy.nvim)
4444
-- Enable the clapi extension
4545
pcall(require('telescope').load_extension 'clapi')
4646
-- Optionally you can set up a keymap to run the picker
47-
vim.keymap.set('n', '<leader>sa', require('clapi').builtin, { desc = '[S]earch [A]pi' })
47+
vim.keymap.set('n', '<leader>sa', require('telescope').extensions.clapi.clapi, { desc = '[S]earch [A]pi' })
4848
end,
4949
}
5050
```
@@ -59,19 +59,21 @@ After installation, you can use the picker with:
5959
```vim
6060
:Telescope clapi
6161
```
62+
You can also add parameters
63+
```vim
64+
:Telescope clapi show_inherited=false
65+
```
6266

6367
Or in Lua:
6468

6569
```lua
70+
-- Call the builtin directly
6671
:lua require('clapi').builtin()
67-
```
72+
:lua require('clapi').builtin({show_inherited = false}) -- You can also pass options to filter the results
6873

69-
You can also pass options to filter the results:
70-
71-
```lua
72-
:lua require('clapi').builtin({show_inherited = false})
74+
-- Call the extension instead. This option will use your default configurations from the telescope config
75+
:lua require('telescope').extensions.clapi.clapi()
7376
```
74-
7577
## Configuration Options
7678

7779
The following options can be configured in the telescope setup:
@@ -108,6 +110,7 @@ A: Make sure you have the appropriate language parser installed for treesitter:
108110

109111
**Q: Some inherited members are missing**
110112
A: The plugin requires proper parsing of the inheritance hierarchy. Ensure your project structure allows the plugin to find parent classes and interfaces.
113+
A: Check that you have an LSP installed and attached to the current buffer. It may take a few seconds since you open the file.
111114

112115
## Contributing
113116

@@ -119,4 +122,6 @@ Contributions are welcome! Please feel free to submit a Pull Request.
119122
4. Push to the branch
120123
5. Submit a pull request
121124

122-
For adding support for a new language, check the `lua/clapi/parser/` directory for examples.
125+
For adding support for a new language, check the following folders for examples:
126+
- `lua/clapi/parser/`: Specific parser logic for each language.
127+
- `queries/`: Treesitter queries for each language.

0 commit comments

Comments
 (0)