diff --git a/README.md b/README.md index c4b5903..76fe9c4 100644 --- a/README.md +++ b/README.md @@ -1,109 +1,116 @@
# 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) +cargo build --release ``` -If you are missing build dependencies, you can install them via apt. - -```sh -sudo apt-get install build-essential pkg-config cmake -``` +You will need to have the rust toolchain installed. You can find more about +that [here](https://www.rust-lang.org/tools/install) ## 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 | | IvyLines | | Search the lines in the current buffer | ### 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. function(result) vim.cmd("edit " .. result) end ) ``` ## Benchmarks Benchmarks are of various tasks that ivy will do. The purpose of the benchmarks are to give us a baseline on where to start when trying to optimize performance in the matching and sorting, not to put ivy against other tools. When starting to optimize, you will probably need to get a baseline on your hardware. There are fixtures provided that will create the directory structure of the [kubernetes](https://github.com/kubernetes/kubernetes) source code, from somewhere arround commit sha 985c9202ccd250a5fe22c01faf0d8f83d804b9f3. This will create a directory tree of 23511 files a relative large source tree to get a good idea of performance. To create the source tree under `/tmp/ivy-trees/kubernetes` run the following command. This will need to be run for the benchmarks to run. ```bash # Create the source trees bash ./scripts/fixtures.bash # Run the benchmark script luajit ./scripts/benchmark.lua ``` -Current benchmark status with 8 CPU(s) Intel(R) Core(TM) i5-8250U CPU @ 1.60GHz +Current benchmark status running on a `e2-standard-2` 2 vCPU + 8 GB memory VM +running on GCP. + +Rust + +| Name | Total | Adverage | Min | Max | +|--------------------------------|---------------|---------------|---------------|---------------| +| ivy_match(file.lua) 1000000x | 03.961640 (s) | 00.000004 (s) | 00.000003 (s) | 00.002146 (s) | +| ivy_files(kubernetes) 100x | 03.895758 (s) | 00.038958 (s) | 00.034903 (s) | 00.043660 (s) | + +CPP -| Name | Total | Adverage | Min | Max | -| ---------------------------- | ------------- | ------------- | ------------- | ------------- | -| ivy_match(file.lua) 1000000x | 02.353386 (s) | 00.000002 (s) | 00.000002 (s) | 00.000049 (s) | -| ivy_files(kubneties) 100x | 24.809576 (s) | 00.248096 (s) | 00.203167 (s) | 00.270263 (s) | +| Name | Total | Adverage | Min | Max | +|--------------------------------|---------------|---------------|---------------|---------------| +| ivy_match(file.lua) 1000000x | 01.855197 (s) | 00.000002 (s) | 00.000001 (s) | 00.000177 (s) | +| ivy_files(kubernetes) 100x | 14.696396 (s) | 00.146964 (s) | 00.056604 (s) | 00.168478 (s) | ## 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/scripts/benchmark.lua b/scripts/benchmark.lua index 24a1e7a..2f1937b 100644 --- a/scripts/benchmark.lua +++ b/scripts/benchmark.lua @@ -1,48 +1,48 @@ package.path = "lua/?.lua;" .. package.path local libivy = require "ivy.libivy" local benchmark = function(name, n, callback) local status = { running_total = 0, min = 999999999999999999, max = -0000000000000000, } for _ = 1, n do local start_time = os.clock() callback() local running_time = os.clock() - start_time status.running_total = status.running_total + running_time if status.min > running_time then status.min = running_time end if status.max < running_time then status.max = running_time end end print( string.format( "| %-30s | %09.6f (s) | %09.6f (s) | %09.6f (s) | %09.6f (s) |", name, status.running_total, status.running_total / n, status.min, status.max ) ) end print "| Name | Total | Adverage | Min | Max |" print "|--------------------------------|---------------|---------------|---------------|---------------|" benchmark("ivy_match(file.lua) 1000000x", 1000000, function() libivy.ivy_match("file.lua", "some/long/path/to/file/file.lua") end) libivy.ivy_init "/tmp/ivy-trees/kubernetes" -benchmark("ivy_files(kubneties) 100x", 100, function() +benchmark("ivy_files(kubernetes) 100x", 100, function() libivy.ivy_files("file.go", "/tmp/ivy-trees/kubernetes") end)