Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/hachreak/vimrc

My vim configuration
https://github.com/hachreak/vimrc

Last synced: about 7 hours ago
JSON representation

My vim configuration

Host: GitHub
URL: https://github.com/hachreak/vimrc
Owner: hachreak
License: other
Created: 2014-11-05T09:48:57.000Z (about 10 years ago)
Default Branch: master
Last Pushed: 2023-10-25T08:19:36.000Z (about 1 year ago)
Last Synced: 2023-10-25T09:52:21.694Z (about 1 year ago)
Language: Vim Script
Homepage:
Size: 77.1 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

vimrc
=====

Personal vim configurations.

You can found general settings in `bundle/config/plugin/config.vim`
and plugins settings in `bundle/config/plugin` directory.

## Install

Clone this repo and deploy:

```bash
laptop> git clone https://github.com/hachreak/vimrc.git
laptop> cd vimrc
laptop> sh ./preinstall.sh
laptop> ./deploy.sh
```

The script backup your .vimrc and .vim and then install the
configuration in your environment.

### Options

```bash
# To force reinstalling of all modules
laptop> ./deploy.sh -f
# Help
laptop> ./deploy.sh -h
```

### Upgrade

Execute undeploy script and install again:

```bash
laptop> cd vimrc
laptop> ./undeploy.sh
laptop> git fetch origin
laptop> git merge --ff-only origin/master
laptop> ./deploy.sh
```

## Uninstall

Execute undeploy script:

```bash
laptop> cd vimrc
laptop> ./undeploy.sh
```

## Configure

#### Ctags

Start from the root of your project to generate tags:

```bash
laptop> ctags -R --exclude=.git .
```

## Extra requirements

Use the `preinstall.sh` script to automatically install all the dependencies.

Note: the script is ready to use only on ubuntu.

#### Module screen

The module needs gnu screen or tmux installed.

#### Module tagbar

To be able to use the module *tagbar*, you need to install *exuberant*.

With apt-get:

```bash
sudo apt-get install exuberant-ctags
```

With yum:

```bash
sudo yum install ctags-etags
```

#### Module ack.vim

The module needs *ack-grep*.

With apt-get:

```bash
sudo apt-get install ack-grep
```

#### Copy/Paste functionality

To use *Copy/Paste* functionality, Vim should be compiled with support for the +clipboard.
To know if is enabled, try: `vim --version|grep clipboard`.

If it's not enabled, you can install `vim-gtk`.

#### Module YouCompleteMe

You have to install *cmake* and *python-dev* and vim>7.3.584+.

With apt-get:

```bash
sudo apt-get install cmake python-dev
```

With yum:

```bash
sudo yum install cmake python-devel
```

#### Module vim-isort

You need to install isort:

```bash
pip install isort
```

## Extend configurations

Add submodule or plugins, in your `repos` directory:

```bash
laptop> git submodule add https://github.com/username/[plugin].git bundle/[plugin]
```

Now, you can add specific configuration of the module here:

```bash
laptop> vim bundle/config/plugin/[plugin].vim
```

## Upgrade submodules

If you want to upgrade to latest version all submodules:

```bash
git submodule update --remote --checkout
```

## Manually update all submodules

```bash
laptop> git submodule update --remote --rebase --recursive
```

Note: after that, if you have some submodules version not aligned (git status
warning you that some submodules changed):

```bash
laptop> git submodule update --init
```

Plugin list and shortcuts
-------------------------

I recommend reading the docs of these plugins to understand them better!

