diff --git a/README.md b/README.md index 11ec7df..fae7b8b 100644 --- a/README.md +++ b/README.md @@ -1,76 +1,78 @@
# ivy.nvim An [ivy-mode](https://github.com/abo-abo/swiper#ivy) port to neovim. Ivy is a generic completion mechanism for ~~Emacs~~ Nvim
## Installation ### Manually ```sh git clone https://github.com/AdeAttwood/ivy.nvim ~/.config/nvim/pack/bundle/start/ivy.nvim ``` ### Plugin managers TODO: Add docs in the plugin managers I don't use any ### Compiling For the native searching, you will need to compile the shard library. You can do that by running the below command in the root of the plugin. ```sh cmake -DCMAKE_BUILD_TYPE=Release -B build/Release && (cd build/Release; make -j) ``` If you are missing build dependencies, you can install them via apt. ```sh sudo apt-get install build-essential pkg-config cmake ``` ## Features ### Commands A command can be run that will launch the completion UI | Command | Key Map | Description | | ---------- | ----------- | ------------------------------------------------------ | | IvyFd | \p | Find files in your project with the fd cli file finder | | IvyAg | \/ | Find content in files using the silver searcher | | IvyBuffers | \b | Search though open buffers | ### Actions Action can be run on selected candidates provide functionality | Action | Description | | -------- | ------------------------------------------------------------------------------ | | Complete | Run the completion function, usually this will be opening a file | | Peek | Run the completion function on a selection, but don't close the results window | ## API ```lua vim.ivy.run( + -- The name given to the results window and displayed to the user + "Title", -- Call back function to get all the candidates that will be displayed in -- the results window, The `input` will be passed in, so you can filter -- your results with the value from the prompt function(input) return { "One", "Two", Three } end, -- Action callback that will be called on the completion or peek 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 ) ``` ## Other stuff you might like - [ivy-mode](https://github.com/abo-abo/swiper#ivy) - An emacs package that was the inspiration for this nvim plugin - [Command-T](https://github.com/wincent/command-t) - Vim plugin I used before I started this one - [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) - Another competition plugin, lots of people are using diff --git a/lua/ivy/controller.lua b/lua/ivy/controller.lua index 8412dce..b1dd66f 100644 --- a/lua/ivy/controller.lua +++ b/lua/ivy/controller.lua @@ -1,62 +1,63 @@ local window = require "ivy.window" local prompt = require "ivy.prompt" local controller = {} controller.items = nil controller.callback = nil -controller.run = function(items, callback) +controller.run = function(name, items, callback) controller.callback = callback controller.items = items window.initialize() window.set_items { "-- Loading ---" } + vim.api.nvim_buf_set_name(window.get_buffer(), name) controller.input "" end controller.input = function(char) prompt.input(char) vim.schedule(function() window.set_items(controller.items(prompt.text())) end) end controller.search = function(value) prompt.set(value) vim.schedule(function() window.set_items(controller.items(prompt.text())) end) end controller.complete = function() controller.checkpoint() controller.destroy() end controller.checkpoint = function() vim.api.nvim_set_current_win(window.previous) controller.callback(window.get_current_selection()) vim.api.nvim_set_current_win(window.window) end controller.next = function() window.index = window.index + 1 window.update() end controller.previous = function() window.index = window.index - 1 window.update() end controller.destroy = function() controller.items = nil controller.callback = nil window.destroy() prompt.destroy() end return controller diff --git a/plugin/ivy.lua b/plugin/ivy.lua index b2bd595..92f22f6 100644 --- a/plugin/ivy.lua +++ b/plugin/ivy.lua @@ -1,47 +1,47 @@ local controller = require "ivy.controller" local utils = require "ivy.utils" local libivy = require "ivy.libivy" -- Put the controller in to the vim global so we can access it in mappings -- better without requires. You can call controller commands like `vim.ivy.xxx`. vim.ivy = controller vim.api.nvim_create_user_command("IvyAg", function() - vim.ivy.run(utils.command_finder "ag", utils.vimgrep_action()) + vim.ivy.run("AG", utils.command_finder "ag", utils.vimgrep_action()) end, { bang = true, desc = "Run ag to search for content in files" }) vim.api.nvim_create_user_command("IvyFd", function() - vim.ivy.run(function(term) + vim.ivy.run("Files", function(term) return libivy.ivy_files(term, vim.fn.getcwd()) end, utils.file_action()) end, { bang = true, desc = "Find files in the project" }) vim.api.nvim_create_user_command("IvyBuffers", function() - vim.ivy.run(function(input) + vim.ivy.run("Buffers", function(input) local list = {} local buffers = vim.api.nvim_list_bufs() for index = 1, #buffers do local buffer = buffers[index] -- Get the relative path from the current working directory. We need to -- substring +2 to remove the `/` from the start of the path to give us a -- true relative path local buffer_name = vim.api.nvim_buf_get_name(buffer):sub(#vim.fn.getcwd() + 2, -1) if vim.api.nvim_buf_is_loaded(buffer) and #buffer_name > 0 then local score = libivy.ivy_match(input, buffer_name) if score > -200 or #input == 0 then table.insert(list, { score, buffer_name }) end end end table.sort(list, function(a, b) return a[1] < b[1] end) return list end, utils.file_action()) end, { bang = true, desc = "List all of the current open buffers" }) vim.api.nvim_set_keymap("n", "b", "IvyBuffers", { nowait = true, silent = true }) vim.api.nvim_set_keymap("n", "p", "IvyFd", { nowait = true, silent = true }) vim.api.nvim_set_keymap("n", "/", "IvyAg", { nowait = true, silent = true })