milanglacier/yarepl.nvim

github github
code-runner
stars 79
issues 4
subscribers 3
forks 2
CREATED

2023-06-03

UPDATED

6 months ago


yarepl.nvim

Yet Another REPL is a flexible REPL (Read-Eval-Print Loop) management tool that supports multiple paradigms for interacting with REPLs. It offers project-level configurations, works with tmux, integrates with Telescope, and provides a native dot repeat feature, without requiring vim-repeat.

What is yarepl.nvim?

Yarepl.nvim is a powerful and flexible REPL (Read-Eval-Print-Loop) management plugin for Neovim. It simplifies the process of interacting with a REPL and text buffer, making tasks such as sending and managing text and REPL buffers effortless.

Flexibility and parallelism are top priority. With yarepl.nvim, you can easily interact with multiple REPLs using various paradigms, such as sending text from multiple buffers to a single REPL, sending text from a single buffer to multiple REPLs, and sending text to a specific type of REPL. Plus, it offers native dot repeat functionality without requiring vim-repeat.

Why yarepl.nvim?

As a data scientist, talking with different REPLs is an essentail part of my workflow. I almost spending lifes in communicating with various REPLs, like R, Python, and Bash.

With multiple projects at hand, I require the ability to send text from different files to REPLs with the same type (such as multiple ipython REPLs).

In instances where I'm performing time-consuming tasks, but need to conduct further experimentation on the current file, I also require the capability to send text from the same buffer to multiple REPLs.

Furthermore, when conducting mixed-language programming in a literate programming style in text format such as rmarkdown, quarto, or plain markdown, I need to send text in the buffer to different REPLs such as R and Python .

As a CLI fnatic, to communicate with chatgpt, I prefer through a REPL aichat. Additionally, I require a set of global hotkeys and an isolated REPL environment to facilitate communication with 'aichat' separately without any interference with other REPLs.

Unfortunately, currently available REPL plugins do not afford me such great flexibility in managing REPL in multiple ways. This is why 'yarepl.nvim' was created.

Installation

nvim 0.9 is required. Although nvim 0.8 may also work, there are no plans to ensure backward compatibility with nvim 0.8 if there are any compatibility issues.

packer.nvim:

use { 'milanglacier/yarepl.nvim' }

lazy.nvim:

{ 'milanglacier/yarepl.nvim', config = true }

yarepl.nvim does not require any dependencies but functions better with the following plugins:

  1. telescope.nvim. yarepl.nvim provides a telescope extension for REPL previewer.

  2. A UI frontend that provides an alternative frontend for vim.ui.select. Some options are dressing.nvim or telescope-ui-select.nvim (only one of them needs to be installed).

Configuration

Setup

-- below is the default configuration, there's no need to copy paste them if
-- you are satisfied with the default configuration, just calling
-- `require('yarepl').setup {}` is sufficient.
local yarepl = require 'yarepl'

yarepl.setup {
    -- see `:h buflisted`, whether the REPL buffer should be buflisted.
    buflisted = true,
    -- whether the REPL buffer should be a scratch buffer.
    scratch = true,
    -- the filetype of the REPL buffer created by `yarepl`
    ft = 'REPL',
    -- How yarepl open the REPL window, can be a string or a lua function.
    -- See below example for how to configure this option
    wincmd = 'belowright 15 split',
    -- The available REPL palattes that `yarepl` can create REPL based on
    metas = {
        aichat = { cmd = 'aichat', formatter = yarepl.formatter.bracketed_pasting },
        radian = { cmd = 'radian', formatter = yarepl.formatter.bracketed_pasting },
        ipython = { cmd = 'ipython', formatter = yarepl.formatter.bracketed_pasting },
        python = { cmd = 'python', formatter = yarepl.formatter.trim_empty_lines },
        R = { cmd = 'R', formatter = yarepl.formatter.trim_empty_lines },
        bash = { cmd = 'bash', formatter = yarepl.formatter.trim_empty_lines },
        zsh = { cmd = 'zsh', formatter = yarepl.formatter.bracketed_pasting },
    },
    -- when a REPL process exits, should the window associated with those REPLs closed?
    close_on_exit = true,
    -- whether automatically scroll to the bottom of the REPL window after sending
    -- text? This feature would be helpful if you want to ensure that your view
    -- stays updated with the latest REPL output.
    scroll_to_bottom_after_sending = true,
    os = {
        -- Some hacks for Windows. macOS and Linux users can simply ignore
        -- them. The default options are recommended for Windows user.
        windows = {
            -- Send a final `\r` to the REPL with delay,
            send_delayed_cr_after_sending = true,
        },
    },
}

