Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theblob42/simple-repl.nvim
A simple REPL utility for Neovim
https://github.com/theblob42/simple-repl.nvim
clojure nvim repl
Last synced: 5 days ago
JSON representation
A simple REPL utility for Neovim
- Host: GitHub
- URL: https://github.com/theblob42/simple-repl.nvim
- Owner: TheBlob42
- License: gpl-3.0
- Created: 2024-06-07T16:07:11.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-11T14:16:18.000Z (22 days ago)
- Last Synced: 2024-09-28T17:22:01.833Z (5 days ago)
- Topics: clojure, nvim, repl
- Language: Lua
- Homepage:
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Simple REPL
Simple utility for interacting with any REPL inside Neovim
- Starting a new or opening an existing REPL using the embedded [terminal emulator](http://neovim.io/doc/user/nvim_terminal_emulator.html)
- Send arbitrary text to your REPL from anywhere
- Peek at the latest result even when the REPL is currently not visible in any window
## Installation
> The plugin was implemented and tested with Neovim version `0.10.0`
Use your preferred way of managing plugins to install `simple-repl.nvim`
```lua
-- using https://github.com/folke/lazy.nvim
require('lazy').setup({
'theblob42/simple-repl'
-- your other plugins [...]
})
```
The plugin will not perform any automatic setup for you. There is also no `setup` function you have to call before using it. You just have to come up with your own keybindings using the provided functions. See the [usage](#usage) section or jump into the `./examples`
## Usage
> For a more in-depth example have a look into `./examples/clojure.lua` for a "complete" Clojure setup
Create a new REPL or re-open an existing one using the `open_repl` function:
```lua
-- creating a new REPL for Clojure using the 'clj' command in the current project directory
require('simple-repl').open_repl('TestREPL', {
create = {
cmd = 'clj',
path = vim.fs.root(0, 'deps.edn')
}
})
```
Now we can use the `send_to_repl` function to send arbitrary text to our "TestREPL":
```lua
require('simple-repl').send_to_repl('TestREPL', { '(+ 1 2)' })
```
Usually we would like to have some keybindings for easily sending a visual selection or an operator movement to the REPL. For this you can use the `v_send_to_repl` and `op_send_to_repl` helper functions:
```lua
local r = require('simple-repl')
-- sending text using a VIM motion
vim.keymap.set('n', 'leaders', function()
r.op_send_to_repl('TestREPL')
end)
-- sending the current visual selection
vim.keymap.set('x', 's', function()
r.v_send_to_repl('TestREPL')
end)
```
Use Treesitter to easily extract exactly the code that you want to send to the REPL. There are some helper functions in `lua/simple-repl/tree.lua` which you can use directly or as inspiration for your own custom ones:
```lua
local ts = require('simple-repl.tree')
-- send the current top level form
vim.keymap.set('n', 'S', function()
local lines = ts.find_node_by_parent('source', true)
M.send_to_repl('TestREPL', lines)
end)
```
For more information also check the help files `:help simple-repl` which provide further information about all available functions, their parameters and all available configuration options
## References
- [conjure.nvim](https://github.com/Olical/conjure)
- [repl.nvim](https://github.com/HiPhish/repl.nvim)
- [vim-slime](https://github.com/jpalardy/vim-slime)