Forge Home

vim

Manage everyone's favorite editor, Vim.

31,222 downloads

2,178 latest version

4.7 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

  • 4.0.0 (latest)
  • 3.0.0
  • 2.13.0
  • 2.12.0
  • 2.11.0
  • 2.10.0
  • 2.9.1
  • 2.9.0
  • 2.8.0
  • 2.7.0
  • 2.6.0
  • 2.5.0
  • 2.4.1
  • 2.4.0
  • 2.3.0
  • 2.2.0
  • 2.1.0
  • 1.0.0 (deleted)
released Nov 15th 2023
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
  • Puppet >= 7.0.0 < 9.0.0
  • , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'ghoneycutt-vim', '4.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install ghoneycutt-vim --version 4.0.0

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

ghoneycutt/vim — version 4.0.0 Nov 15th 2023

vim

Table of Contents

  1. Module Description - What the module does and why it is useful
  2. Setup - The basics of getting started with vim
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module

Description

This is a very simple module to manage Vim. It manages the packages, the .vimrc configuration file and populates a few syntax files for Puppet. This is meant to make vim useful on servers with some basic, sane settings. It is not meant to manage a developer's workstation where you would be managing a ton of plugins and configuration.

Documented with Puppet Strings at http://ghoneycutt.github.io/puppet-module-vim/.

Setup

What vim affects

This module manages the /root/.vimrc file and /root/.vim directory, which gets some plugins installed. It also manages the related vim packages for the platform.

Beginning with vim

Declare the vim class.

Usage

The normal use case.

include vim

To specify the package list.

class { 'vim':
  package_list => ['vim', 'vim-whatever'],
}

Limitations

This module officially supports the platforms listed in the metadata.json. It does not fail on unsupported platforms and has been known to work on many, many platforms since its creation in 2010.

Development

See CONTRIBUTING.md

License

See LICENSE file.