Commands

yarepl doesn't provide any keybindings. Instead, it offers a variety of commands that you can use to create your own keybindings. We'll also provide an example configuration for keybindings based on these commands.

Here is a list of available commands:

REPLStart

Creates a REPL with id i from the list of available REPLs.

You can create a REPL with a specific id by providing a count, such as 3REPLStart for a REPL with id 3. If no count is provided, REPL 1 will be created. You can also provide a name as an argument. If no argument is given, you'll be prompted to select a REPL from the list of available ones. If the id is already in use, it will focus on the REPL with that id. If you append a ! to the command, the current buffer will attach to the newly created REPL, for instance, REPLStart! or 3REPLStart!. Note that attachment only happens when a new REPL is created.

REPLAttachBufferToREPL

Attaches the current buffer to REPL i, for instance, 3REPLAttachBufferToREPL will attach the current buffer to REPL 3. If no count is provided, you'll be prompted to select the REPL you want to attach the current buffer to. If you add a trailing !, it will attempt to detach the current buffer from any REPL.

REPLDetachBufferToREPL

Detach current buffer from any REPL.

REPLCleanup

Cleans up any invalid REPLs and rearranges the sequence of REPL ids. Usually, there's no need to use this command manually since invalid REPLs are cleaned up automatically at the appropriate time.

REPLFocus

Focuses on REPL i or the REPL that the current buffer is attached to.

You can provide an optional argument, and the function will attempt to focus on the closest REPL with the specified name. If no count is supplied, it will try to focus on the REPL that the current buffer is attached to. If the current buffer isn't attached to any REPL, it will use REPL 1. If you add a count i, it will focus on the REPL i.

Here are some examples of how to use this command:

  1. REPLFocus will try to focus on the REPL that the current buffer is attached to. If the current buffer isn't attached to any REPL, it will use REPL 1.

  2. REPLFocus ipython will try to focus on the closest REPL with the name ipython starting from id 1.

  3. 3REPLFocus will focus on REPL 3.

  4. 3REPLFocus ipython will try to focus on the closest REPL with the name ipython starting from id 3.

REPLHide

Hides REPL i or the REPL that the current buffer is attached to.

If you provide an optional argument, the function will attempt to hide the closest REPL with the specified name. When no count is supplied, it will try to hide the REPL that the current buffer is attached to. If the current buffer isn't attached to any REPL, it will use REPL 1. If you add a count i, it will hide REPL i.

Here are examples of how to use this command:

  1. REPLHide will try to hide the REPL that the current buffer is attached to. If the current buffer isn't attached to any REPL, it will use REPL 1.

  2. REPLHide ipython will try to hide the closest REPL with the name ipython starting from id 1.

  3. 3REPLHide will hide REPL 3.

  4. 3REPLHide ipython will try to hide the closest REPL with the name ipython starting from id 3.

REPLHideOrFocus

Hides or focuses on REPL i or the REPL that the current buffer is attached to.

If you provide an optional argument, the function will attempt to hide or focus on the closest REPL with the specified name. When no count is supplied, it will try to hide or focus on the REPL that the current buffer is attached to. If the current buffer isn't attached to any REPL, it will use REPL 1. If you add a count i, it will hide REPL i.

Here are examples of how to use this command:

  1. REPLHideOrFocus will try to hide or focus on the REPL that the current buffer is attached to. If the current buffer isn't attached to any REPL, it will use REPL 1.

  2. REPLHideOrFocus ipython will try to hide or focus on the closest REPL with the name ipython starting from id 1.

  3. 3REPLHideOrFocus will hide or focus on REPL 3.

  4. 3REPLHideOrFocus ipython will try to hide or focus on the closest REPL with the name ipython starting from id 3.

REPLClose

Closes REPL i or the REPL that the current buffer is attached to.

If you provide an optional argument, the function will attempt to close the closest REPL with the specified name. If no count is supplied, it will try to close the REPL that the current buffer is attached to. If the current buffer isn't attached to any REPL, it will use REPL 1. If you add a count i, it will close REPL i.

