vim-relief

a minimal but flashy tmux + vim configuration

Disclaimer

This project is not under active development / maintenance. Use at your own risk.

A lot has happened since I started this 'project'... Primarily, I've grown tired of configuring everything myself. I use vscode and clion now. That being said, I still install this on the machines I use for quick scripting / small projects.

Philosophy

Minimal

Its just enough ide. Nothing more. Nothing less.

but Flashy

Just because its lightweight doesn't mean its not pretty.

Screenshot(s)

Features

relief is really functional

• cross tool compatibility - find out what it means to me

set -g @plugin 'tmux-pluginx/vim-tmux'
Plug 'christoomey/vim-tmux-navigator'
Plug 'tmux-plugins/vim-tmux-focus-events'
Plug 'edkolev/tmuxline.vim'

• are we ide yet? oh we're lsp baby

Plug 'vim-ctrlspace/vim-ctrlspace'
Plug 'craigemery/vim-autotag'
Plug 'neoclide/coc.nvim'
Plug 'davidhalter/jedi-vim'
Plug 'plytophogy.vim-virtualenv'
Plug 'w0rp/ale'

• vim and tmux sitting in a NERDTree, A.I.R.L.I.N.E

Plug 'scrooloose/nerdtree'
Plug 'vim-airline'

• create multiple panes with intuitive bindings

prefix + \ (horizontal split)
prefix + - (vertical split)

• traverse across vim and tmux panes with vim-esque ease

ctrl + Left|Down|Up|Right

• use sensible standards everybody agrees on, not esoteric idiosyncrasies everybody disagrees on

Plug 'tpope/vim-sensible'
set -g @plugin 'tmux-plugins/tmux-sensible'
Plug 'tpope/vim-surround'

• things that should be automatic are

Plug 'vim-scripts/vim-auto-save'
Plug 'tpope/vim-sleuth'
Plug 'jiangmiao/auto-pairs'
Plug 'alvan/vim-closetag'
Plug 'nerdtree-git-plugin'

Inspiration

I would be remiss not to acknowledge my colleague Hatef, who got me started on my journey to minimal but flashy workflows.

Installation

Requirements

• Operating System : Unix based (tested on Ubuntu, Pop!_OS, Raspbian, macOS Mojave)
• Hardware : you can probably run this on a potato (at least without ycm and ctrlspace)
• Terminal : (tested on gnome-terminal, macOS terminal, and alacritty)

! Highly recommend alacritty

• Software : git, vim, and tmux
  • for ycm : python2.7 or python3.5 - whichever your vim supports
  • for search by symbol : ctags

Setup

1. Install nodejs (use nvm to manage multiple versions of node)
2. Install a nerd-font and enable it in your terminal (installation to be automated)
3. Run . install.sh from the repo root dir
4. Install a terminal/vim/vim-airline theme
5. To configure the promptline, during the installation, edit .vimrc to apply your theme Then run :AirlineTheme <theme> and :PromptlineSnapshot ~/.promptline.sh airline and exit vim Then source ~/.promptline.sh (not recommended without nerd font + powerline font)
6. To configure tmuxline on start, take a snapshot of the tmuxline configuration (run both tmux and vim)

:TmuxlineSnapshot ~/.tmux_status.conf

Upcoming Features

• usage instructions

Scope Creep

• installer written in rust
• arch-relief linux distro
• apt/brew
• auto update script (dependencies included)
• versions:

Version	Supported Features	Description
relief (flagship model)	all of them	Turns your vim into a beautiful lsp powered ide. Migrants from JetBrains will like this.
relief.satellite	ctrlspace + airline some typography automation autotag autoclose autindent lsp autocompletion linting . src/relief.bear	Enhanced and beautiful vim experience without programming language support. Ideal for non-coders/hard-corers looking for the aesthetic.
relief.bear	sensible configuration seamless navigation anything else	The bare minimum for the bears living among us. Ideal if you'd like to customize your own vim-relief.

Worth a README.md

• sensible.vim
• tmux-sensible
• promptline
• surround.vim
• vim-ctrlspace
• auto-pairs
• vim + tmux pane titles
• spicycode.tmux.conf (second* best and greatest tmux.conf ever)
• nerd-fonts
• Devicons nerd-font
• ycm vs jedi-vim
• airline tmux
• bash rc vs _profile
• pioneer (shoulders i wish i stood on)