Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/williamjameshandley/vimteractive

Send commands from text to interactive programs
https://github.com/williamjameshandley/vimteractive

bash clojure ide ipython maple plugin python terminal vim zsh

Last synced: 24 days ago
JSON representation

Send commands from text to interactive programs

Awesome Lists containing this project

README

        

============
Vimteractive
============
:vimteractive: send commands from text files to interactive programs via vim
:Author: Will Handley
:Version: 2.7.1
:Homepage: https://github.com/williamjameshandley/vimteractive
:Documentation: ``:help vimteractive``

Vimteractive was inspired by the workflow of the
`vim-ipython `__ plugin.

This plugin is designed to extend a subset of the functionality of vim-ipython
to other `REPLs `__ (including ipython). It is based around the unix
philosophy of `"do one thing and do it well" `__.
Vimteractive aims to provide a robust and simple link between text files and
language shells. Vimteractive will never aim to do things like
autocompletion, leaving that to other, more developed tools such as
`YouCompleteMe `__ or
`Copilot `__.

The activating commands are:

- `ipython `__ ``:Iipython``
- `julia `__ ``:Ijulia``
- `maple `__ ``:Imaple``
- `mathematica `__ ``:Imathematica``
- `bash `__ ``:Ibash``
- `zsh `__ ``:Izsh``
- `python `__ ``:Ipython``
- `clojure `__ ``:Iclojure``
- `apl `__ ``:Iapl``
- `R `__ ``:IR``
- `sgpt `__ ``:Isgpt``
- `gpt-command-line `__ ``:Igpt``
- autodetect based on filetype ``:Iterm``

Commands may be sent from a text file to the chosen REPL using ``CTRL-S``.
If there is no REPL, ``CTRL-S`` will automatically open one for you using
``:Iterm``.

For some terminals, the output of the last command may be retrieved with
``CTRL-Y``.

Note: it's highly recommended to use IPython as your default Python
interpreter. You can set it like this:

.. code:: vim

let g:vimteractive_default_shells = { 'python': 'ipython' }

Installation
------------

Since this package leverages the native vim interactive terminal, vimteractive
is only compatible with vim 8 or greater.

Installation should be relatively painless via
`the usual routes `_ such as
`Vundle `__,
`Pathogen `__ or the vim 8 native
package manager (``:help packages``).
If you're masochistic enough to use
`Arch `__/`Manjaro `__,
you can install vimteractive via the
`aur `__.
For old-school users, there is also a package on the `vim
repo `__.
Depending on your package manager, you may need to run ``:helptags `` to install the help documentation.

Motivation
----------

`IPython and Jupyter `__ are excellent tools for
exploratory analyses in python. They leverage the interactivity of the python
kernel to allow you to keep results of calculations in memory whilst developing
further code to process them.

However, I can't stand typing into anything other than vim. Anywhere else, my
screen fills with hjklEB, or worse, I close the window with a careless
````. I want a technique that allows me to operate on plain text files,
but still be able to work interactively with the interpreter with minimal
effort.

`Many Projects <#similar-projects>`__ achieve this with a varying level of
functionality. Vimteractive aims to create the simplest tool for sending things
from text to interpreter, and making it easy to add additional interpreters. In
particular, my main aim in starting this was to get a vim-ipython like
interface to the command line `maple `__.

Usage
-----

To use the key-bindings, you should first disable the ``CTRL-S``
default, which is a terminal command to freeze the output. You can
disable this by putting

.. code:: bash

stty -ixon

into your ``.bashrc`` (or equivalent shell profile file).

Example usage:
~~~~~~~~~~~~~~

|example_usage|

Create a python file ``test.py`` with the following content:

.. code:: python

import matplotlib.pyplot as plt
import numpy

fig, ax = plt.subplots()
x = numpy.linspace(-2,2,1000)
y = x**3-x
ax.plot(x, y)
ax.set_xlabel('$x$')
ax.set_ylabel('$y$')

Now start an ipython interpreter in vim with ``:Iipython``. You should see a
preview window open above with your ipython prompt. Position your cursor over
the first line of ``test.py``, and press ``CTRL-S``. You should see this line
now appear in the first prompt of the preview window. Do the same with the
second and fourth lines. At the fourth line, you should see a figure appear
once it's constructed with ``plt.subplots()``. Continue by sending lines to the
interpreter. You can send multiple lines by doing a visual selection and
pressing ``CTRL-S``.

If you switch windows with ``CTRL-W+k``, you will see the terminal buffer
switch to a more usual looking normal-mode buffer, from which you can perform
traditional normal mode commands. However, if you try to insert, you will enter
the REPL, and be able to enter commands interactively into the prompt as if
you had run it in the command line. You can save this buffer if you wish to a
new file if it contains valuable output

