Customization

Customization

The master branch

TODO

The experimental branch

~/.vimrc.before

This file is sourced before any other file or plugin. Janus core is loaded before this script, so you get access to all the functions defined in janus.vim.

This is perfect for setting things like the mapleader. Because any mappings using the <leader> keywords that is parsed before changing the mapleader, the mapleader won't have any effect on them.

~/.vimrc.after

~/.vimrc.after is loaded after Janus and all other plugins are loaded. This allows you to override anything set by Janus or any plugin.

This is useful for re-mapping some of the bindings to your liking, setting the colorscheme, changing the encoding or the expandtab, ect.

Adding a new plugin, color-scheme, ...

To add a new plugin, a new color-scheme or anything else use git sub-modules. You should only use the custom group located at janus/vim/custom for your custom stuff.

Even if not every vim-script hosted on vim.org has a git repository (by the author or a mirror), you can easily get a git repository for it using Vim-scripts Github mirror.

The custom group will be loaded before any other group, except of course the core group. This will ensure that your version of any already-installed plugin will be loaded instead. If you have a new version (or another fork) of a plugin, just add it to your custom folder and it will be loaded first.

WARNING: Any uncommited file inside the janus folder and outside the custom folder will be removed the next time your run rake. Make sure to either put them in the custom folder, or entirely outside the janus folder or commit them with Git. We clean the janus folder in case we replace a manually installed plugin (using rake tasks) with a submodule.

Disabling a plugin

Janus makes it easy to disable any included plugin, color-scheme, lang etc. Disabling a plug-in is done within your ~/.vimrc.before file using the janus#disable_plugin() method. This methods takes two arguments: the plugin name and optionally the reason for disabling the plugin. If reason is given, all bindings that Janus binds to the plugin will still be bind but the action will just be an echo that the plugin is disabled. For example:

Janus adds the binding <C-t> or <D-t> on MacVim to open the Command-t plugin which requires Vim built with ruby support. If your Vim is not built with ruby support, your Vim will not throw errors about it because Janus will disable the plugin automatically. However, if you try <C-t> or <D-t> (you might expect that nothing happens but..) the following message appears in the command-line area:

The plugin command-t is disabled for the following reason: Vim is compiled without ruby support.

Here's the signature of the janus#disable_plugin function. You might notice in the source code that it supports specifying the group as well, but since this feature is not working yet, please ignore it.

" Disable a plugin
"
" @param [String] The plugin name
" @param [String] The reason why it is disabled
" @return [Bool]
function! janus#disable_plugin(...)
endfunction

Disabling a plugin in ~/.vimrc.before example:

" Disable command-t because I don't like it, but keep the bindings to remind me
call janus#disable_plugin('command-t', "I don't like it")

" Disable Hammer because it doesn't work and remove the bindings
call janus#disable_plugin('hammer')