Here are examples of how to use this command:

  1. REPLClose will try to close the REPL that the current buffer is attached to. If the current buffer isn't attached to any REPL, it will use REPL 1.

  2. REPLClose ipython will try to close the closest REPL with the name ipython and starting from id 1.

  3. 3REPLClose will close REPL 3.

  4. 3REPLClose ipython will try to close the closest REPL with the name ipython starting from id 3.

REPLSwap

Swaps two REPLs. If no REPL ID is provided, you'll be prompted to select both REPLs. If you provide one REPL ID, you'll be prompted to select the second REPL.

REPLSendVisual

Sends the visual range to REPL i or the REPL that the current buffer is attached to.

If you provide an optional argument, the function will attempt to send to the closest REPL with the specified name. If no count is supplied, it will try to send to the REPL that the current buffer is attached to. If the current buffer isn't attached to any REPL, it will use REPL 1. If you add a count i, it will send to REPL i.

Here are examples of how to use this command:

  1. REPLSendVisual sends the visual range to the REPL that the current buffer is attached to. If the buffer is not attached to any REPL, it uses REPL 1.

  2. 3REPLSendVisual sends the visual range to REPL 3.

  3. REPLSendVisual ipython sends the visual range to the closest ipython REPL relative to id 1.

  4. 3REPLSendVisual ipython sends the visual range to the closest ipython REPL relative to id 3.

Note that due to a limitation of vim, when using REPLSendVisual via cmdline rather than in a keymap, you must press Control+u before using the command. For example, V3j:<Control+u>3REPLSendVisual sends the selected three lines to REPL 3. However, you do not need to specify Control+u in your keymap as the function will do this for you.

REPLSendLine

Sends current line to REPL i or the REPL that current buffer is attached to.

If you provide an optional argument, the function will attempt to send to the closest REPL with the specified name. If no count is supplied, it will try to send to the REPL that the current buffer is attached to. If the current buffer isn't attached to any REPL, it will use REPL 1. If you add a count i, it will send to REPL i.

Here are examples of how to use this command:

  1. REPLSendLine sends the current line to the REPL that the current buffer is attached to. If the buffer is not attached to any REPL, it uses REPL 1.

  2. 3REPLSendLine sends the current line to REPL 3.

  3. REPLSendLine ipython sends the current line to the closest ipython REPL relative to id 1.

  4. 3REPLSendLine ipython sends the current line to the closest ipython REPL relative to id 3.

REPLSendOperator

The opeerator to send the text to REPL i or the REPL that the current buffer is attached to.

If you provide an optional argument, the function will attempt to send to the closest REPL with the specified name. If no count is supplied, it will try to send to the REPL that the current buffer is attached to. If the current buffer isn't attached to any REPL, it will use REPL 1. If you add a count i, it will send to REPL i.

Here are examples of how to use this command:

  1. REPLSendOperator acts as the operator to send the text to the REPL that the current buffer is attached to. If the buffer is not attached to any REPL, it uses REPL 1.

  2. 3REPLSendOperator sends the motion to REPL 3.

  3. REPLSendOperator ipython sends the motion to the closest ipython REPL relative to id 1.

  4. 3REPLSendOperator ipython sends the motion to the closest ipython REPL relative to id 3.

REPLSendOperator is dot-repeatable, you do not need to install vim-repeat to make it work.

REPLExec

Sends the command typed in the cmdline to REPL i or the REPL that the current buffer is attached to.

If the first argument of this command is $NAME, the function will attempt to send to the closest REPL with the specified NAME. If no count is supplied, it will try to send to the REPL that the current buffer is attached to. If the current buffer isn't attached to any REPL, it will use REPL 1. If you add a count i, it will send to REPL i.

Here are examples of how to use this command:

  1. REPLExec %run a_file.py will send the command %run a_file.py to the REPL 1.

  2. 3REPLExec print("hello world") will send the command print("hello world") to the REPL 3.

  3. REPLExec $ipython %whos will send the command %whos to the closest ipython REPL relative to id 1.

  4. REPLExec $ipython %whos will send the command %whos to the closest ipython REPL relative to id 3.

  5. REPLExec print("hello world")^Mprint("hello world again") will send the following two lines to the REPL current buffer is attached to or REPL 1.

