/vimcake

A simple vim configuration package for beginners!

Primary LanguageVim Script

🍰 VimCake 🍰

A simple vim configuration package for beginners!

Ideal for 42 school students, but not only!

Plugins list:

  • vim-42header
  • vim-airline
  • vim-monokai
  • vim-plug
  • vim-snippets
  • Colorizer
  • NERDTree
  • Syntastic
  • UltiSnips

How to install

  • 💾 - If you want to keep your current vim configuration, backup your files first!

Use the following command in a terminal:

make install
  • ⚠️ - Make sure you don't already have a vim configuration before installation

Or use this one to delete any vim configuration before install:

make re

The package can be removed with:

make clean

42 Header

42 Header can be added to your files by pressing F2.

Username and mail can be edited in your ~/.vimrc (Section <Plugins config>).

Another simple solution is to use arguments with make by using variables during installation:

make install USER="username" UMAIL="user" DOMAIN="domain"
# Set header username to "username" and email address to "user@domain"
make install USER="username"
# Set header username to "username" and email address to "username@student.42.fr"
make install UMAIL="user"
# Set header username to $USER and email address to "user@student.42.fr"

UMAIL variable takes $USER content by default

DOMAIN variable is set to "student.42.fr" by default

Autocompletion:

Crush your damn Tab key! For example, if you type in a C file:

if|

And then you press Tab, it'll load a snippet and move your cursor in the condition field:

if (|)
{
  
}

Now you can add a condition:

if (1 && 0|)
{
  
}

Press Tab again to move your cursor to the next field (inside brackets in this case):

if (1 && 0)
{
  |
}

It works with:

  • if -> if Tab
  • else -> else Tab
  • while -> while Tab

and especially for C/C++ files:

  • include -> inc Tab
  • main -> main Tab (with arguments) or mainn Tab (without arguments)

... and more!

Color visualizer

Colorizer allows detection of text that contains a RGB or RGBa color by coloring its background

See the documentation for more details.

File explorer:

Press Ctrl+n inside vim to open/close NERDTree.

NERDTree is shown by default if you start vim with a directory as argument.

Folding

Press F3 to fold/unfold your code.

Very handy with huge files!

User Interface

monokai, which has been slightly modified, is the current colorscheme used and airline-theme is set to dark.

Some adjustments have been made in the vim configuration file to make vim more pleasant and convenient to use!

Version

Current version is 0.2.1-pre

Changelog can be seen here