Ansible role ansible-role-vim

• Description
• Linux distributions supported
• Requirements
• Role Variables
  • Basic configuration
  • Custom pathogen plugins
• Examples
  • Example Playbook
  • Example Task

Description

An Ansible role to install and configure vim in linux distributions. Specifically, the responsibilities of this role are to:

• Installs vim packages and pathogen plugins from the official distribution repositories
• Installs pathogen plugin manager
  • Configuration file pathogen.vim
• Installs powerline
• Installs airline
  • Configuration file airline.vim
• Installs airline-themes
  • Configuration file vim-airline-themes.vim
• Installs nerdtree
  • Configuration file nerdtree.vim
• Installs gitgutter
  • Configuration file vim-gitgutter.vim
• Installs floaterm
  • Configuration file vim-floaterm.vim
• Installs fugitive
  • Configuration file fugitive.vim
• Installs solarized colorscheme
  • Configuration file vim-colors-solarized.vim
• Installs jinja2-syntax
  • Configuration file vim-jinja2-syntax.vim
• Installs toml-syntax
  • Configuration file vim-toml-syntax.vim
• Installs mikrotik-syntax
  • Configuration file vim-mikrotik-syntax.vim
• Installs ansible-vim
  • Configuration file vim-ansible.vim
• Default vim configuration on vimrc.local

Refer to the change log for changes in each release.

Linux distributions supported

• CentOS 8
• Debian 10 Buster
• Debian 11 Bullseye
• Debian 12 Bookworm
• Fedora 31
• Fedora 32
• Fedora 33
• Fedora 34
• Fedora 35
• Fedora 36
• Fedora 37
• Fedora 38
• Ubuntu 18.04 Bionic
• Ubuntu 20.04 Focal
• Ubuntu 22.04 Jammy

Requirements

• Ansible 2.9
• Git for install the pathogen plugins (Installation included in the role itself)
• On CentOS EPEL Repository (Installation included in the role itself)

Role Variables

None of the variables below are required. When not defined by the user, the default values are used.

Basic configuration

Custom pathogen plugins

A list of pathogen plugins to be added and are defined with a dict containing the fields:

• name (required) The name of the pathogen plugin
• url (required) The git url of the pathogen plugin
• enabled (required) true install the pathogen plugin
• config_file (optional) a vim config file to be included in vimrc with specificconfiguration for this plugin

The following example installs nerdcommenter

- custom_pathogen_plugins:
  - name: nerdcommenter
    url: 'https://github.com/preservim/nerdcommenter'
    enabled: true
    config_file: 'roles/common/templates/etc/vim/nerdcommenter.vim.j2

Examples

Example Playbook

---
- hosts: all
  gather_facts: true
  remote_user: ansible
  become: true

  roles:
    - role: vim
      vars:
        - backup_config_files: true
        - color: ron
        - airline_theme: vice
        - custom_pathogen_plugins:
          - name: nerdcommenter
            url: 'https://github.com/preservim/nerdcommenter'
            enabled: true
            config_file: 'roles/common/templates/etc/vim/nerdcommenter.vim.j2'

Example Task

#
# Install Vim Packages
#
- name: INCLUDE ROLE | Install Vim Packages & Configure it
  include_role:
    name: vim
  vars:
    - backup_config_files: true
    - color: ron
    - airline_theme: vice
    - custom_pathogen_plugins:
      - name: nerdcommenter
        url: 'https://github.com/preservim/nerdcommenter'
        enabled: true
        config_file: 'roles/common/templates/etc/vim/nerdcommenter.vim.j2'
  when:
    - vim_for_sysadmins is defined
    - vim_for_sysadmins | bool
  tags:
    - install
    - configure

Example of file nerdcommenter.vim.j2

{{ ansible_managed | comment }}
"
" Nerdcommenter configuration
"
"
" Create default mappings
let g:NERDCreateDefaultMappings = 1

" Add spaces after comment delimiters by default
let g:NERDSpaceDelims = 1

" Use compact syntax for prettified multi-line comments
let g:NERDCompactSexyComs = 1

" Align line-wise comment delimiters flush left instead of following code indentation
let g:NERDDefaultAlign = 'left'

" Set a language to use its alternate delimiters by default
let g:NERDAltDelims_java = 1

" Add your own custom formats or override the defaults
let g:NERDCustomDelimiters = { 'c': { 'left': '/**','right': '*/' } }

" Allow commenting and inverting empty lines (useful when commenting a region)
let g:NERDCommentEmptyLines = 1

" Enable trimming of trailing whitespace when uncommenting
let g:NERDTrimTrailingWhitespace = 1

" Enable NERDCommenterToggle to check all selected lines is commented or not
let g:NERDToggleCheckAllLines = 1