vim-erlang-omnicomplete

vim-erlang-omnicomplete is an Erlang autocompletion plugin for Vim.

Table of Contents

• Installation
• Quick start
• Documentation
• Development
  • File layout
• Contributing

Installation

Vim's built-in package manager

This is the recommended installation method if you use at least Vim 8 and you don't use another package manager.

Information about Vim's built-in package manager: :help packages.

Installation steps:

1. Clone this repository (you can replace foo with the directory name of your choice):

   $ git clone https://github.com/vim-erlang/vim-erlang-omnicomplete.git \
         ~/.vim/pack/foo/start/vim-erlang-omnicomplete

2. Restart Vim.

3. Generate help page (replace foo with the same directory name as above):

   :helptags ~/.vim/pack/foo/start/vim-erlang-omnicomplete/doc
   

Pathogen

Information about Pathogen: Pathogen repository.

Installation steps:

1. Clone this repository:

   $ git clone https://github.com/vim-erlang/vim-erlang-omnicomplete.git \
         ~/.vim/bundle/vim-erlang-omnicomplete
   

2. Restart Vim.

3. Generate help page:

   :Helptags
   

Vundle

Information about Vundle: Vundle repository.

Installation steps:

1. Add vim-erlang-omnicomplete to your plugin list in .vimrc by inserting the line that starts with Plugin:

   call vundle#begin()
     [...]
     Plugin 'vim-erlang/vim-erlang-omnicomplete'
     [...]
   call vundle#end()
   

2. Restart Vim.

3. Run :PluginInstall.

Vim-Plug

Information about Vim-Plug: vim-plug repository.

Installation steps:

1. Add vim-erlang-omnicomplete to your plugin list in .vimrc by inserting the line that starts with Plug:

   call plug#begin()
     [...]
     Plug 'vim-erlang/vim-erlang-omnicomplete'
     [...]
   call plug#end()
   

2. Restart Vim.

3. Run :PlugInstall.

Quick start

1. Open an Erlang source file.

2. Start typing something (e.g. li or io:fo).

3. Without leaving insert mode, hit CTRL-X and then CTRL-O.

4. After at most a few seconds, you should see a list of completions.

Documentation

• Vim's omni completion (i.e., autocomplete) functionality: :help compl-omni.

• Vim's completeopt option to configure omni completion :help completeopt.

• vim-erlang-omnicomplete plugin: :help vim-erlang-omnicomplete.

Development

File layout

This repository contains the following files and directories:

• autoload/erlang_complete.erl: Erlang script which can analyse the code base and calculate the list of modules and the list of functions in a module.

• autoload/erlang_complete.vim: This script contains most of vim-erlang-omnicomplete's functionality on the Vim side.

  This functionality is here (instead of plugin/erlang_omnicomplete.vim) so that Vim's autoload functionality (:help autoload) can make sure that this script is executed only when needed the first time.

• doc/vim-erlang-omnicomplete.txt: This file contains the user documentation of vim-erlang-omnicomplete.

• ftplugin/erlang.vim: This script sets up vim-erlang-omnicomplete when an Erlang source file is opened.

• plugin/erlang_omnicomplete.vim: This script sets up vim-erlang-omnicomplete when Vim is started. It is kept small so that the effect on Vim's startup time is minimal.

Contributing

• Please read the Contributing section of the vim-erlang README.

• If you modify autoload/erlang_complete.erl, please:

  • update the tests in the vim-erlang repository

  • also modify vim-erlang-compiler (if you modify the "load build information" code block)