neovim-prompt

A customizable command-line prompt module for Neovim/Vim. This repository is assumed to used as a submodule/subtree package.

Usage

Assume you are 'PETER' and you are making 'my-awesome-vim-plugin'.

git submodule

If you won't touch the code in neovim-prompt, this is a best way to use neovim-prompt in your plugin.

git clone https://github.com/PETER/my-awesome-vim-plugin
cd my-awesome-vim-plugin
git submodule add https://github.com/lambdalisue/neovim-prompt rplugin/python3/my_awesome_vim_plugin/prompt

git subtree

It is complicated so if you are not really familiar with git subtree, you should use git submodule instead.

First of all, fork https://github.com/lambdalisue/neovim-prompt to GitHub. Then clone your neovim-prompt to the same parent directory to the your plugin like

git clone https://github.com/PETER/my-awesome-vim-plugin
git clone https://github.com/PETER/neovim-prompt

Then, add cloned local repository as a remote repository of 'my-awesome-vim-plugin' like

cd my-awesome-vim-plugin
git remote add neovim-prompt ../neovim-prompt

Then perform the following. Note that following is used for update neovim-prompt to the latest as well.

git fetch neovim-prompt
git subtree pull --prefix=rplugin/python3/my_awesome_vim_plugin/prompt neovim-prompt master --squash

When you change the neovim-prompt code and you think it's valuable for other peoples, make a PR with

git fetch neovim-prompt
git subtree push --prefix=rplugin/python3/my_awesome_vim_plugin/prompt neovim-prompt some-awesome-implementation --squash
cd ../neovim-prompt
git checkout some-awesome-implementation
git push -u origin

Then send me a PR. I'll check the implementations and concepts. Please try to make clear commits before sending me a PR.

Python code

If you followed the above, you can use neovim-prompt as like the following.

from .prompt.prompt import (
    Prompt,
    STATUS_ACCEPT,
    STATUS_CANCEL,
    STATUS_INTERRUPT,
)

# ...

    prompt = Prompt()
    status = prompt.start()
    if status == STATUS_ACCEPT:
        result = prompt.text
        # Do what ever you want
    elif status == STATUS_CANCEL:
        # User hit <Esc> (or whatever which is mapped to <prompt:cancel>)
    elif status == STATUS_INTERRUPT:
        # User hit <C-c> to interrupt

# ...

See API document or real world examples for more detail.

Tests

While neovim-prompt is assumed to be used as a git submodule/subtree, the 'master' branch does not contain any code for testing but 'ci-test' branch.

First of all, clone 'ci-test' branch of neovim-prompt in neovim-prompt repository as

git clone https://github.com/lambdalisue/neovim-prompt
cd neovim-prompt
git clone https://github.com/lambdalisue/neovim-prompt --branch ci-test ci-test

Then cd to 'ci-test' and run scripts/test.sh to perform tests.

cd ci-test
./scripts/test.sh

If you implement features, do not forget to add tests in ci-test branch.

Builtin actions

neovim-prompt provides the following builtin actions.

The above actions are defined in action.py

Default mappings

The default mapping is determined from a Vim's native command-line (:help ex-edit-index.)

The above actions are defined in keymap.py

Plugins which use neovim-prompt

• lambdalisue/lista.nvim
• Shougo/denite.nvim