Saturday, February 4, 2012

VIM as an Universal IDE{Part 1 (Python/Django)}



Vim is My First and Last editor ,IDE, or you can say most of time i spend on it  while work on system .

I write this blog for newbies , those who new to both Linux and Programming.Also for professionals and passionate guys.Also give a look if you are using  different editor then Vim for any Programming language .I write everything that a newbie need to know from installation to configuration , from novice to advance
Any suggestions ! Comments Welcome !here

More about Vim 
Vim is worth millions and costs nothing. It's the best editor the world has
ever seen. Using the trio Vim/Perl/LaTeX I can dispose of most other software.

More To do :

1. Get VIM for Dos
2. Get VIM for Linux
3. Get Vim for Freebsd
4. Get Vim for Dec-Unix
5. Get VIM for Irix
6. Get VIM for Window
7. Get VIM for Mac
8. Laugh at non-VIM users



Basic Introduction :- I Know for Beginner's ,Newbie for Linux ,Vim Need to get in with this From a basic . Following Question can asked by a newbie to Vim
Note:- Please experts those know vim well or For geeks those know it well go below some (stuff is there ) 
   1) May you don't know install Vim on Your's OS(Linux,Mac,Unix etc)
   2) May be you don't know how to open Vim on your OS
   3) May Be You Don't know how install plugin for it
   4) May Be You Don't know how to close it

 Okay before answering you all guys , It work for a large range of Operating System's such as Linux,Mac,Window ,Unix , FreeBSD ..much more.It provide both Command line and GUI interface .


1)Installing Vim
     A)For Linux User's :-                

a) For Ubuntu/Debian user's :- sudo apt-get install vim            
b) For Fedora user's :-  yum install vim-X11 vim-common vim-enhanced vim-minimal
c) For Red-hat Linux user's :- up2date -i vim-X11 vim-common vim-enhanced vim-minimal
d) For Arch Linux user's:- pacman -S vim              
e) For Fedora user's:- emerge vim

B)For  Mac User's :- MacVim is the text editor for Mac OS X , download it form here http://code.google.com/p/macvim/

C)For  Window User's :-Go to  Vim Download page and click on “PC: MS-DOS and MS-Windows”. Click on the ‘gvim72.exe, which is a Self-installing executable.
(or) Download gvim72.exe directly.          
For All Others Visit download page on http://www.vim.org/download.php


2) Opening or Simple use of Vim
   You  can open a using command line :- use vi/vim  in start of any file name or any file you want open like below        
   $ vim hack.txt                  
   above use of vim with hack.txt file to open

Vim has two mode visual mode (GUI mode) and insert mode(command line mode).     To Switch in Between them press Esc on your keyboard and then Press i for Insert mode and v for visual mode on your keyboard .Esc play a important role for switch you any command . Or you can use Crtl+c ,that is an alternative of Esc .

Note : If not get now also ,then Visit you sure got all open close and simple to advance use link below    http://www.openvim.com/tutorial.html

3)  Vim have need to have two special area where all vim operate or contains  .Let me Explain
          1) create a ~/.vim directory
          $ mkdir ~/.vim            
          $ cd ~/.vim          
Note:- this Contain all your plugin installation.
       
          2) Now create file .vimrc under your bash or command terminal                  
           $vim .vimrc                  
Above will create and open .vimrc file in your bash and command terminal            

Note:- This contain information about your  configuration of vim and it's plugins

4)  Close it with press ESc on your Keyboard and then shift + : , then enter wq , wq! , q!            
 these all can use close the vim


Now Vim from Scratch to Novice (You can  say from level 1 to level 2 ):

Just visit and learn there the best online Tutorial  http://www.openvim.com/tutorial.html

Now move on Real topic Vim as Universal IDE(Integrated Development Environment ):-


 1) Vim as Python/Django IDE :-


 i) Now you need to use ~/.vim and .vimrc i as tell you earlier  Now first step set a better color-scheme wombat,download wombat.vim http://files.werx.dk/wombat.vim

Now under after downloading under ~/.vim/colors    
$ mkdir -p ~/.vim/colors          
$ cd ~/.vim/colors          
$ wget -O wombat.vim http://files.werx.dk/wombat.vim
$ vim
Now in vim press shift + : ,then enter color wombat like below          
$:color wombat
Now after perfect looking move on !!


ii) For Syntax Error and Formatting (Indent):-
This can used for indentation or formatting every language need formatting and indentation  of that language .This indentation script for python tries to match more closely what is suggested in PEP 8 (http://www.python.org/peps/pep-0008.html).  In particular, it handles continuation lines implied by open (parentheses), [brackets] and {braces} correctly and it indents multiline if/for/while statements differently.  Comments are welcome!
install details

Drop the script in your ~/.vim/indent directory.
$mkdir ~/.vim/indent $ cd ~/.vim/indent  
$ wget -O python.vim http://www.vim.org/scripts/download_script.php?src_id=4316

download page is here http://www.vim.org/scripts/script.php?script_id=974

Now config this in .vimrc    
$ vim .vimrc    
add below  to .vimrc
filetype plugin indent on



iii) Special highlighting for String  and String formatting (Python.vim) :-        