You may want to send lines to one REPL from two buffers. To achieve that,
run ``:Iconn `` where ```` is a name of buffer
containing REPL. If there is only one REPL, you can use just
``:Iconn``.

Supported REPLs
~~~~~~~~~~~~~~~

- ``:Iipython`` Activate an ipython REPL
- ``:Ijulia`` Activate a julia REPL
- ``:Imaple`` Activate a maple REPL
- ``:Imathematica`` Activate a mathematica REPL
- ``:Ibash`` Activate a bash REPL
- ``:Izsh`` Activate a zsh REPL
- ``:Ipython`` Activate a python REPL
- ``:Iclojure`` Activate a clojure REPL
- ``:Iapl`` Activate an apl REPL
- ``:IR`` Activate an R REPL
- ``:Isgpt`` Activate an sgpt REPL
- ``:Igpt`` Activate an gpt-command-line REPL
- ``:Iterm`` Activate default REPL for this filetype

Sending commands
~~~~~~~~~~~~~~~~

``CTRL-S`` sends lines of text to the interpreter in a mode-dependent manner:

In Normal mode, ``CTRL-S`` sends the line currently occupied by the cursor to the
REPL.

In Insert mode, ``CTRL-S`` sends the line currently being edited, and then
returns to insert mode at the same location.

In Visual mode, ``CTRL-S`` sends the current selection to the REPL.

``ALT-S`` sends all lines from the start to the current line.

Retrieving command outputs
~~~~~~~~~~~~~~~~~~~~~~~~~~

CTRL-Y retrieves the output of the last command sent to the REPL. This only
implemented in a subset of terminas (``:Iipython``, ``:Isgpt`` and ``:Igpt``)

In ``Normal-mode``, CTRL-Y retrieves the output of the last command sent to the
REPL and places it in the current buffer.

In ``Insert-mode``, CTRL-Y retrieves the output of the last command sent to the
REPL and places it in the current buffer, and then returns to insert mode
after the output.

Connecting to an existing REPL
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

``:Iconn [{buffer]`` connects current buffer to REPL in ``{buffer}``. You can
connect any number of buffers to one REPL. ``{buffer}`` can be omitted if there
is only one REPL.

``]v`` and ``[v`` can be used to cycle between connected buffers in the style of
`unimpaired `__.

Common issues
-------------

Bracketed paste
~~~~~~~~~~~~~~~

If you see strange symbols like ``^[[200~`` when sending lines to your new
interpreter, you may be on an older system which does not have bracketed paste
enabled, or have other shell misbehaviour issues. You can change the default
setting with

.. code:: vim

let g:vimteractive_bracketed_paste_default = 0

Options
-------
These options can be put in your ``.vimrc``, or run manually as desired:

.. code:: vim

let g:vimteractive_vertical = 1 " Vertically split REPLs
let g:vimteractive_autostart = 0 " Don't start REPLs by default

Extending functionality
-----------------------

This project is very much in an beta phase, so if you have any issues
that arise on your system, feel free to `leave an issue `__ or create a `fork and pull
request `__ with
your proposed changes

You can easily add your interpreter to Vimteractive, using the following code
in your ``.vimrc``:

.. code:: vim

" Mapping from Vimterpreter command to shell command
" This would give you :Iasyncpython command
let g:vimteractive_commands = {
\ 'asyncpython': 'python3 -m asyncio'
\ }

" If you see strange symbols like ^[[200~ when sending lines
" to your new interpreter, disable bracketed paste for it.
" You can also try it when your shell is misbehaving some way.
" It's needed for any standard Python REPL including
" python3 -m asyncio
let g:vimteractive_bracketed_paste = {
\ 'asyncpython': 0
\ }

" If you want to set interpreter as default (used by :Iterm),
" map filetype to it. If not set, :Iterm will use interpreter
" named same with filetype.
let g:vimteractive_default_shells = {
\ 'python': 'asyncpython'
\ }

" If your interpreter startup time is big, you may want to
" wait before sending commands. Set time in milliseconds in
" this dict to do it. This is not needed for python3, but
" can be useful for other REPLs like Clojure.
let g:vimteractive_slow_prompt = {
\ 'asyncpython': 200
\ }

Similar projects
----------------

- `vim-ipython `__
- `vim-notebook `__
- `conque `__
- `vim-slime `__
- `tslime_ipython `__
- `vipy `__

.. |example_usage| image:: https://raw.githubusercontent.com/williamjameshandley/vimteractive/master/images/example_usage.gif