#######################################################################################################

:exclamation: DEPRECATION :exclamation:

This repository and the related role are no longer maintained. Instead, please use the Manala Ansible Collection.

For usage information, check the collection repository.

#######################################################################################################

Ansible Role: Vim

:exclamation: If you encounter any issues, please report them here and submit Pull Requests to the main Ansible Role repository. :exclamation:

This role is designed to set up and configure Vim.

It is part of the Manala Ansible stack but can also be used independently.

Requirements

None.

Dependencies

None.

Installation

Ansible 2+

Using the Ansible Galaxy command line:

ansible-galaxy install manala.vim

Using a requirements file for Ansible Galaxy:

- src: manala.vim

Role Handlers

None

Role Variables

Configuring VIM

You can use the manala_vim_config_template key for configuration templates.

Example

manala_vim_config_template: my/vim.j2

You can also specify the Vim configuration file using the manala_vim_config_file:

manala_vim_config_file: /etc/vim/vimrc.local

Use manala_vim_config to set Vim options (see: http://vimconfig.com/).

You can use dictionary parameters like this:

manala_vim_config:
  syntax: "on"
  encoding: utf8
  expandtab: true   # Use spaces instead of tabs
  smarttab: true    # Smart tabbing
  shiftwidth: 4     # 1 tab == 4 spaces
  tabstop: 4

Or you can use raw configuration like this:

manala_vim_config: |
  set encoding=utf8
  set expandtab

Alternatively, you can use deprecated array parameters:

manala_vim_config:
  - syntax: "on"
  - encoding: utf8
  - expandtab: true   # Use spaces instead of tabs
  - smarttab: true    # Smart tabbing
  - shiftwidth: 4     # 1 tab == 4 spaces
  - tabstop: 4

Example playbook

- hosts: servers
  roles:
    - role: manala.vim

License

MIT

Author Information

Manala (http://www.manala.io/)