Enhanced version of the original (from vim6.1) python.vim for Python programming language.
The changes since the original python.vim are:
- changed strings highlighting;
- enhanced special symbols highlighting inside strings;
- enhanced numbers highlighting;
- added optional highlighting for %-formatting inside strings;
- added highlighting for some error conditions (wrong symbols in source file,  
mixing spaces and tabs, wrong number values,  
wrong %-formatting inside strings);
- added highlighting for magic comments: source code encoding
 and #! (executable) strings;  - added highlighting
for new exceptions and builtins introduced in python 2.3, 2.4 and 2.5;
- added highlighting for doctests;
- added highlighting for new @decorator syntax introduced in Python 2.4a2;
- added highlighting for trailing-space errors (triggered by new  option: python_highlight_space_errors);
- added highlighting for variable name errors;
- added highlighting for hex number errors;

install details
Place python.vim file in ~/.vim/syntax/ folder.

$mkdir ~/.vim/syntax
$cd ~/.vim/syntax
$wget -O python.vim http://www.vim.org/scripts/download_script.php?src_id=14268 or download page

download page is here http://www.vim.org/scripts/script.php?script_id=790          

Also put config in .vimrc is below
autocmd FileType python set complete+=k~/.vim/syntax/python.vim isk+=.,




( iv) Highlighting Syntax and validation  :-
a) PyFlakes
IMPORTANT: Your vim must have Python 2.5, at least. Enter ":python import sys; print sys.version" to see which version you have.
 The newest version of Vim, 7.3, comes bundled with Python 2.7 support.  pyflakes-vim highlights common Python errors like
misspelling a variable name on the fly. It also warns about unused imports, redefined functions, etc.

install details
1. Make sure your vimrc has "filetype plugin indent on"
so that pyflake-vim's ftplugin files are loaded automatically when you open a Python buffer.
2. Drop extracted files in ~/.vim/ftplugin/python.
3. That's it!

Download page link here  http://www.vim.org/scripts/script.php?script_id=2441
Direct unzip this pyflakes into ~/.vim
Config setting of .vimrc is below
let g:pyflakes_use_quickfix = 0

 b) Pep8        
install inside ~/.vim/ftplugin/python
Download page http://www.vim.org/scripts/script.php?script_id=2914
now switch to ~/.vim/ftlugin/python          
$cd ~/.vim/ftplugin/python          
$ wget -O pep8.vim http://www.vim.org/scripts/download_script.php?src_id=14366

Configuration for .vimrc  put below in your config file .vimrc

let g:pep8_map='<leader>8' set expandtab
set textwidth=79
set tabstop=8
set softtabstop=4
set shiftwidth=4
set autoindent    



v)Code Navigation :-
Catgs  this my best plugin for vim it can use for all programming language's and with this taglist is best for source code navigation .
Install a direct package only for Ubuntu else do manually is below
# apt-get install exuberant-ctags

first download ctags from here http://ctags.sourceforge.net/ .Ctags help you in while browsing a source code file:

Navigating to the function definition by specifying the function name.
Navigating to the function definition from ‘function call’.
Returning back again to function call from the definition.
Viewing the prototype/signature of functions or variables.
Viewing the number of functions in a file, etc., now extract ctags.tar.gz

then do this for configure and install ./configure && sudo make install

after that Config you .vimrc as below
let Tlist_Ctags_Cmd='/usr/local/bin/ctags'
set tags=./tags;/
map <C-\> :tab split<CR>:exec("tag ".expand("<cword>"))<CR>
map <A-]> :vsp <CR>:exec("tag ".expand("<cword>"))<CR>


Best use of this plugin with following command is below :- C-] - go to definition
C-T - Jump back from the definition.
C-W C-] - Open the definition in a horizontal split
C-\ - Open the definition in a new tab A-] - Open the definition in a vertical split

After the tags are generated. You can use the following keys to tag into and tag out of functions:

Ctrl-Left_MouseClick - Go to definition Ctrl-Right_MouseClick - Jump back from definition


Taglist :- with ctag for browsing source code better ,switch to ~/.vim/plugin
$ mkdir ~/.vim/plugin
$cd ~/.vim/plugin
$ wget -O taglist.zip http://www.vim.org/scripts/download_script.php?src_id=7701

direct download link is here http://www.vim.org/scripts/script.php?script_id=273

Config for .vimrc like below  " Taglist variables

" Display function name in status bar:
let g:ctags_statusline=1
" Automatically start script
let generate_tags=1
" Displays taglist results in a vertical window:
let Tlist_Use_Horiz_Window=0
" Shorter commands to toggle Taglist display
nnoremap TT :TlistToggle<CR>
map <F4> :TlistToggle<CR>
" Various Taglist diplay config:
let Tlist_Use_Right_Window = 1
let Tlist_Compact_Format = 1
let Tlist_Exit_OnlyWindow = 1
let Tlist_GainFocus_On_ToggleOpen = 1
let Tlist_File_Fold_Auto_Close = 1




