Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/plazmama/bunnyhop.nvim
🐇 Hop around your code at lightning speed ⚡️
https://github.com/plazmama/bunnyhop.nvim
huggingface neovim nvim plugin
Last synced: about 1 month ago
JSON representation
🐇 Hop around your code at lightning speed ⚡️
- Host: GitHub
- URL: https://github.com/plazmama/bunnyhop.nvim
- Owner: PLAZMAMA
- License: mit
- Created: 2024-12-20T04:51:12.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-18T21:09:25.000Z (about 1 month ago)
- Last Synced: 2025-01-18T22:19:17.490Z (about 1 month ago)
- Topics: huggingface, neovim, nvim, plugin
- Language: Lua
- Homepage:
- Size: 271 KB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# bunnyhop.nvim
Hop across your code at lightning speed ⚡️⚡️⚡️
> [!Note]
> This plugin is in alpha version, expect bugs, lacking features and documentation.
> If you found a bug, reporting it would be appriciated, while fixing it via a pull request would be greatly appriciated.
## Features
#### Supports Copilot and Hugging Face LLM's
#### Predicts your next desired cursor position a preview window, allowing you to hop to it via your chosen keybinding.
## Installation
### Prerequisites
Either Copilot(Recommenced) or Hugging Face's [Serverless](https://huggingface.co/docs/api-inference/en/index).
- For Copilot, you only need to set it up via [copilot.lua](https://github.com/zbirenbaum/copilot.lua) or [copilot.vim](https://github.com/github/copilot.vim).
- For Hugging Face, an API key is required. Learn how to set it up [here](https://huggingface.co/docs/api-inference/en/getting-started). Once you have the API key, create an enviornment variable for the key, eg. `export HF_API_KEY=************`.
### [lazy.nvim](https://github.com/folke/lazy.nvim)
```lua
{
"PLAZMAMA/bunnyhop.nvim",
lazy = false, -- This plugin does not support lazy loading for now
-- Setting the keybinding for hopping to the predicted location.
-- Change it to whatever suits you.
keys = {
{
"",
function()
require("bunnyhop").hop()
end,
desc = "[H]op to predicted location.",
},
},
opts = {}, -- if using copilot
-- Or
-- opts = {adapter = "hugging_face", api_key = "HF_API_KEY", model = "Qwen/Qwen2.5-Coder-32B-Instruct"}, -- if using hugging face
},
```
## Configuration
Bunnyhop is configured via the setup() function. The default configuration values can be found [here](lua/bunnyhop/init.lua).
## Development
### Run Tests Locally
Running tests requires either
- [luarocks][luarocks]
- or [busted][busted] and [nlua][nlua]
to be installed[^1].
[^1]: The test suite assumes that `nlua` has been installed
using luarocks into `~/.luarocks/bin/`.
You can then run:
```bash
luarocks test --local
# or
busted
```
Or if you want to run a single test file:
```bash
luarocks test spec/path_to_file.lua --local
# or
busted spec/path_to_file.lua
```
## Common Errors with Local Testing
> [!Note]
> For The local testing to work you need to have Lua 5.1 set as your default version for luarocks.
> If that's not the case you can pass `--lua-version 5.1` to all the luarocks commands above.
1. If you see an error like `module 'busted.runner' not found` run the following command:
This sets the correct luarocks path.
```bash
eval $(luarocks path --no-bin)
```
[rockspec-format]: https://github.com/luarocks/luarocks/wiki/Rockspec-format
[luarocks]: https://luarocks.org
[luarocks-api-key]: https://luarocks.org/settings/api-keys
[gh-actions-secrets]: https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository
[busted]: https://lunarmodules.github.io/busted/
[nlua]: https://github.com/mfussenegger/nlua
[use-this-template]: https://github.com/new?template_name=nvim-lua-plugin-template&template_owner=nvim-lua