print("hello world")
print("hello world again")

Note:

  1. To type a literal <Enter> (^M) in cmdline, you must press <Ctrl-v> <Enter> rather than directly type Enter.

  2. Some neovim command will interpolate % to the file name of current buffer. But REPLExec will not do this for you. The interpolation only happens for the first $ to get the desired REPL name.

Window configuration

if wincmd is a string, yarepl will execute it as a vimscript command.

wincmd = 'belowright 15 split'
-- will create a horizontal split below the current using window and takes up 15 lines for the new window
wincmd = 'vertical 30 split'
-- will create a vertical split right to the current using window and takes up 30 columns for the new window

In addition to passing a string to wincmd, you can also pass a Lua function. This function accepts two parameters: the buffer number of the REPL buffer, and the name of the REPL (the keys of metas).

wincmd = function(bufnr, name)
    if name == 'ipython' then
        vim.api.nvim_open_win(bufnr, true, {
            relative = 'editor',
            row = math.floor(vim.o.lines * 0.25),
            col = math.floor(vim.o.columns * 0.25),
            width = math.floor(vim.o.columns * 0.5),
            height = math.floor(vim.o.lines * 0.5),
            style = 'minimal',
            title = name,
            border = 'rounded',
            title_pos = 'center',
        })
    else
        vim.cmd [[belowright 15 split]]
        vim.api.nvim_set_current_buf(bufnr)
    end
end

This function checks if the REPL buffer has the name ipython. If it does, it creates a floating window at the center of the Vim screen with specific size and styling. If not, it creates a horizontal split below the current window and takes up 15 lines for the new window.

Add your own REPLs

You can add your own REPL meta by following this example:

function send_line_verbatim(lines)
    -- each line is a string
    return lines
end

function ipython_or_python()
    if vim.fn.executable 'ipython' == 1 then
        return { 'ipython', '--simple-prompt' }
    else
        return 'python'
    end
end

function ipython_or_python_formatter(lines)
    if vim.fn.executable 'ipython' == 1 then
        return yarepl.formatter.bracketed_pasting(lines)
    else
        return yarepl.formatter.trim_empty_lines(lines)
    end
end

metas = {
    ipython_new = { cmd = { 'ipython', '--simple-prompt' }, formatter = send_line_verbatim },
    ipython_or_python = { cmd = ipython_or_python, formatter = ipython_or_python_formatter },
}

-- cmd can be three types: a string, a list of strings, or a function that
-- returns either a string or list of strings.

-- formatter is a function takes a list of string as an argument and returns a
-- list of strings.

Here is a more complex example for ghci, a haskell repl.

Some REPLs can distinguish between pasted text and text from the user manual input by using prefix and suffix sequences, such as bracketed paste.

For modern REPLs with bracketed pasting support (which is usually the case), it is recommended to use yarepl.formatter.bracketed_pasting.

Here are some tips for writing your own formatter function:

  1. You may want to add a new entry "\r" at the end of the list to indicate the end of input.

  2. If your REPL cannot distinguish between copy-pasted text and text from user manual input, you may want to replace \t with 4 or 8 spaces since sending a raw \t may be interpreted as invoking completion.

  3. Do not include \n in any line as the chansend function will automatically replace it with \0.

  4. You may want to remove any empty lines from the input (a list of strings) since chansend function translates an empty string "" into "\n". For some REPLs without bracketed pasting support (such as Python), a plain "\n" may be treated as the end of input, blocking the rest of the code in the same function.

  5. If your REPL cannot distinguish between copy-pasted text and text from user manual input and your REPL will do auto-indent for you, you may want to remove any leading spaces from each line to prevent double indentation.

  6. The returned list of strings will be sent to the chansend function for reference.

There's a yarepl helper function that allows you to quickly build a formatter function without having to write everything from scratch.

-- Calling this function will return a function that takes a list of strings as
-- input and returns a list of strings. This can be used as the formatter function
-- of meta.

