Skip to content

Latest commit

 

History

History
114 lines (93 loc) · 4.21 KB

README.md

File metadata and controls

114 lines (93 loc) · 4.21 KB
Raw

CDO_lazy_vim README

If you are using vi/vim/gvim for scripting with cdo, you can sometimes hardly remember cdo commands or you are just too lazy to type out "sellonlatbox" all the time, this might be something for you.

animation

Configuration instructions

  • Add the lines of "add_cdo_complete_to_your_vimrc" to your "~/.vimrc" to include the complete function 
cat add_cdo_complete_to_your_vimrc >> ~/.vimrc

Optional:

  1. Variable completion: Set a file path and 'ENABLE' vars_completion in your ".vimrc"
    animation
  2. If you want to use <Tab> for auto-completion like in your shell, add those lines to your .vimrc
    FIXME: Doesnt replace yet, but only 
" Use TAB to complete when typing words, else inserts TABs as usual.
" Uses dictionary and source files to find matching words to complete.
" "See help completion for source,
" Note: usual completion is on <C-n> but more trouble to press all the time.
" Never type the same word twice and maybe learn a new spellings!
" Use the Linux dictionary when spelling is in doubt.
" Window users can copy the file to their machine.
function! Tab_Or_Complete()
  if col('.')>1 && strpart( getline('.'), col('.')-2, 3 ) =~ '^\w'
    return "\<C-N>"
  else
      return "\<Tab>"
  endif
endfunction
:inoremap <Tab> <C-R>=Tab_Or_Complete()<CR>

Source: http://vim.wikia.com/wiki/Smart_mapping_for_tab_completion
The usual <Tab> command will still be executed when no completion is feasable, eg. in the beginning of (empty) lines
3. If you fancy other auto-completion setting, play with the line

set complete=longest,menuone

The current setting completes up to the last common string and then shows a menu. Other options are listed in the vim help or http://vimdoc.sourceforge.net/htmldoc/options.html#'completeopt'


For syntax highlighting:

  1. Copy the file ".vim/after/syntax/sh.vim" and make sure your ".vimrc" contains
syntax on

This works for '.bash', '.ksh' and '*.sh'-files. If you want to use other shell file extensions, please rename according to the available file in "/usr/share/vim/vim74/syntax/".

Operating instructions

Start typing your desired cdo command and hit <Ctrl-X><Ctrl-U>

cdo sell<Ctrl-X><Ctrl-U>

Get the following autocompletion options

sellevel                sellevel description
sellevidx               sellevidx description
sellonlatbox            sellonlatbox description
selltype                selltype description
...

Hit <Ctrl-N> go get the first shown match

cdo sellevel

Hit another <Ctrl-N> to choose the next match or move down with arrow keys and hit for your choice

Copyright and licensing information

  • MIT license

Known bugs

  • ?

Contact information

Aaron Spring
Bundesstraße 53
ZMAW Room 122
aaron.spring@mpimet.mpg.de

Looking forward to receiving your questions, comments or wishes

Changelog

  • v0.1: basic auto-complete function based on cdoCompletion.bash as of 2016/09/06
  • v0.2: some MPI-ESM variables included for HAMOCC: 2d, 3d and sediment; MPIOM: 2d, 3d and ECHAM6: BOT, LOG, ...; checkout this repositories ".vim/dictionary"
  • v1.0: completly new approach: uses all 'cdo --operators' listings installed on your machine, requires cdo-1.7.1 or later, also completes variables gathered by 'cdo vardes files', requires '*.sh' files, variable_completion and cdo_completion can be enabled or disabled in .vimrc
  • v1.1 syntax included: is applied after the current '?sh' syntax, so cdoKeywords are included
  • v1.2 filename *sh requirement taken out
  • v1.3 [3.6.2018] changed cdo --operator to cdo --operators; --operator only lists a few, --operators all; now compatible with cdo-1.9.2

Working on

  • anything else needed?

Credits and acknowledgements

  • Uwe Schulzweida, creator of cdo
  • Prince K Xavier, the dude who set up auto-completion for NCL and made me think about this
  • Ralf Müller

Sister project