Skip to content

README.md

Latest commit

 

History

History
153 lines (112 loc) · 3.39 KB

README.md

File metadata and controls

153 lines (112 loc) · 3.39 KB

DotVim Configuration

A modern, organized Vim configuration with sensible defaults and carefully selected plugins.

Table of Contents

Overview

This Vim configuration provides a clean, efficient environment for coding with modern features like:

  • Code completion
  • Syntax checking and linting
  • Git integration
  • File navigation
  • Snippets
  • And more...

Features

  • Organized plugin structure categorized by functionality
  • Documented key mappings for easy reference
  • Modern plugin management with vim-plug
  • Language-specific settings for consistent formatting
  • Productivity enhancements for faster coding

Installation

Requirements

  • Vim 8.0+ recommended (minimum 7.4)
  • Git
  • Node.js (for some language servers)
  • Python (for YouCompleteMe)

Installation Steps

You can use the provided installation script for a quick setup:

# Clone the repository
git clone git@github.com:cloudartisan/dotvim.git
cd dotvim

# Run the installation script
./install.sh

Or manually:

# Clone the repository
git clone git@github.com:cloudartisan/dotvim.git ${HOME}/.vim

# Create symlinks
ln -s ${HOME}/.vim/vimrc ${HOME}/.vimrc
ln -s ${HOME}/.vim/vimrc ${HOME}/.gvimrc

# Install vim-plug
curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
  https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim

Plugin Installation

After the basic installation, you need to install the plugins:

# Install all plugins
vim +PlugInstall +qall

The installation script will automatically install plugins for you if you use it.

Compiling YouCompleteMe

The YouCompleteMe plugin requires compilation:

cd $HOME/.vim/bundle/YouCompleteMe
./install.py --clang-completer

Testing Your Configuration

This repository includes a test script to verify your vimrc configuration:

# Run the test script from the repository root
./test_vimrc.sh

The script checks for:

  • Syntax errors in vimrc
  • Essential settings
  • Plugin structure
  • Required plugins
  • Key mappings
  • Language configurations

Usage

Key Mappings

Key mappings are documented in the vimrc file. Here's a quick reference:

Mapping Description
\<tab> Toggle NERDTree file browser
\n Toggle line numbers
\p Toggle paste mode
\s Toggle sign column
\l Toggle location list
\q Toggle quickfix list
\t Toggle tag browser
\j Go to next error/warning
\k Go to previous error/warning
Ctrl+h/j/k/l Navigate splits (left/down/up/right)

Customization

Adding Plugins

Add plugins to vimrc between these lines:

call plug#begin()
[...]
call plug#end()

Plugin format:

Plug 'username/repo-name'

Language Configuration

Language-specific settings for indentation, syntax highlighting, etc. are included in the vimrc. Add or modify as needed for your preferred languages.