* [**console**] Console shortcuts
- `v` - open vim
* [**default**] General shortcut
- Tabs:
- `` - Open new tab
- ``, `` - Move from one tab to another
- `>>` - Increase identation
- `<<` - Decrease identation
- `Y` - copy to end of line
- `:w!!` - Allow saving of files as sudo when I forgot to start vim using sudo
- `` is configured as \
- `=` - will correct alignment of code
- `` (visual mode) - selects columns
- `` (insert mode) - cut selected text ( support the clipboard)
- `` (insert mode) - copy selected text ( support the clipboard)
- `` (insert mode) - paste selected text ( support the clipboard)
- `` + `Arrow` - move from a window to another.
- `` - close other windows.
- ``, ``, ``, `` - simplify the move from a window to another window.
- `:reg` - see nnamed registers.
- `"Np` - paste the Nth register's content.
- `y` or `d` or `c` + `/VALUE` - copy or delete or change from here to first occurrence of `VALUE`.
- `y` or `d` or `c` + `?VALUE` - copy or delete or change from the first occurrence of `VALUE` to here.
- `cNw` - change next N words (delete next N words and enter in `Insert mode`).
- `:copen` - open the QuickFix window.
- `:cnext` / `cprev` - move into the QuickFix window.
- `:set ignorecase! ignorecase?` - To switch between case sensitive and insensitive search.
- Ctags:
- `:ts /tofind` - tags search: search all definition and jump there. (note: you can use `TAB` for autocompletion and regex)
- `:ta tofind` - tags jump: search and jump. (note: you can use `TAB` for autocompletion)
- `g]` - Move the cursor on the word and press the combination to search like `ts` do.
- ` + ]` - Move the cursor on the word and press the combination to open the best matching in orizontal window.
- Preview
- ` + }` - the same as before, but open a preview window.
- `:ptn` - Preview the next matching tag.
- `:ptN` - Preview the previous matching tag.
- `:pc` - close preview window.
- Tag Stack
- `:[n]po` - Pop `n` items from tag stack (go up).
- `:[n]ta` - Push `n` items to tag stack (go up).
- `` `select rows` `` `write something` `` - multiple line editing.
- Font:
+ `` (ctrl-w and in same time `-`) - reduce the font.
+ `` - increase the font.
+ `` - set default size.
- Windows:
+ `=` - To resize all windows to equal dimensions based on their splits.
+ `:only` - close all the windows apart the current one.
+ ``, ``, ``, `` - to move from a window to another one.
+ ``, ``, ``, `` - to resize current window.
- Xml/Html tags
+ `d` or `y` or `v` + `at` - Delete/Copy/Select a pair of XML/HTML tags
+ `d` or `y` or `v` + `it` - Delete/Copy/Select the content of the XML/HTML tags
- Macro:
+ Register a macro and execute:
1. `qx` - start recording to register x
2. ... - make actions
3. `q` - stop recording
4. `@x` - playback to see if it works correctly
5. `999@x` - repeat 999 times to complete the job
+ Recursive macro (repeat until the end-of-file):
1. `qx` - start recording to register x
2. ... - make actions
3. `@x` - execute recursively the macro
4. `q` - stop recording
5. `@x` - playback to see if it works correctly
- Json
+ `:%!python -m json.tool` - Formatting json data.
* [**tricks**]
- `:%!column -t` - formatting a table of values.
- `:%!sort -kN` - sort table by column N.
- select with the mouse and paste with `p`.
* [**ack.vim**] Vim plugin for the Perl module / CLI script 'ack'
- `:Ack [options] {pattern} [{directories}]` - Search.
- `?` - a quick summary of these keys, repeat to close
- `o` - to open (same as Enter)
- `O` - to open and close the quickfix window
- `go` - to preview file, open but maintain focus on ack.vim results
- `t` - to open in new tab
- `T` - to open in new tab without moving to it
- `h` - to open in horizontal split
- `H` - to open in horizontal split, keeping focus on the results
- `v` - to open in vertical split
- `g`v - to open in vertical split, keeping focus on the results
- `q` - to close the quickfix window
* [**CmdlineComplete**] complete command-line (: / etc.) from the current file
- Type /ele and press Ctrl-P. So long as "elephant" is in the buffer, press and you will get "ele" completed into "elephant".
* [**MatchTagAlways**] always highlights the XML/HTML tags that enclose your cursor location.
* [**YouCompleteMe**] a code-completion engine for Vim.
* [**agit**] Sow repository history and commit details at the same time.
- `:Agit` - Show logs.
- `:AgitFile` - Show logs of the opened file.
* [**ctrlp.vim**] Finder for Vim
- `` - invoke CtrlP in find file mode
- `` - to navigate the result list.
- `` or `` (vertical), ``, `` - to open the selected entry in a new tab or in a new split.
- ``, filename:25 - to open file at line 25
- ``- to switch to filename search instead of full path
* [**ctrlp-funky**] It simply navigates and jumps to function definitions.
- `:CtrlPFunky` or `` - Go through the list of functions in the file
* [**ctrlp-modified.vim**] Easily open locally modified files in your git-versioned projects.
- `:CtrlPModified` - shows all files which have been modified since your last commit.
- `:CtrlPBranch` - shows all files modified on your current branch.
* [**delimitMate**] This plug-in provides automatic closing of quotes, parenthesis, brackets, etc.
* [**emmet-vim**] Vim plug-in which provides support for expanding abbreviations similar to emmet.
- Type abbreviation as `'div>p#foo$*3>a'` and type `Ctrl-y` + `,`.
* [**gundo.vim**] Graph your Vim undo tree in style.
- `u` - Toggle gundo interface.
- `` on a state - it will revert the contents.
- `p` on a state - preview window show the diff between your current state and the selected state.
* [**indentLine**] A vim plugin to display the indention levels with thin vertical lines
* [**mru**] Most Recently Used (MRU) Vim Plugin
- `mr` - Open list of recent files opened.
+ `o` - Open the file in a new horizontal window.
+ `O` - Open the file in a new vertical window.
+ `u` - Update file list.
+ `o` - Open next `` files.
+ `t` - Open file in a new tab (If the file is already opened in a window in the current or in another tab, then the cursor is moved to that tab).
- `:MRU text` - Display only file names matching "text" in them.
- `:MRU ` - Autocompleting name. Then, `` to open in a new window.
- `:MRU text` - Display list names matching "text".
* [**nerdcommenter**] Vim plugin for intensely orgasmic commenting
- `cc` - comment lines.
- `cl` - Same as `cc` except that the delimiters are aligned down the left side.
- `cu` - uncomment lines.
- `c` - toggle comments.
- `cy` - Same as `cc` except that the commented line(s) are yanked first.
- `[num]cc` - comment [num] lines.
- `` (normal mode) - toggle comment.
* [**nerdtree**]
- :NERDTree - open nerdtree
- `i` - Open the selected file in a horizontal split window.
- `s` - Open the selected file in a vertical split window.
- `I` - Toggle hidden files.
- `R` - Refresh the tree, useful if files change outside of Vim.
- `?` - Toggle NERD Tree's quick help.
- `mo` - To create a new file in selected directory.
- `vim [directory]` - open nerdtree
- `n` - toggle nerdtree
- `t` - open nerdtree and find the current file in the tree
* [**nerdtree-execute**] Plugin for NERD Tree that provides an execute menu item, that executes system default application for file or directory.
- `mx` - execute system default application for selected file/directory (e.g. open your favourite image editor for images).
* [**nerdtree-git-plugin**] A plugin of NERDTree showing git status.
* [**vim-numbertoggle**] Toggles between relative and absolute line numbers automatically.
- `:call NumberToggle()` - Enable/disable the plugin.
* [**open-browser**] Open URI with your favorite browser.
* [**open-browser-github.vim**] Open GitHub URL of current file, etc. from Vim editor.
- `:OpenGithubFile` - Opens current files URL in github.com.
- `:'<,'>OpenGithubFile` - Opens current files highlighted place in github.com.
- `:OpenGithubFile PATH/TO/FILE` - Opens a specific file in github.com.
- `:OpenGithubIssue 1` - Opens current repositories Issue #1.
- `:OpenGithubIssue 1 tyru/open-browser.vim` - Opens a specific repositories Issue #1.
- `:OpenGithubIssue` - Opens current repositories Issue List.
- `:OpenGithubIssue tyru/open-browser.vim` - Opens a specific repositories Issue list.
- `:OpenGithubPullReq` - The same of Issue, but this time open pulls page.
* [**screen**] Simulate a split shell in vim using gnu screen or tmux.
- `:ScreenShell yourcommand` - Run your command in a shell.
- `:ScreenShellReopen` - If you've started a shell using `:ScreenShell` or `:ScreenShellVertical` and exit that shell manually (^D, $ exit, etc) without running `:ScreenQuit`, then `:ScreenShellReopen` will re-open that shell again for you.
- `` + `Arrow` - To move cursor into the shell.
- `:ScreenSend` - Send the visual selection or the entire buffer contents to the running gnu.
- `IPython` - Start ipython on a shell.
- `[` - Scroll the tmux/screen window.
* [**scss-syntax.vim**] Vim syntax file for scss (Sassy CSS).
* [**UltiSnips**] The ultimate snippet solution for Vim.
- `` - Trigger action after snipped code selection.
- `` - Jump to the next tabstop.
- `` - Jump to the previous tabstop.
* [**sparkup**] A parser for a condensed HTML format.
- E.g. `#header > h1` + ``.
- `` - will cycle through empty elements.
* [**tagbar**] Vim plugin that displays tags in a window, ordered by scope.
- `tt` - Enable tagbar
* [**vim-airline**] lean & mean status/tabline for vim that's light as air
* [**vim-dispatch**] asynchronous build and test dispatcher.
* [**vim-expand-region**] allows you to visually select increasingly larger regions of text.
- Press `+` to expand the visual selection and `_` to shrink it (*not use keypad*).
* [**vim-erlang-compiler**] Erlang syntax checking and compiler plugin for Vim.
- `:lopen` - see list of errors, warnings.
- `:lnext` - move cursor to the next error, warning.
* [**vim-erlang-omnicomplete**] Erlang autocomplete plugin which gives Erlang support to the i_CTRL-X_CTRL-O keystroke.
* [**vim-erlang-runtime**] Erlang syntax and indentation built into Vim.
* [**vim-erlang-skeletons**] - Erlang generic templates for vim.
- Templates available:
- `:ErlServer` - Loads gen_server template into current buffer.
- `:ErlFsm` - Loads gen_fsm template into current buffer.
- `:ErlSupervisor` - Loads supervisor template into current buffer.
- `:ErlEvent` - Loads gen_event template into current buffer.
- `:ErlApplication` - Loads application template into current buffer.
- `:ErlTemplate [arg]` - Loads [arg] template into current buffer.
- Variable configuration: in your `.vimrc` put
- `let g:erl_author="My Name"` default: `whoami`
- `let g:erl_company="My Company"` default: `g:erl_author`
* [**vim-erlang-spec**] Generate specifications for your Erlang functions.
- `:ErlangSpec` - From inside the function, this command will produce specification for it. It won't fill in the argument types for you, though.
* [**vim-erlang-tags**] Erlang ctags-file generator plugin which makes Vim able to jump to definitions of functions, records, etc.
- `:ErlangTags` - Generate the tags.
- ``: jump to the definition of the function/record/macro under the cursor.
* [**Vim-fugitive**] Git wrapper
- `:Gbrowse` - To open the current file on GitHub, with optional line range (try it in visual mode!)
- `:Ggrep` - To search the work tree (or any arbitrary commit) with git grep.
- `:Gmove` - Does a `git mv` on a file and simultaneously renames the buffer.
- `:Gremove` - Does a `git rm` on a file and simultaneously deletes the buffer.
- `:Gblame` - Brings up an interactive vertical split with `git blame` output. Press enter on a line to edit the commit where the line changed, or `o` to open it in a split. When you're done, use `:Gedit` in the historic buffer to go back to the work tree version.
- resolving merge conflicts with vimdiff
+ `:Gvdiff` - Open 3 split windows.
+ `[c` - Jump to previous hunk.
+ `]c` - Jump to next hunk.
+ `:diffget //2` (from left window) or `diffget //3` (from right window) - Get changes from left/right window (you are in central window).
+ `:diffupdate` - update diffs.
+ `:only` - Cose all windows apart from the current one.
+ `:Gwrite!` - Write the current file to the index (use the target version or merge version depending on which window you are).
* [**vim-gitgutter**] Vim Git Gutter is a Vim plugin which shows a git diff in the 'gutter' (sign column).
- `g` - (On the row modified) Preview the hunk the cursor is in.
- `hr` - Revert the hunk the cursor is in.
- `]c` and `[c` - jump to next/previous hunk (change).
* [**vim-isort**] Vim plugin to sort python imports using isort
- `:Isort` or `` - sort python import
* [**vim-javascript**] Vastly improved Javascript indentation and syntax support in Vim.
* [**vim-jinja**] Jinja templates support for Vim.
* [**vim-move**] Plugin to move lines and selections up and down.
- `` - (visual mode) move the rows up.
- `` - (visual mode) mode the rows down.
* [**vim-multiple-cursors**] True Sublime Text style multiple selections for Vim.
- `` - Activate multiple selection and select next.
- `` - Skip next.
- `` - Go back to the previous virtual cursor location.
- `` - To exit back to regular Vim.
- `v` - Start to work on multiple selections.
* [**vim-pathogen**] It makes it super easy to install plugins.
* [**vim-phpqa**] PHP QA tools for Vim
* [**vim-ref**] Integrated reference viewer.
- `K` - Open documentation for the method, class, ...
* [**vim-snipmate**] snipMate & UltiSnip Snippets.
* [**vim-surround**] quoting/parenthesizing made simple.
- `ds'` - remove the delimiter (e.g. from `'hello'` to `hello`)
- `cd'""` - replace a delimiter with another one (e.g. from `'hello'` to `"hello"`)
- `v` + select text + `S[` - add a delimiter `[ ]`
- `v` + select text + `S

` - add a delimiter `

`. e.g. `

fuuu

`
- If you use `[`, it adds delimiter with a space. If you add `]`, it adds delimiter without space`]`
* [vim-syntastic] syntax checking plugin for Vim.