Tasklist with Ctags for better manipulation


switch ~/.vim/plugin
download there this direct http://www.vim.org/scripts/script.php?script_id=2607
$ cd ~/.vim/plugin
$wget -O tasklist.vim http://www.vim.org/scripts/download_script.php?src_id=10388

Config .vimrc
map T :TaskList<CR>
map P :TlistToggle<CR>
use tasklist with T and P to use this



vi) Code Completion :-    
A) Python Omni  completion  place this in ~/.vim/autoload download direct link here
$ cd ~/.vim/autolaod http://www.vim.org/scripts/script.php?script_id=1542
$ wget -O pythoncomplete.vim http://www.vim.org/scripts/download_script.php?src_id=10872  

add your config to your .vimrc is below
filetype plugin on
set ofu=syntaxcomplete#Complete


B) Pydict for python code completion
download zip direct to ~/.vim/ftplugin  and extract  download page link here
http://www.vim.org/scripts/script.php?script_id=850

config your .vimrc with below stuff
let g:pydiction_location = 'C:/vim/vimfiles/ftplugin/pydiction/complete-dict'


C) Supertab for pydict easy completion :-
create a ~/.vim/after/ftplugin
download to it direct from this page http://www.vim.org/scripts/script.php?script_id=1643

Install this now using :- Open the file in vim ($ vim supertab.vba).

 Source the file (:so %)
use to press tab to complete the code

add in .vimrc
let g:SuperTabDefaultCompletionType = "context"




vii) Basic editing and debugging(pep8 ,pyflake is used above) ,code snippets:- 

A) Code snippets(snippetEMU) :-
The same thing works for “for” loops, classes and many other constructs. The bundles .vba provides access to such constructs across a wide range of languages, e.g. Python, Ruby, HTML, PHP, even Djano-specific constructs.

create a ~/.vim/after/ftplugin
download page link is here http://www.vim.org/scripts/script.php?script_id=1318

now install it above  open with vim snippy_plugin.vba then source the file (:so%)

B) snipMate:-it aims to be an unobtrusive, concise vim script that implements some of TextMate's snippets features in Vim. A snippet is a piece of often-typed text that you can insert into your document using a trigger word followed by a <tab>.   For instance, in a C file using the default installation of snipMate.vim, if you type "for<tab>" in insert mode, it will expand a typical for loop in C:  for (i = 0; i < count; i++) {  }

just download zip and extract in ~/.vim
Download page is here   http://www.vim.org/scripts/script.php?script_id=2540

C) Code folding
put this in ~/.vim/ftplugin
download from this page http://www.vim.org/scripts/script.php?script_id=1494

D)Block navigation :-This script can be useful when editing Python scripts.
It provides the following menus:
- Select a block of lines with the same indentation
- Select a function
- Select a class
- Go to previous/next class/function
- Go to the beginning/end of a block
- Comment/uncomment the selection
- Jump to the last/next line with the same indent

install details
Copy to the $VIMFILES/ftplugin directory download page is here

http://www.vim.org/scripts/script.php?script_id=30

E)Minibuffexpl.vim:-  download  here http://www.vim.org/scripts/script.php?script_id=159
paste in ~/.vim/plugin

config for .vimrc is below
let g:miniBufExplMapWindowNavVim = 1
let g:miniBufExplMapWindowNavArrows = 1
let g:miniBufExplMapCTabSwitchBufs = 1
let g:miniBufExplModSelTarget = 1




viii)Directory   Navigation:-Nerdtree download page  http://www.vim.org/scripts/script.php?script_id=1658

      install details
      Unzip the archive into your ~/.vim directory.
     That should put NERD_tree.vim in ~/.vim/plugin and NERD_tree.txt in ~/.vim/doc.


ix)Git integration with vim :- download page is here http://www.vim.org/scripts/script.php?     script_id=2975
    just extract zip in ~/.vim    

x) For automatic closing of quotes, parenthesis, brackets:-   delimitMate
    Download page is here http://www.vim.org/scripts/script.php?script_id=2754
 
   download this in ~/.vim/after/ftplugin , Now install using below

   Open the file with Vim and run:
   :UseVimball

   or use this command to install it in your bundle dir if you use pathogen:
   :UseVimball ~/.vim/bundle/delimitMate /              



Note:- Stay Tuned more parts of this Post coming soon for Ruby,C++,C,Closure,Prolog ,Haskell,Java,PHP,Perl,Shell, JavaScript ,HTML,CSS Coming soon (within few Days) .
Update of this post will done soon for Usage of plugin and more config Details .


THANKS FOR VISITING


LHS AS A SOURCE OF INFORMATION – AND A SOURCE OF INSPIRATION – I HOPE YOU’LL CHOOSE TO ACT RIGHT NOW.ENJOY KEEP LEARNING.




4 comments:

  1. Yeah, this stuff matters, and I would not be a programmer if Vim didn't exist. Without vim, there is no joy in coding. ;)

    ReplyDelete
  2. NERDTree is for directory navigation, not really project navigation.

    ReplyDelete