Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/offchan42/vimrc

The ultimate Vim configuration: .vimrc (heavily customized, uncompromising and opinionated)
https://github.com/offchan42/vimrc

spacemacs vim vim-configs vim-configuration vim-scripts vimrc

Last synced: 14 days ago
JSON representation

The ultimate Vim configuration: .vimrc (heavily customized, uncompromising and opinionated)

Host: GitHub
URL: https://github.com/offchan42/vimrc
Owner: offchan42
License: mit
Created: 2016-11-03T16:42:15.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2024-03-02T00:13:59.000Z (9 months ago)
Last Synced: 2024-03-03T00:39:08.648Z (9 months ago)
Topics: spacemacs, vim, vim-configs, vim-configuration, vim-scripts, vimrc
Language: C
Homepage:
Size: 10.9 MB
Stars: 2
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# The Ultimate vimrc [[OFF'S EDITION]]
**Update**: I'm now using Vim when I want fast access because Vim is all over the
place. But I'm currently using [Spacemacs](http://spacemacs.org/) (an Emacs
distribution focusing on bringing the best of Vim and Emacs together) and I've
been happy with it so far.

**Update 2**: There is something
called [SpaceVim](https://github.com/SpaceVim/SpaceVim) that comes out lately
and it said that it's similar to **Spacemacs**. I have not tried it yet but this
proved that concept of **Spacemacs** is good enough to be followed.

This also means that it might be better to use **SpaceVim** distribution instead
of mine. Because I think I'm not going to update this repository for awhile. I'm
going to the dark side with **Spacemacs** distribution on **Emacs**.

You will see that many key bindings in this vimrc is stolen from Spacemacs. I
want you to explore it yourself. I encourage you to try it, here's my dot
spacemacs directory in case you are curious:
https://github.com/offchan42/.spacemacs.d

**Update 3**: I'm now using `Visual Studio Code` as my go to text editor now.
As it's easy to use and it also has a stunning Vim extension.
It's fast to open in my PC. It took less than 3 seconds to run. That's not
a lot of time to tolerate! Its Vim extension doesn't interfere much
with the VS Code keybindings itself. That's why I like it. (JetBrains IDE like PyCharm, IntelliJ, PhpStorm, etc
have Vim plugins that interfere a lot with its keybindings, so I don't use Vim plugin in those IDEs)

I code in `python` a lot so `Jupyter Lab` is another IDE that runs in the browser. I like a lot
because it's easy to experiment with code using its visual style. And it starts even quicker than any text editor.
And yes, it has Vim extension (without any interference with its keybindings at all)!
So I suggest using Jupyter Lab to run your Jupyter Notebook and python code.

Also, if you are a Vim lover like me, you might like Vimium extension in Chrome.
Try that and you will not need to use much mouse for browsing web anymore.

## Prerequisite
If you don't have Vim installed, I suggest you to install 64-bit
version and here is the suggested link: https://bintray.com/micbou/generic/vim

Please use Vim version >= 7.4 if possible. GVim and MacVim are the most ideal
distribution that I recommend.

## Vimrc Installation
There are two options:

* **Basic**: If you want something small just copy [basic.vim](vimrcs/basic.vim) into your ~/.vimrc and you will have a great basic setup
* **Awesome**: This includes a ton of useful plugins, color schemes and configurations

I would of course recommend using the awesome version.

## How to install the Awesome version?
The awesome version includes a lot of great plugins, configurations and color schemes that make Vim a lot better. To install it simply do following:

```bash
git clone https://github.com/offchan42/vimrc.git ~/.vim_runtime
sh ~/.vim_runtime/install_awesome_vimrc.sh
cd ~/.vim_runtime && git submodule update --init && cd ~-
```

5. I highly recommend using [Source Code Pro font from Adobe](http://store1.adobe.com/cfusion/store/html/index.cfm?event=displayFontPackage&code=1960)
(it's free and awesome font for writing and programming).
The Ultimate vimrc is already setup to try to use it.
You can download it freely from this repository:
https://github.com/adobe-fonts/source-code-pro

1. If you want to use neocomplete (Autocomplete) plugin, you'll
need to have Lua installed, please refer to
https://github.com/Shougo/neocomplete.vim#requirements for further instructions.

2. If you want to use **taglist.vim** plugin (**F8**) then you also need to install **ctags** which
can be found at http://ctags.sourceforge.net/ (For Windows, I have already
installed it inside this repository for you. But if you want to install it with **PATH** variable
set, use **chocolatey** and run `cinst ctags`)

_Optional_: You can use the latest version of **ctags** which is named
[Universal ctags](https://github.com/universal-ctags/ctags) manually instead of the **Exuberant ctags** I mentioned above.

3. deprecated: ~~If you want to use Python's Omni autocomplete feature with **CTRL-X CTRL-O**
then install Python 2 and set **PYTHONHOME** to the directory where you have
**python.exe** lying around. Refer to http://stackoverflow.com/a/40566169/2593810 for more
information.
Try entering `:py print 2**10` and if it outputs `1024` then you are good to
go.~~ Please use **jedi-vim** instead.

4. If you want to use flake8 python static file checkers (**F7**) please use
python **pip** or any python environment manager to install **flake8** like
so: `pip install flake8`.
_In my opinion, this plugin is unnecessary. It rarely finds problems if you
code well. :)_

6. To use **jedi-vim** plugin, you must have **jedi** installed. Jedi is an
awesome autocompletion/static analysis library for Python.
Either run `git submodule update --init --recursive` inside
*sources_non_forked/jedi-vim/* or `pip install jedi` will work.
If you are using **Anaconda** package manager, **jedi** will already be installed
for you.

7. To use **Ag** ([The Silver Searcher](https://github.com/ggreer/the_silver_searcher)),
you need to install it. It's like **grep** but is faster.

If you are on Windows, the easiest way to install is to use [chocolatey](https://chocolatey.org/).

Runs `choco install ag` then you are ready to use Ag with **ack.vim** plugin in this
repository.

**ack.vim** is a plugin made to integrate Ack and Ag into Vim.

Trigger the plugin by hitting `a` and enter your search pattern.

## How to install the Basic version?
The basic version is basically just one file and no plugins. You can check out
[basic.vim](https://github.com/offchan42/vimrc/blob/master/vimrcs/basic.vim).

This is useful to install on remote servers where you don't need many plugins
and you don't do many edits.

```bash
git clone git://github.com/offchan42/vimrc.git ~/.vim_runtime
sh ~/.vim_runtime/install_basic_vimrc.sh
```

## How to install on Windows?

Use [msysgit (Git Bash)](http://msysgit.github.com/) to checkout the repository
and run the installation instructions above. No special instructions needed ;-)

## How to install on Linux

Install like on Windows but instead of using Git Bash, you can just simply use a
real Bash!

## How to update to latest version?

Simply just do a git pull rebase and update the submodules!

```bash
cd ~/.vim_runtime
git pull --rebase
git submodule foreach git pull origin master
cd ~-
```

## Some screenshots

**LATEST SCREENSHOT**: This is my current working gVim on Windows. It uses **dark
solarized** colorscheme.
![Screenshot 0](screenshots/2016-11-14_02-29-15.png?raw=true)

**gVim vs Atom on my Windows**: Clearly atom is more aesthetically pleasing, it
also has **vim-mode-plus** so you can do some vimming inside it. But it's just a
package, it cannot beat the true power of Vim. I love both of
them, but I think I favor Vim more. Its interface is not as beautiful as Atom
yet but it will as long as [Neovim](https://neovim.io/) team keeps working.
I spent so much time learning and customizing my Vim, I'm not gonna be the
victim of an editor's beauty ~~again~~! :)
![gVim vs Atom](screenshots/2016-11-29_12-27-18.png?raw=true)

Colors when editing a Python file of a **peaksea** colorscheme
![Screenshot 1](http://files1.wedoist.com/e952fdb343b1e617b90d256e474d0370/as/screenshot_1.png)

Opening recently opened files [mru.vim](https://github.com/vim-scripts/mru.vim):
![Screenshot 2](http://files1.wedoist.com/1967b0e48af40e513d1a464e08196990/as/screenshot_2.png)

[NERD Tree](https://github.com/scrooloose/nerdtree) plugin in a terminal window:
![Screenshot 3](http://files1.wedoist.com/b1509d7ed9e9f357e8d04797f9fad67b/as/screenshot3.png)

Old Windows showoff time!
![Screenshot 4](http://files1.wedoist.com/4e85163d97b81422240c822c82022f2f/as/screenshot_4.png)

Distraction free mode using [goyo.vim](https://github.com/junegunn/goyo.vim) and [vim-zenroom2](https://github.com/amix/vim-zenroom2)
(Default key to trigger is `z`):
![Screenshot 5](https://d2dq6e731uoz0t.cloudfront.net/a5182977c3d6c2a6cd3f9e97398ca8ca/as/zen_mode.jpg)

## Included Plugins

I recommend reading the docs of these plugins to understand them better. Each of them provide a much better Vim experience!

* [pathogen.vim](https://github.com/tpope/vim-pathogen): Manages the runtime path of the plugins
* [snipMate.vim](https://github.com/garbas/vim-snipmate): snipMate.vim aims to be a concise vim script that implements some of TextMate's snippets features in Vim
* [bufexplorer.zip](https://github.com/vim-scripts/bufexplorer.zip): Buffer Explorer / Browser. This plugin can be opened with ``
* [NERD Tree](https://github.com/scrooloose/nerdtree): A tree explorer plugin for vim
* [ack.vim](https://github.com/mileszs/ack.vim): Vim plugin for the Perl module / CLI script 'ack'
* [ag.vim](https://github.com/rking/ag.vim): A much faster Ack
* [ctrlp.vim](https://github.com/ctrlpvim/ctrlp.vim): Fuzzy file, buffer, mru and tag finder.
* [mru.vim](https://github.com/vim-scripts/mru.vim): Plugin to manage Most Recently Used (MRU) files. Includes my own fork which adds syntax highlighting to MRU. This plugin can be opened with ``
* [open_file_under_cursor.vim](https://github.com/amix/open_file_under_cursor.vim): Open file under cursor when pressing `gf`
* [vim-indent-object](https://github.com/michaeljsmith/vim-indent-object): Defines a new text object representing lines of code at the same indent level. Useful for python/vim scripts
* [vim-multiple-cursors](https://github.com/terryma/vim-multiple-cursors): Sublime Text style multiple selections for Vim, CTRL+N
* [vim-expand-region](https://github.com/terryma/vim-expand-region): Allows you to visually select increasingly larger regions of text using the same key combination. (In this case, it's `+` and `_`)
* [vim-fugitive](https://github.com/tpope/vim-fugitive): A Git wrapper so awesome, it should be illegal
* [goyo.vim](https://github.com/junegunn/goyo.vim) and [vim-zenroom2](https://github.com/amix/vim-zenroom2):
Remove all clutter and focus only on the essential. Similar to iA Writer or Write Room [Read more here](http://amix.dk/blog/post/19744)
* [vim-commentary](https://github.com/tpope/vim-commentary): Comment stuff out. Use `gcc` to comment out a line (takes a count), `gc` to comment out the target of a motion. `gcu` uncomments a set of adjacent commented lines.
* [syntastic](https://github.com/scrooloose/syntastic): Syntax checking hacks for vim

* [lightline.vim](https://github.com/itchyny/lightline.vim): A light and configurable statusline/tabline for Vim
* and a lot more! (Please check inside the `sources_non_forked` directory)

## Included color schemes

* [vim-colors-solarized](https://github.com/altercation/vim-colors-solarized):
Off's favorite! (this is the default colorscheme)
* [peaksea](https://github.com/vim-scripts/peaksea): amix's favorite
* [vim-irblack](https://github.com/wgibbs/vim-irblack)
* [mayansmoke](https://github.com/vim-scripts/mayansmoke)
* [vim-pyte](https://github.com/therubymug/vim-pyte)
* [Zenburn](https://github.com/jnurmine/Zenburn): This colorscheme is used by
default if you do not have a GUI version running on your system.
AKA you run Vim in a terminal of some sort.

## Included modes

* [vim-coffee-script](https://github.com/kchmck/vim-coffee-script)
* [vim-less](https://github.com/groenewege/vim-less)
* [vim-bundle-mako](https://github.com/sophacles/vim-bundle-mako)
* [vim-markdown](https://github.com/tpope/vim-markdown)
* [nginx.vim](https://github.com/vim-scripts/nginx.vim): Highlights configuration files for nginx
* [vim-go](https://github.com/fatih/vim-go)

## How to include your own stuff?

After you have installed the setup you can append
**~/.vim_runtime/my_configs.vim** to fill in any configurations that are
important for you.

You can also install your own plugins, for instance, via pathogen we can install
[vim-rails](https://github.com/tpope/vim-rails):

```bash
cd ~/.vim_runtime
git clone git://github.com/tpope/vim-rails.git sources_non_forked/vim-rails
```

Now you have vim-rails installed ;-)

## Key Mappings

### Plugin related mappings

Open [bufexplorer](https://github.com/vim-scripts/bufexplorer.zip) and see and manage the current buffers (`o`):

```viml
map o :BufExplorer
```

Open [MRU.vim](https://github.com/vim-scripts/mru.vim) and see the recently open files (`f`):

```viml
map f :MRU
```

Open [ctrlp.vim](https://github.com/kien/ctrlp.vim) plugin (``)

Managing the [NERD Tree](https://github.com/scrooloose/nerdtree) plugin:

```viml
map nt :NERDTreeTabsToggle
map nf :NERDTreeTabsFind
map nn :NERDTreeFocusToggle
```

[goyo.vim](https://github.com/junegunn/goyo.vim) and
[vim-zenroom2](https://github.com/amix/vim-zenroom2) lets you only focus on one
thing at a time. It removes all the distractions and centers the content. It has
a special look when editing Markdown, reStructuredText and textfiles. It only
has one mapping. (`z`)

```viml
map z :Goyo
```

### Normal mode mappings

Fast saving of a buffer (`fs`):

```viml
nmap fs :w!
```

Disable highlight when `` is pressed:

```viml
map :noh
```

Smart way to move between windows (`j` etc.):

```viml
map j
map k
map h
map l
" or use spacemacs style
map wj j
map wk k
map wh h
map wl l
```

Closing of current buffer(s) (`bd` and (`ba`)):

```viml
" Close current buffer
map bd :Bclose
" Close all buffers
map ba :1,1000 bd!
```

Useful mappings for managing tabs:

```viml
map tn :tabnew
map to :tabonly
map tc :tabclose
map tm :tabmove
" Opens a new tab with the current buffer's path
" Super useful when editing files in the same directory
map te :tabedit =expand("%:p:h")/
```

Switch CWD to the directory of the open buffer:

```viml
map cd :cd %:p:h:pwd
```

Remove the Windows ^M - when the encodings gets messed up:

```viml
noremap m mmHmt:%s///ge'tzt'm
```

Toggle paste mode on and off:

```viml
map pp :setlocal paste!
```

### Insert mode mappings

Insert the current date and time (useful for timestamps):

```viml
iab xdate =strftime("%d/%m/%y %H:%M:%S")
```

### Visual mode mappings

Visual mode pressing `*` or `#` searches for the current selection:

```viml
vnoremap * :call VisualSelection('f')
vnoremap # :call VisualSelection('b')
```

When you press gv you vimgrep after the selected text:

```viml
vnoremap gv :call VisualSelection('gv')
```

When you press `r` you can search and replace the selected text:

```viml
vnoremap r :call VisualSelection('replace')
```

### Command line mappings

$q is super useful when browsing on the command line. It deletes everything until the last slash:

```viml
cno $q eDeleteTillSlash()
```

Bash like keys for the command line:

```viml
cnoremap
cnoremap
cnoremap
cnoremap
cnoremap
```

Write the file as sudo (only on Unix). Super useful when you open a file and you
don't have permissions to save your changes. [Vim tip](http://vim.wikia.com/wiki/Su-write):

### Spell checking (currently disabled, please use default Vim keys)
Pressing `ss` will toggle and untoggle spell checking

```viml
map ss :setlocal spell!
```

Shortcuts using `` instead of special chars

```viml
map sn ]s
map sp [s
map sa zg
map s? z=
```

### Cope
Do `:help cope` if you are unsure what cope is. It's super useful!

When you search with vimgrep, display your results in cope by doing:
`cc`

To go to the next search result do:
`cn`

To go to the previous search results do:
`cp`

Vimscript mappings:

```viml
map cc :botright cope
map co ggVGy:tabnew:set syntax=qfpgg
map cn :cn
map cp :cp
```

## How to uninstall
Do following:
* Remove `~/.vim_runtime`
* Remove any lines that reference `.vim_runtime` in your `~/.vimrc`