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

❗ DEPRECATION ❗

This repository and the role associated are deprecated in favor of the Manala Ansible Collection

You will find informations on its usage on the collection repository

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

Ansible Role: Vim

❗ Report issues and send Pull Requests in the main Ansible Role repository ❗

This role will deal with the setup and configuration of Vim.

It's part of the Manala Ansible stack but can be used as a stand alone component.

Requirements

None.

Dependencies

None.

Installation

Ansible 2+

Using ansible galaxy cli:

ansible-galaxy install manala.vim

Using ansible galaxy requirements file:

- src: manala.vim

Role Handlers

None

Role Variables

Name	Default	Type	Description
manala_vim_install_packages	~	Array	Dependency packages to install
manala_vim_install_packages_default	['vim']	Array	Default dependency packages to install
manala_vim_config_template	'config/empty.j2'	String	vimrc.local template path
manala_vim_config_file	'/etc/vim/vimrc.local'	String	Configuration file path
manala_vim_config	~	Array/String	Configuration directives

Configuring VIM

The manala_vim_config_template key will allow you to use configuration templates.

Example

manala_vim_config_template: my/vim.j2

In combination with it you can specify the vim configuration file with the manala_vim_config_file:

manala_vim_config_file: /etc/vim/vimrc.local

The manala_vim_config is used ton configure vim, you can specify any of the vim options (see: http://vimconfig.com/) like following:

Use dict parameters:

manala_vim_config:
  syntax: "on"
  encoding: utf8
  expandtab: true   # Use spaces instead of tabs
  smarttab: true   # Be smart when using tabs ;)
  shiftwidth: 4      # 1 tab == 4 spaces
  tabstop: 4

Use raw config:

manala_vim_config: |
  set encoding=utf8
  set expandtab

Use dict's array parameters (deprecated):

manala_vim_config:
  - syntax: "on"
  - encoding: utf8
  - expandtab: true   # Use spaces instead of tabs
  - smarttab: true   # Be smart when using tabs ;)
  - shiftwidth: 4      # 1 tab == 4 spaces
  - tabstop: 4

Example playbook

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

Licence

MIT

Author information

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