Compare commits
2 commits
50937a342f
...
4dc4cdf7e3
| Author | SHA1 | Date | |
|---|---|---|---|
| 4dc4cdf7e3 | |||
|
|
7efb98baab |
2 changed files with 52 additions and 24 deletions
6
.github/workflows/ci.yml
vendored
6
.github/workflows/ci.yml
vendored
|
|
@ -29,11 +29,7 @@ jobs:
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Run stylua
|
- name: Run stylua
|
||||||
uses: JohnnyMorganz/stylua-action@v4.0.0
|
run: npx @johnnymorganz/stylua-bin --check .
|
||||||
with:
|
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
version: latest
|
|
||||||
args: --check .
|
|
||||||
|
|
||||||
cargo-format:
|
cargo-format:
|
||||||
name: Cargo Format
|
name: Cargo Format
|
||||||
|
|
|
||||||
68
README.md
68
README.md
|
|
@ -21,6 +21,7 @@ git clone https://github.com/AdeAttwood/ivy.nvim ~/.config/nvim/pack/bundle/star
|
||||||
### Plugin managers
|
### Plugin managers
|
||||||
|
|
||||||
Using [lazy.nvim](https://github.com/folke/lazy.nvim)
|
Using [lazy.nvim](https://github.com/folke/lazy.nvim)
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
{
|
{
|
||||||
"AdeAttwood/ivy.nvim",
|
"AdeAttwood/ivy.nvim",
|
||||||
|
|
@ -28,6 +29,31 @@ Using [lazy.nvim](https://github.com/folke/lazy.nvim)
|
||||||
},
|
},
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Using [mini.deps](https://github.com/echasnovski/mini.deps)
|
||||||
|
|
||||||
|
```lua
|
||||||
|
local deps = require "mini.deps"
|
||||||
|
deps.later(function() -- Or `deps.now` if you want this to be loaded immediately
|
||||||
|
local build = function(args)
|
||||||
|
local obj = vim
|
||||||
|
.system(
|
||||||
|
{ "cargo", "build", "--release", string.format("%s%s%s", "--manifest-path=", args.path, "/Cargo.toml") },
|
||||||
|
{ text = true }
|
||||||
|
)
|
||||||
|
:wait()
|
||||||
|
vim.print(vim.inspect(obj))
|
||||||
|
end
|
||||||
|
|
||||||
|
deps.add {
|
||||||
|
source = "AdeAttwood/ivy.nvim",
|
||||||
|
hooks = {
|
||||||
|
post_install = build,
|
||||||
|
post_checkout = build,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
end)
|
||||||
|
```
|
||||||
|
|
||||||
TODO: Add more plugin managers
|
TODO: Add more plugin managers
|
||||||
|
|
||||||
### Setup / Configuration
|
### Setup / Configuration
|
||||||
|
|
@ -36,19 +62,19 @@ Ivy can be configured with minimal config that will give you all the defaults
|
||||||
provided by Ivy.
|
provided by Ivy.
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
require('ivy').setup()
|
require("ivy").setup()
|
||||||
```
|
```
|
||||||
|
|
||||||
With Ivy you can configure your own backends.
|
With Ivy you can configure your own backends.
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
require('ivy').setup {
|
require("ivy").setup {
|
||||||
backends = {
|
backends = {
|
||||||
-- A backend module that will be registered
|
-- A backend module that will be registered
|
||||||
"ivy.backends.buffers",
|
"ivy.backends.buffers",
|
||||||
-- Using a table so you can configure a custom keymap overriding the
|
-- Using a table so you can configure a custom keymap overriding the
|
||||||
-- default one.
|
-- default one.
|
||||||
{ "ivy.backends.files", { keymap = "<C-p>" } }
|
{ "ivy.backends.files", { keymap = "<C-p>" } },
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
@ -59,7 +85,7 @@ function, this can be used to load backends before or after the setup function
|
||||||
is called.
|
is called.
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
require('ivy').register_backend("ivy.backends.files")
|
require("ivy").register_backend "ivy.backends.files"
|
||||||
```
|
```
|
||||||
|
|
||||||
### Compiling
|
### Compiling
|
||||||
|
|
@ -117,26 +143,30 @@ customized when you register it.
|
||||||
Action can be run on selected candidates provide functionality
|
Action can be run on selected candidates provide functionality
|
||||||
|
|
||||||
| Action | Key Map | Description |
|
| Action | Key Map | Description |
|
||||||
| -------------- | ----------- | ------------------------------------------------------------------------------ |
|
| ------------------- | --------- | ---------------------------------------------------------------- |
|
||||||
| Complete | \<CR\> |Run the completion function, usually this will be opening a file |
|
| Complete | \<CR\> | Run the completion function, usually this will be opening a file |
|
||||||
| Vertical Split | \<C-v\> |Run the completion function in a new vertical split |
|
| Vertical Split | \<C-v\> | Run the completion function in a new vertical split |
|
||||||
| Split | \<C-s\> |Run the completion function in a new split |
|
| Split | \<C-s\> | Run the completion function in a new split |
|
||||||
| Destroy | \<C-c\> |Close the results window |
|
| Destroy | \<C-c\> | Close the results window |
|
||||||
| Clear | \<C-u\> |Clear the results window |
|
| Clear | \<C-u\> | Clear the results window |
|
||||||
| Delete word | \<C-w\> |Delete the word under the cursor |
|
| Delete word | \<C-w\> | Delete the word under the cursor |
|
||||||
| Next | \<C-n\> |Move to the next candidate |
|
| Next | \<C-n\> | Move to the next candidate |
|
||||||
| Previous | \<C-p\> |Move to the previous candidate |
|
| Previous | \<C-p\> | Move to the previous candidate |
|
||||||
| Next Checkpoint| \<C-M-n\> |Move to the next candidate and keep Ivy open and focussed |
|
| Next Checkpoint | \<C-M-n\> | Move to the next candidate and keep Ivy open and focussed |
|
||||||
| Previous Checkpoint| \<C-M-n\>|Move to the previous candidate and keep Ivy open and focussed |
|
| Previous Checkpoint | \<C-M-n\> | Move to the previous candidate and keep Ivy open and focussed |
|
||||||
|
|
||||||
Add your own keymaps for an action by adding a `ftplugin/ivy.lua` file in your config.
|
Add your own keymaps for an action by adding a `ftplugin/ivy.lua` file in your config.
|
||||||
Just add a simple keymap like this:
|
Just add a simple keymap like this:
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
vim.api.nvim_set_keymap( "n", "<esc>", "<cmd>lua vim.ivy.destroy()<CR>", { noremap = true, silent = true, nowait = true })
|
vim.api.nvim_set_keymap(
|
||||||
|
"n",
|
||||||
|
"<esc>",
|
||||||
|
"<cmd>lua vim.ivy.destroy()<CR>",
|
||||||
|
{ noremap = true, silent = true, nowait = true }
|
||||||
|
)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## API
|
## API
|
||||||
|
|
||||||
### ivy.run
|
### ivy.run
|
||||||
|
|
@ -190,7 +220,9 @@ vertical split action it will open the buffer in a new `vsplit`
|
||||||
end,
|
end,
|
||||||
-- Action callback that will be called on the completion or checkpoint actions.
|
-- Action callback that will be called on the completion or checkpoint actions.
|
||||||
-- The currently selected item is passed in as the result.
|
-- The currently selected item is passed in as the result.
|
||||||
function(result) vim.cmd("edit " .. result) end
|
function(result)
|
||||||
|
vim.cmd("edit " .. result)
|
||||||
|
end
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue