Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erotemic/vimtk
A vim toolkit focused on gvim, IPython, and the terminal.
https://github.com/erotemic/vimtk
cross-platform gvim python vim
Last synced: about 1 month ago
JSON representation
A vim toolkit focused on gvim, IPython, and the terminal.
- Host: GitHub
- URL: https://github.com/erotemic/vimtk
- Owner: Erotemic
- License: apache-2.0
- Created: 2018-02-17T20:39:20.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-05-26T00:17:36.000Z (6 months ago)
- Last Synced: 2024-09-21T13:02:58.422Z (about 2 months ago)
- Topics: cross-platform, gvim, python, vim
- Language: Python
- Homepage:
- Size: 415 KB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
VimTk - The (mostly) Python (g)Vim toolkit
==========================================
|GithubActions| |Codecov| |Pypi| |PypiDownloads| |ReadTheDocs|
Description
-----------
The tools in this package focus on, but are not exclusive to Python development
with gVim. This is both a Vim plugin and a pip installable Python module.
.. image:: https://user-images.githubusercontent.com/3186211/176559069-605e0285-f708-4f40-bc7a-6628db39b7ba.gif
Usage
-----
We suggest using vim-plug to manage plugins. Install vim plug like this:
.. code:: bash
# Install vim-plug into your autoload directory
" See: https://github.com/junegunn/vim-plug
curl -fLo ~/.vim/autoload/plug.vim --create-dirs https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
We suggest the following vimrc as a template:
.. code:: vim
" DEMO_VIMRC:
call plug#begin('~/.vim/bundle')
Plug 'Erotemic/vimtk'
call plug#end() " required
filetype plugin indent on
syntax on
"""" The above code should be among the first things in your vimrc
" Map your leader key to comma (much easier to hit)
let mapleader = ","
let maplocalleader = ","
noremap \ ,
" Make default vimtk remaps
:call VimTK_default_remap()
" Register files you use all the time with quickopen
" (use i as a shortcut to specific files
call vimtk#quickopen(',', '~/.vimrc')
call vimtk#quickopen('5', '~/.bashrc')
This module defines many helper functions, but does not bind them to keys by
default unless ``VimTK_default_remap`` is called. The default bindings are as
follows:
.. code:: vim
noremap H :call vimtk#helloworld()
noremap a :call vimtk#execute_text_in_terminal(mode())
vnoremap a :call vimtk#execute_text_in_terminal(visualmode())
noremap m :call vimtk#execute_text_in_terminal('word')
noremap C :call vimtk#copy_current_fpath()
noremap M :call vimtk#ipython_import_all()
command! AutoImport call vimtk#insert_auto_import()
noremap pv :call vimtk#insert_print_var_at_cursor()
noremap :call vimtk#insert_timerit(mode())
vnoremap :call vimtk#insert_timerit(visualmode())
noremap es :call vimtk#smart_search_word_at_cursor()
noremap go :call vimtk#open_path_at_cursor("e")
noremap gf :call vimtk#open_path_at_cursor("e")
noremap gi :call vimtk#open_path_at_cursor("split")
noremap gv :call vimtk#open_path_at_cursor("vsplit")
noremap gv :call vimtk#open_path_at_cursor("vsplit")
noremap gt :call vimtk#open_path_at_cursor("tabe")
noremap gi :call vimtk#open_path_at_cursor("split")
" Doctest editing
vnoremap gd :call vimtk#py_format_doctest()
vnoremap gu :call vimtk#py_unformat_doctest()
Obviously you can modify the exact key bindings however you would like.
Here is what some of these functions do:
- ``vimtk#execute_text_in_terminal`` - copies the current word, line, or visual
selection and executes it in your most recently used terminal (perhaps
running IPython or bash) without needing to alt-tab or copy paste.
Default binding is ``a`` for the current line or visual selection and
``m`` for a word.
- ``vimtk#ipython_import_all`` - if you are in a python module, this funciton
creates a few lines of code that will import everything in this module into
the current namespace. Note, it detects if you need to modify your pythonpath
and does that. It also completely disregards ``__all__``. These lines are
then executed in your terminal (which should probably be an IPython session).
Default binding is ``M``.
- ``vimtk#copy_current_fpath`` - Copies the path to the current file into the
clipboard. On non-windows the home drive is replaced with ``~``. Default
binding is ``C``.
- ``vimtk#auto_import`` - Automatically inserts missing Python imports.
- ``vimtk#insert_print_var_at_cursor`` - Insert a print statement around the
current variable your cursor is on (supports python, bash, cmake, and C++)
Default binding is ``pv`` for a repr representation and
``ps`` for a ubelt repr2 representation.
- ``vimtk#insert_timerit`` - Make a stub timerit and insert it at the current
position
- ``vimtk#open_path_at_cursor`` - Open a file path or web url at your cursor.
- ``vimtk#quickopen(char, fpath)`` - Use ``[tvio]``` to open predefined
files / directories
- ``vimtk#py_format_doctest`` - Default binding to ``gd``.
Inserts the doctest ``>>>`` prefix before the visually selected code.
- ``vimtk#py_unformat_doctest`` - Default binding to ``gu``.
Removes the doctest ``>>>`` prefix before the visually selected code.
Alternate VIMRC
---------------
Note to get all the features, you need the following packages:
.. code:: bash
# The a ability requires xdotool and wmctrl on linux systems
sudo apt install xdotool wmctrl ctags
# vimtk requires ubelt in whichever environment it is running
pip install ubelt --user
# There are also third party python packages needed for some functions
pip install pyperclip pyflakes xinspect psutil --user
# On windows you should also install pywinauto
pip install pywinauto --user
Note: there have been some issues regarding which Python environment these
pacakges are installed to and which Python environment is used by Vim. We are
working to resolve these issues. Bug reports and patches are welcome!
.. code:: vim
" VimTK Recommended VimRC:
" References: https://github.com/Erotemic/vimtk
"""""""""""""""
" # Automatically install vim-plug into your autoload directory
" " See: https://github.com/junegunn/vim-plug
"""""""""""""""
if empty(glob('~/.vim/autoload/plug.vim'))
" Automatic installation if vim plug does not exist
silent !curl -fLo ~/.vim/autoload/plug.vim --create-dirs
\ https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
autocmd VimEnter * PlugInstall --sync | source $MYVIMRC
endif
" Enable normal windows hotkeys like: ctrl+c, ctrl+v, ctrl+a, etc...
source $VIMRUNTIME/mswin.vim
behave mswin
set nocompatible
filetype off
"source $VIMRUNTIME/mswin.vim
"behave mswin
set encoding=utf8
call plug#begin('~/.vim/bundle')
Plug 'sjl/badwolf'
Plug 'scrooloose/nerdcommenter'
Plug 'scrooloose/nerdtree'
Plug 'vim-syntastic/syntastic'
Plug 'majutsushi/tagbar'
Plug 'ervandew/supertab'
Plug 'Erotemic/vimtk'
call plug#end() " required
filetype plugin indent on
syntax on
"""" The above code should be among the first things in your vimrc
scriptencoding utf-8
set encoding=utf-8
" References: https://vi.stackexchange.com/questions/13034/automatic-whitespace-in-python
" ---- Minimal configuration:
set smartindent " Do smart autoindenting when starting a new line
set shiftwidth=4 " Set number of spaces per auto indentation
set expandtab " When using , put spaces instead of a character
" ---- Good to have for consistency
set tabstop=4 " Number of spaces that a in the file counts for
set smarttab " At at beginning line inserts spaces set in shiftwidth
" Highlight search regexes
set incsearch
set hlsearch
" Disable swap files, which prevents annoying messages when you open the
" same file twice
set noswapfile
" Use a colorscheme (murphy is builtin, but I like badwolf)
colorscheme badwolf
"colorscheme murphy
" Map your leader key to comma (much easier to hit)
let mapleader = ","
let maplocalleader = ","
noremap \ ,
" Search and replace under cursor
noremap ss :%s/\<\>/
"Surround word with quotes
noremap qw ciw'"'
noremap qc ciw`"`
" Reload your vimrc
noremap R :source ~/.vimrc
" Window navication
" Alt + jklh
map j
map k
map l
map h
" Control + jklh
map j
map k
map l
" Move in split windows
" Press leader twice to move between windows
noremap , w
map h
" Fast nerd tree access
noremap :NERDTree
noremap . :NERDTree
noremap h :NERDTreeToggle
"noremap h :Tlist
noremap j :Tagbar
"set autochdir
" better version of autochdir that changes cwd to be at the current file
autocmd BufEnter * silent! lcd %:p:h
" Note: to use vimtk I think we need to have ubelt installed
" or get some sort of install-hook pip install command to happen
" We can hack around this by explicitly sourcing the vimtk plugin
source $HOME/.vim/bundle/vimtk/plugin/vimtk.vim
" Make default vimtk remaps.
:call VimTK_default_remap()
" Swap colon and semicolon
:call vimtk#swap_keys(':', ';')
" Register files you use all the time with quickopen
" (use i as a shortcut to specific files
:call vimtk#quickopen(',', '~/.vimrc')
:call vimtk#quickopen('5', '~/.bashrc')
Related Work
------------
* https://github.com/voldikss/vim-floaterm
.. |CircleCI| image:: https://circleci.com/gh/Erotemic/vimtk.svg?style=svg
:target: https://circleci.com/gh/Erotemic/vimtk
.. |Travis| image:: https://img.shields.io/travis/Erotemic/vimtk/main.svg?label=Travis%20CI
:target: https://travis-ci.org/Erotemic/vimtk?branch=main
.. |Appveyor| image:: https://ci.appveyor.com/api/projects/status/github/Erotemic/vimtk?branch=main&svg=True
:target: https://ci.appveyor.com/project/Erotemic/vimtk/branch/main
.. |Codecov| image:: https://codecov.io/github/Erotemic/vimtk/badge.svg?branch=main&service=github
:target: https://codecov.io/github/Erotemic/vimtk?branch=main
.. |Pypi| image:: https://img.shields.io/pypi/v/vimtk.svg
:target: https://pypi.python.org/pypi/vimtk
.. |ReadTheDocs| image:: https://readthedocs.org/projects/vimtk/badge/?version=latest
:target: http://vimtk.readthedocs.io/en/latest/
.. |PypiDownloads| image:: https://img.shields.io/pypi/dm/vimtk.svg
:target: https://pypistats.org/packages/vimtk
.. |GithubActions| image:: https://github.com/Erotemic/vimtk/actions/workflows/tests.yml/badge.svg?branch=main
:target: https://github.com/Erotemic/vimtk/actions?query=branch%3Amain