Vim distribution
This is a distribution of plug-ins and mappings for Vim, Gvim and MacVim.
It is designed to provide minimal working environment using the most popular plug-ins and the most common mappings.
The distribution is completely customisable using a
~/.vimrc.beforeand
~/.vimrc.afterVim RC files.
To update to the latest version of the distribution, just run
rakeinside your
~/.vimdirectory.
NOTE: If you ever have an error updating Janus relating to a missing commit in a submodule, please try running
rakeagain before submitting an issue.
The mailing list is hosted at Google Groups, please join it for discussion and announcements.
The distribution is designed to work with Vim >= 7.3.
The distribution also requires
ack,
ctags,
git,
rubyand
rake. For the most comfortable experience, use the GUI version of Vim. Linux users should install
gvim, OSX users should install MacVim. The recommended way of installing MacVim is using Homebrew, but before installing MacVim you need to use system-wide Python (If you are using python that is):
pythonbrew off
$ brew install macvim
If you don't use Homebrew, you can still download MacVim here.
Take a look at the Pre-requisites wiki page for more information.
To install Janus, please use our automatic installer , which backs up any Vim files found in your home folder and installs Janus.
$ curl -L https://bit.ly/janus-bootstrap | bash
You can use
~/.gvimrc.beforeand
~/.vimrc.beforefor settings Janus itself uses, such as the leader setting. You may also use
~/.gvimrc.afterand
~/.vimrc.afterfor any additional settings; it is also a good place for overriding Janus settings, as both files will be loaded at the end of Janus.
For example, to override the default color schemes:
$ echo 'color desert' >> ~/.vimrc.after $ echo 'color molokai' >> ~/.gvimrc.after
If you want to do additional customization or add more Vim plugins, create a
~/.janusdirectory and add your plugins there, either with a
git cloneor by adding submodules to your own git repository there. This directory is treated like a normal pathogen directory. For example:
$ cd ~/.janus $ git clone https://github.com/vim-scripts/Rename2.git rename2
Or, if you have a git repository in
~/.janus, you can use a submodule:
$ cd ~/.janus $ git submodule add https://github.com/vim-scripts/Rename2.git rename2
If you would like to disable an included plug-in, you can do that with the
janus#disable_plugin()function from inside your
~/.vimrc.before. This function takes a plug-in name as an argument without the group. For example, if you would like to disable the NERDCommenter plug-in, you can do that with the command:
$ echo "call janus#disable_plugin('nerdcommenter')" >> ~/.vimrc.before
WARNING: We've noticed over and over, that people fork Janus just to customize it. This is bad practice for several reasons and you should not do that, and here's why:
~/.janusfolder is for.
If you find yourself needing a customisation that is not possible with the current setup, then please open an issue or consider submitting a pull request to make it possible to continue using/improving the official repo.
WARNING: Any uncommited files inside the janus folder will be removed the next time you run
rakeso make sure to either put them in the custom folder (
~/.janus), or commit them. We clean the janus folder in case we replace a manually installed plugin (using rake tasks) with a submodule.
For more information on how to customize Janus, you might want to take a look at the Customization wiki page. Additional you can see Example of customization.
Here're some tips in case you've never used VIM before:
vimtutorinto a shell to go through a brief interactive tutorial inside VIM.
i
v
:qto exit vim
\by default. You can, for example, use
let mapleader = ","to change this to a comma. If you want this to be in effect for uses of in the .vimrc file, make sure to define this in
~/.vimrc.before
This Vim distribution includes a number of packages built by others.
Janus ships with a number of basic customizations for vim:
.
ewexpands to
:e (directory of current file)/(open in the current buffer)
esexpands to
:sp (directory of current file)/(open in a horizontal split)
evexpands to
:vsp (directory of current file)/(open in a vertical split)
etexpands to
:tabe (directory of current file)/(open in a new tab)
:SudoWor
:SudoWrite, it will prompt for sudo password when writing
fefformats the entire file
uconverts the entire word to uppercase
lconverts the entire word to lowercase
Uconverts the first char of a word to uppercase
Lconverts the first char of a word to lowercase
cdchanges the path to the active buffer's file
mdcreates the directory of the active buffer's file (For example, when editing a new file for which the path does not exist.)
gwswaps the current word with the following word
ulunderlines the current line with
=
twtoggles wrap
fcfinds the next conflict marker (tested with Git conflicted files)
gjand
gk(Wrapped text is not considered a single long line of text.)
hstoggles highlight search
=adjusts viewports to the same size (
=)
(on MacVim) shifts current line or selected lines rightwards
(on MacVim) shifts current line or selected lines leftwards
!invokes kwbd plugin; it closes all open buffers in the open windows but keeps the windows open
Ack.vim uses ack to search inside the current directory for a pattern. You can learn more about it with :help Ack.
Customizations: Janus rebinds command-shift-f (
) to bring up:Ack.
Fuzzy file, buffer, mru and tag finder. Replaces Command-T
Customizations: For users of Command-T Janus maps CtrlP to command-t (
)NERDCommenter allows you to wrangle your code comments, regardless of filetype. View
:help NERDCommenterfor all the details.
Customizations: Janus binds command-/ (
) to toggle comments.NERDTree is a file explorer plugin that provides "project drawer" functionality to your vim projects. You can learn more about it with :help NERDTree.
Customizations: Janus adds a number of customizations to the core NERDTree:
nto toggle NERDTree
This plugin provides a lot of useful mappings, here's a brief example of what it does provide:
[bto go to the previous buffer
]bto go to the next buffer
[nto go to the previous SCM conflict marker
]nto go to the next SCM conflict marker
:help unimpairedfor a complete list
In insert mode, start typing something and hit
to tab-complete based on the current context.Syntastic is a syntax checking plugin that runs files through external syntax checkers as they are saved and opened. If syntax errors are detected, the user is notified and is happy because they didn't have to compile their code or execute their script to find them.
:help syntasticfor more information.
Tagbar is a vim plugin for browsing the tags of source code files.
Customizations: Janus binds
rtto toggle Tagbar.
SnipMate defines text snippets (a series of characters) that expand to a useful piece of code when tab is pressed. For example, in a Ruby file, def
expands to: ```ruby def method_nameend ``` After typing in the method name, press tab again to put the cursor right where you want it on the next line. This repository has a full list of the Snippets that are available in Janus.
EasyMotion provides a much simpler way to use some motions in vim. It takes the
out ofwor
f{char}by highlighting all possible choices and allowing you to press one key to jump directly to the target.
When one of the available motions is triggered, all visible text preceding or following the cursor is faded, and motion targets are highlighted.
EasyMotion is triggered by one of the provided mappings.
check EasyMotion's home page for more information.
Narrowing means focussing on a region and making the rest inaccessible. You simply select the region, call :NarrowRegion and the selected part will open in a new scratch buffer. The rest of the file will be protected, so you won't accidentally modify that buffer. In the new buffer, you can do a global replace, search or anything else to modify that part. When you are finished, simply write that buffer (e.g. by |:w|) and your modifications will be put in the original buffer making it accessible again.
Fugitive adds pervasive git support to git directories in vim. For more information, use
:help fugitive
Use
:Gstatusto view
git statusand type
-on any file to stage or unstage it. Type
pon a file to enter
git add -pand stage specific hunks in the file.
Use
:Gdiffon an open file to see what changes have been made to that file
customizations:
gbmaps to
:Gblame
gsmaps to
:Gstatus
gdmaps to
:Gdiff
glmaps to
:Glog
gcmaps to
:Gcommit
gpmaps to
:Git push
A Vim plugin which shows a git diff in the 'gutter' (sign column). It shows whether each line has been added, modified, and where lines have been removed. You can also stage and revert individual hunks.
When working with split windows, ZoomWin lets you zoom into a window and out again using
Ctrl-W o
Customizations: Janus binds
zwto
:ZoomWin
Better JSON and JSONP with distinct highlighting for keywords versus values, strings colored differently from numbers and booleans and double quotes concealed (disable with
let g:vim_json_syntax_conceal = 0in
~/.vimrc.after, folding of {...} and [...] blocks (enable with
:setlocal foldmethod=syntax, and JSON-specific warnings highlighted in red.
Buffergator is a plugin for listing, navigating between, and selecting buffers to edit. Upon invocation (using the command,
:BuffergatorOpenor
BuffergatorToggle, or the provided key mapping,
b), a
catalogof listed buffers are displayed in a separate new window split (vertical or horizontal, based on user options; default = vertical). From this "buffer catalog", a buffer can be selected and opened in an existing window, a new window split (vertical or horizontal), or a new tab page.
Selected buffers can be "previewed", i.e. opened in a window or tab page, but with focus remaining in the buffer catalog. Even better, you can "walk" up and down the list of buffers shown in the catalog by using
(or ) / (or ). These keys select the next/previous buffer in succession, respectively, opening it for preview without leaving the buffer catalog viewer.VRoom is a plugin inspired by Gary Bernhardt's vim config for running your ruby tests/specs/features.
Imagine you're hacking on a Rails controller, when you switch to the test or specs for the controller, you can use
rto run all the specs or
Rto run the closest spec, then you can jump back to the controller hack on it and use
rto run the last spec you ran last time, so you don't need to open the test again.
Then benefits of this plugin are to centralize your workflow in one window, one software to do it all, which is a huge speedup over using
tmuxor multiple terminal tabs.
Out of the box, all you need to know is a single key
Ctrl-n. Pressing the key in Normal mode highlights the current word under the cursor in Visual mode and places a virtual cursor at the end of it. Pressing it again finds the next occurrence and places another virtual cursor at the end of the visual selection. If you select multiple lines in Visual mode, pressing the key puts a virtual cursor at every line and leaves you in Normal mode.
More at QuickStart
This plugin causes all trailing whitespace to be highlighted in red.
To fix the whitespace errors, just call :FixWhitespace. By default it operates on the entire file. Pass a range (or use V to select some lines) to restrict the portion of the file that gets fixed.
Janus ships with a few additional syntaxes:
g:disable_markdown_autostylein
~/.vimrc.before=>
let g:disable_markdown_autostyle = 1)
nodejsin the shebang.
EDITORto
vim -for
mvim -fon OSX)
$ echo "export EDITOR='vim -f'" >> ~/.bashrc, you can also use Git global config to set this if you have EDITOR set to something else
$ git config --global core.editor 'vim -f'
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.