-- these are the default config
yarepl.formatter.factory {
    -- Specifies whether to return tabs in the string as spaces.
    replace_tab_by_space = false,
    -- Specifies the number of spaces to replace the tab (if enabled).
    number_of_spaces_to_replace_tab = 8,
    -- For a list of strings containing more than one string:
    when_multi_lines = {
        -- The prefixing code sent to the repl firstly.
        open_code = '',
        -- The suffixing code sent to the repl finally.
        end_code = '\r',
        -- Whether to remove empty lines from the list of strings.
        trim_empty_lines = false,
        -- Whether to remove leading spaces at the beginning of each line.
        remove_leading_spaces = false,
        -- If gsub_pattern and gsub_repl are not empty, `string.gsub` will
        -- be called with `gsub_pattern` and `gsub_repl` on each line. Note
        -- that you should use Lua pattern instead of Vim regex pattern.
        -- The gsub calls happen after `trim_empty_lines`,
        -- `remove_leading_spaces`, and `replace_tab_by_space`, and before
        -- prepending and appending `open_code` and `end_code`.
        gsub_pattern = '',
        gsub_repl = '',
    },
    -- For a list containing only one string:
    when_single_line = {
        -- The prefixing code sent to the repl firstly.
        open_code = '',
        -- The suffixing code sent to the repl finally.
        end_code = '\r',
        -- the same as the specs of `when_multi_lines`
        gsub_pattern = '',
        gsub_repl = '',
    },
    os = {
        -- Some hacks for Windows. macOS and Linux users can simply ignore
        -- them. The default options are recommended for Windows user.
        windows = {
            -- Join the lines with `\r` before sending to REPL.
            join_lines_with_cr = true,
        },
    },
}

-- `yarepl` provides two default formatters, which can be constructed by
-- calling `yarepl.formatter.factory` with different arguments, like this:

yarepl.formatter.trim_empty_lines = yarepl.formatter.factory {
    when_multi_lines = {
        trim_empty_lines = true,
        remove_leading_spaces = false,
    },
}

yarepl.formatter.bracketed_pasting = yarepl.formatter.factory {
    when_multi_lines = {
        open_code = '\27[200~',
        end_code = '\27[201~\r',
        trim_empty_lines = false,
        remove_leading_spaces = false,
    },
}

Example keybinding setup

Here is the keybindings setup from the maintainer:

-- The `run_cmd_with_count` function enables a user to execute a command with
-- count values in keymaps. This is particularly useful for `yarepl.nvim`,
-- which heavily uses count values as the identifier for REPL IDs.
local function run_cmd_with_count(cmd)
    return function()
        vim.cmd(string.format('%d%s', vim.v.count, cmd))
    end
end

-- The `partial_cmd_with_count_expr` function enables users to enter partially
-- complete commands with a count value, and specify where the cursor should be
-- placed. This function is mainly designed to bind `REPLExec` command into a
-- keymap.
local function partial_cmd_with_count_expr(cmd)
    return function()
        -- <C-U> is equivalent to \21, we want to clear the range before next input
        -- to ensure the count is recognized correctly.
        return ':\21' .. vim.v.count .. cmd
    end
end

local keymap = vim.api.nvim_set_keymap
local bufmap = vim.api.nvim_buf_set_keymap
local autocmd = vim.api.nvim_create_autocmd

-- <Leader>cs will be equivalent to `REPLStart aichat`
-- 2<Leader>cs will be equivalent to `2REPLStart aichat`, etc.
keymap('n', '<Leader>cs', '', {
    callback = run_cmd_with_count 'REPLStart aichat',
    desc = 'Start an Aichat REPL',
})
-- <Leader>cf will be equivalent to `REPLFocus aichat`
-- 2<Leader>cf will be equivalent to `2REPLFocus aichat`, etc.
keymap('n', '<Leader>cf', '', {
    callback = run_cmd_with_count 'REPLFocus aichat',
    desc = 'Focus on Aichat REPL',
})
keymap('n', '<Leader>ch', '', {
    callback = run_cmd_with_count 'REPLHide aichat',
    desc = 'Hide Aichat REPL',
})
keymap('v', '<Leader>cr', '', {
    callback = run_cmd_with_count 'REPLSendVisual aichat',
    desc = 'Send visual region to Aichat',
})
keymap('n', '<Leader>crr', '', {
    callback = run_cmd_with_count 'REPLSendLine aichat',
    desc = 'Send current line to Aichat',
})
-- `<Leader>crap` will send a paragraph to the first aichat REPL.
-- `2<Leader>crap` will send a paragraph to the second aichat REPL. Note that
-- `ap` is just an example and can be replaced with any text object or motion.
keymap('n', '<Leader>cr', '', {
    callback = run_cmd_with_count 'REPLSendOperator aichat',
    desc = 'Operator to Send text to Aichat',
})
keymap('n', '<Leader>cq', '', {
    callback = run_cmd_with_count 'REPLClose aichat',
    desc = 'Quit Aichat',
})
keymap('n', '<Leader>cc', '<CMD>REPLCleanup<CR>', {
    desc = 'Clear aichat REPLs.',
})

