Forge Home

vim

Manage VIM via puppet.

9,730 downloads

9,477 latest version

3.6 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 1.0.1 (latest)
  • 1.0.0
released Oct 21st 2013

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'diegolima-vim', '1.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add diegolima-vim
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install diegolima-vim --version 1.0.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

diegolima/vim — version 1.0.1 Oct 21st 2013

puppet-vim

Manage VIM via puppet.

Vim is an advanced text editor that seeks to provide the power of the de-facto Unix editor 'Vi', with a more complete feature set.

This module aims to enable easy installation and configuration of VIM through class parameters on different platforms, in a way that the administrator can easily set it up differently according to need and/or personal taste.

Usage

    class { 'vim': }

Class parameters

###* set_as_default

  • Accepted values: true or false
  • Default: true
  • Description: Set VIM as default editor.

###* ensure

  • Accepted values: present or absent
  • Default: present
  • Description: Whether or not VIM will be installed

###* autoupgrade

  • Accepted values: true or false
  • Default: false
  • Description: Whether or not the VIM package should be automatically kept up-to-date using the distribution's packaging system

###* set_editor_cmd

  • Accepted values: string
  • Default: update-alternatives --set editor /usr/bin/${editor_name} (Debian)
  • Description: The command used to set VIM as the default editor. Be careful if you're setting this parameter.

###* test_editor_set

  • Accepted values: string
  • Default: test /etc/alternatives/editor -ef /usr/bin/${editor_name} (Debian)
  • Description: Command used to verify that VIM is the default editor. Be careful if you're setting this parameter.

###* conf_file

  • Accepted values: string
  • Default: /etc/vim/vimrc (Debian), /etc/vimrc (RedHat)
  • Description: Path to VIM's main configuration file.

###* opt_bg_shading

  • Accepted values: dark or light
  • Default: dark
  • Description: Terminal background colour. This affects the colour scheme used by VIM to do syntax highlighting.

###* opt_powersave

  • Accepted values: true or false
  • Default: true
  • Description: If set to 'true' avoids cursor blinking that might wake up the processor.

###* opt_syntax

  • Accepted values: true or false
  • Default: true
  • Description: Turns on syntax highlighting if supported by the terminal.

###* opt_misc

  • Accepted values: array
  • Default: ['hlsearch','showcmd','showmatch','ignorecase','smartcase','incsearch','autowrite','hidden']
  • Description: Array containing options that will be set on VIM. Anything contained here will show as a "set option" line in your virc.

Sample Usage

Install VIM and use the provided configuration defaults

node default {
  class { 'vim': }
}

Turn on line numbering while keeping the default opt_misc values

node default {
  class { 'vim':
    opt_misc => ['hlsearch','showcmd','showmatch','ignorecase','smartcase','incsearch','autowrite','hidden','number'],
  }
}

Uninstall vim

node default {
  class { 'vim':
    ensure => absent,
  }
}

Acknowlegments

This module was forked from the one originally written by Saz (https://github.com/saz/puppet-vim). It adds enterprise linux support and configuration file management, which were not present on the original at the time of the first release.