An open API service indexing awesome lists of open source software.

https://github.com/zitrocode/spot.nvim

Prefix-driven command palette for Neovim inspired by the VS Code command palette.
https://github.com/zitrocode/spot.nvim

neovim neovim-lua-plugin neovim-plugin neovim-ui

Last synced: 2 months ago
JSON representation

Prefix-driven command palette for Neovim inspired by the VS Code command palette.

Awesome Lists containing this project

README

          

# 🔎 spot.nvim

Prefix-driven command palette for Neovim inspired by the VS Code command palette.

Spot provides a single place to search and execute actions.
Start typing to search files, or add a prefix to switch context instantly —
all within the same input.

![demo](./assets/demo.png)

## âœĻ Features

- 🔎 Prefix-based source switching
- 📂 Fast file search powered by `fd`
- ⚡ Single input workflow
- ðŸŠķ Lightweight floating picker UI
- ðŸŽŊ Active mode always visible in the title bar

## ðŸ”Ĩ Status

**spot.nvim** is still under active development and should be considered experimental.

Things may change, and bugs are expected.

If you encounter any issues, please open an issue and include
as much detail as possible — it helps a lot when tracking down problems.

## ⚡ Requirements

- Neovim â‰Ĩ 0.10
- [`fd`](https://github.com/sharkdp/fd)

## ðŸ“Ķ Installation

Install using your preferred plugin manager.

### lazy.nvim

```lua
{
"zitrocode/spot.nvim",
config = function()
require("spot").setup()
end,
}
```

### packer.nvim

```lua
use {
"zitrocode/spot.nvim",
config = function()
require("spot").setup()
end,
}
```

## 🚀 Usage

### Commands

Spot provides the following user commands:

| Command | Description |
| ------------- | ------------------------------- |
| `:Spot` | Open the picker |
| `:SpotFocus` | Focus the picker input |
| `:SpotClose` | Close the picker |
| `:SpotToggle` | Toggle the picker open / closed |

### Recommended keymap

```lua
vim.keymap.set(
"n",
"",
"SpotToggle",
{ desc = "Toggle Spot" }
)
```

### Basic workflow

Typical usage:

```
→ type → confirm
```

Once the picker is open:

- Start typing to search files
- Press `` to confirm selection
- Press `` to normal mode
- Press `q` to close

Picker keymaps:

| Key | Action |
| ------- | ----------------- |
| typing | Filter results |
| `j` | Move down |
| `k` | Move up |
| `` | Confirm selection |
| `` | Normal mode |
| `q` | Close picker |

## 🔀 Prefixes

Spot switches sources using simple prefixes.

Typing a prefix immediately changes the active source.

| Prefix | Source | Status |
| ------ | ---------- | ---------- |
| (none) | `files` | ✅ working |
| `>` | `keymaps` | 🚧 planned |
| `:` | `commands` | 🚧 planned |
| `#` | `buffers` | 🚧 planned |
| `$` | `shell` | 🚧 planned |

The active source is always visible in the title bar.

## ⚙ïļ Configuration

**spot.nvim** works out of the box with sensible defaults.

Call `setup()` once:

```lua
require("spot").setup({
windows = {
width = 80,
max_height = 16,
},

sources = { "files" },
default_source = "files",
})
```

## ðŸĪ Contributing

Spot is under active development, and contributions are welcome.

If you'd like to get involved, please check the
[CONTRIBUTING.md](./CONTRIBUTING.md) guide for details.

Ideas for new sources, bug reports, and small improvements
are always appreciated.

## 📄 License

MIT