-- `<Leader>ce How to current win id in neovim?`: This keymap executes a
-- command in `aichat` with the specified count value.
keymap('n', '<Leader>ce', '', {
    callback = partial_cmd_with_count_expr 'REPLExec $aichat ',
    desc = 'Execute command in aichat',
    expr = true,
})

local ft_to_repl = {
    r = 'radian',
    rmd = 'radian',
    quarto = 'radian',
    markdown = 'radian',
    ['markdown.pandoc'] = 'radian',
    python = 'ipython',
    sh = 'bash',
    REPL = '',
}

autocmd('FileType', {
    pattern = { 'quarto', 'markdown', 'markdown.pandoc', 'rmd', 'python', 'sh', 'REPL' },
    desc = 'set up REPL keymap',
    callback = function()
        local repl = ft_to_repl[vim.bo.filetype]
        bufmap(0, 'n', '<LocalLeader>rs', '', {
            callback = run_cmd_with_count('REPLStart ' .. repl),
            desc = 'Start an REPL',
        })
        bufmap(0, 'n', '<LocalLeader>rf', '', {
            callback = run_cmd_with_count 'REPLFocus',
            desc = 'Focus on REPL',
        })
        bufmap(0, 'n', '<LocalLeader>rv', '<CMD>Telescope REPLShow<CR>', {
            desc = 'View REPLs in telescope',
        })
        bufmap(0, 'n', '<LocalLeader>rh', '', {
            callback = run_cmd_with_count 'REPLHide',
            desc = 'Hide REPL',
        })
        bufmap(0, 'v', '<LocalLeader>s', '', {
            callback = run_cmd_with_count 'REPLSendVisual',
            desc = 'Send visual region to REPL',
        })
        bufmap(0, 'n', '<LocalLeader>ss', '', {
            callback = run_cmd_with_count 'REPLSendLine',
            desc = 'Send current line to REPL',
        })
        -- `<LocalLeader>sap` will send the current paragraph to the
        -- buffer-attached REPL, or REPL 1 if there is no REPL attached.
        -- `2<Leader>sap` will send the paragraph to REPL 2. Note that `ap` is
        -- just an example and can be replaced with any text object or motion.
        bufmap(0, 'n', '<LocalLeader>s', '', {
            callback = run_cmd_with_count 'REPLSendOperator',
            desc = 'Operator to send to REPL',
        })
        bufmap(0, 'n', '<LocalLeader>rq', '', {
            callback = run_cmd_with_count 'REPLClose',
            desc = 'Quit REPL',
        })
        bufmap(0, 'n', '<LocalLeader>rc', '<CMD>REPLCleanup<CR>', {
            desc = 'Clear REPLs.',
        })
        bufmap(0, 'n', '<LocalLeader>rS', '<CMD>REPLSwap<CR>', {
            desc = 'Swap REPLs.',
        })
        bufmap(0, 'n', '<LocalLeader>r?', '', {
            callback = run_cmd_with_count 'REPLStart',
            desc = 'Start an REPL from available REPL metas',
        })
        bufmap(0, 'n', '<LocalLeader>ra', '<CMD>REPLAttachBufferToREPL<CR>', {
            desc = 'Attach current buffer to a REPL',
        })
        bufmap(0, 'n', '<LocalLeader>rd', '<CMD>REPLDetachBufferToREPL<CR>', {
            desc = 'Detach current buffer to any REPL',
        })
        -- `3<LocalLeader>re df.describe()`: This keymap executes the specified
        -- command in REPL 3.
        bufmap(0, 'n', '<LocalLeader>re', '', {
            callback = partial_cmd_with_count_expr 'REPLExec ',
            desc = 'Execute command in REPL',
            expr = true,
        })
    end,
})

The run_cmd_with_count function ensures that any numeric prefix given to a keybinding, such as 3<LocalLeader>rs, 2<LocalLeader>s, and 5<Leader>cr, is passed to the corresponding command. For instance, 2REPLStart aichat is equivalent to 2<Leader>cs, and 3REPLSendOperator is equivalent to 3<LocalLeader>s.

With the keybinding setup, prefixing keybindings with <Leader>c ensures that the text is always sent to the aichat REPL, a REPL for chatgpt. The maintainer requires a global hotkey for easily talking with chatgpt.

For maximum flexibility with other programming languages, the maintainer desires the ability to easily switch between two modes:

  1. Sending text from multiple files to a REPL via 2<LocalLeader>s, regardless of which buffer the maintainer is visiting. This guarantees that the text is always sent to RPEL 2.

  2. Sending text to a dedicated REPL for each buffer. To avoid the hassle of remembering the exact ID associated with the desired REPL, the maintainer can use <LocalLeader>ra to attach the current buffer to a REPL. Subsequently, the <LocalLeader>s key can be directly used to send the text to the desired REPL.

Telescope Integration

yarepl has integrated with Telescope and can be enabled by adding the following line to your config:

require('telescope').load_extension 'REPLShow'

Once added, you can use Telescope REPLShow to preview the active REPL buffers. If you are using the default Telescope configuration, <C-t> opens a new tab for the selected REPL, <C-v> generates a vertical split window for the chosen REPL, and <C-x> creates a horizontal split window for your selected REPL.

Set up project-level REPLs

You may want to have the ability to control the REPL metas at the project level. For example, you may want to open ipython installed in a conda environment for one project and a different ipython installed in another conda environment for another project.

One way to achieve this is to:

  • Enable the built-in exrc, which requires nvim 0.9 for security reasons.

To enable exrc, add the following line to your Neovim config:

vim.o.exrc = 1

Then, configure yarepl like so:

vim.g.yarepl_ipython_paths = vim.g.yarepl_ipython_paths or {}
local yarepl = require 'yarepl'

require('yarepl').setup {
    metas = {
        ipython = {
            cmd = function()
                local cwd = vim.fn.getcwd()
                if vim.g.yarepl_ipython_paths and vim.g.yarepl_ipython_paths[cwd] then
                    return vim.g.yarepl_ipython_paths[cwd]
                else
                    return 'ipython'
                end
            end,
        },
    },
}

Now, in the project root directory ~/projects/project1, create a file called .nvim.lua with the following lines:

local cwd = vim.fn.getcwd()

if vim.g.yarepl_ipython_paths then
    vim.g.yarepl_ipython_paths[cwd] = '~/mambaforge/envs/a-conda-env/bin/ipython'
else
    vim.g.yarepl_ipython_paths = {
        [cwd] = '~/mambaforge/envs/a-conda-env/bin/ipython',
    }
end

The first time you open project1, Neovim will prompt you to decide whether you want to load the .nvim.lua file. Please allow it.

Note: The .nvim.lua file will be automatically loaded only once when Neovim starts. Thus, if you switch working directories during the time Neovim is running, the .nvim.lua file won't be loaded at the new working directory. To manually load the .nvim.lua file after switching to a new working directory, try :luafile .nvim.lua.

Create persistent REPLs in tmux

If you would like to maintain a persistent REPL process even after exiting neovim, you can utilize tmux. To achieve this, the following configuration creates a REPL meta named ipy_tmux that attaches to a tmux session named ipython. If the session does not exist, a new tmux session named ipython is created, and an ipython REPL is started.

metas = {
    ipy_tmux = {
        cmd = 'tmux attach -t ipython || tmux new -s ipython ipython',
        formatter = yarepl.formatter.bracketed_pasting,
    },
}

FAQ

How do I avoid clutter from the bufferline plugin?

If you are using a bufferline plugin and do not want the REPL buffers to clutter your bufferline, pass buflisted = false in the setup function.

In case you have unlisted the REPLs and need to view the running ones, use Telescope REPLShow.

REPLSendVisual is not functioning properly

Refer to REPLSendVisual

Limitations

  • Currently, yarepl only supports sending entire lines to REPL. This means that no matter what the motion or visual range is, it will always send the whole line to the REPL.

Acknowledgements