Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

puppet_vim_env

Puppet Vim Environment setup for *NIX systems: syntax, linting, snippets
Project URLRSS FeedReport issues

39,041 downloads

15,405 latest version

4.3 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.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 2.4.1 (latest)
  • 2.4.0 (deleted)
  • 2.3.0
  • 2.2.0
  • 2.1.0
  • 2.0.0
  • 1.0.0
  • 0.3.0
  • 0.2.0
  • 0.1.0
released Nov 29th 2015
This version is compatible with:
  • Puppet Enterprise >= 2015.2.0 < 2017.1.0
  • Puppet >= 4.0.0 < 5.0.0
  • , , , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'jpadams-puppet_vim_env', '2.4.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jpadams-puppet_vim_env
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jpadams-puppet_vim_env --version 2.4.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
Tags: puppet, vim, editor, validate, parser, syntax, snippets, lint, solarized, color, highlight

Documentation

jpadams/puppet_vim_env — version 2.4.1 Nov 29th 2015

Overview

Note: This module has been rewritten for Puppet 4 and is not compatible with Puppet 3.x (should work with future parser). This module provides defined types to set up a vim envrionment optimized for Puppet development. It uses a solarized color scheme by default.

  • <F2> is mapped to align => in a param block via Tabular
  • ,c<space> to comment or uncomment via Nerdcommenter
  • provide args to puppet parser validate via Syntastic (added --app_management)
  • option to use jk instead of <ESC> from http://dougblack.io/words/a-good-vimrc.html

It relies on the work done by many, many people and specifically draws upon the following resources:

https://github.com/MarcWeber/vim-addon-mw-utils

https://github.com/tomtom/tlib_vim

https://github.com/garbas/vim-snipmate

https://github.com/godlygeek/tabular

https://github.com/scrooloose/syntastic

https://github.com/rodjek/vim-puppet

https://github.com/honza/vim-snippets

https://github.com/altercation/vim-colors-solarized

https://github.com/scrooloose/nerdcommenter

It uses a custom fact, homedir, to decide where to put the .vimrc file and .vim directory. Beware, this will clobber your existing ~/.vimrc!

Prerequisites

This module has been rewritten to assume the all-in-one, unified puppet-agent for PE and Open Source Puppet. It uses the Puppet 4 parser. This module relies on a couple of modules from http://forge.puppetlabs.com. Which should be pulled in as dependencies by the Puppet Module Tool. If they are not because you're installing from github, you can install them yourself.

  • puppet module install puppetlabs/vcsrepo
  • puppet module install puppetlabs/stdlib

In case you were wondering, this module doesn't manage the vim package itself. It is assumed to be installed. This module also assumes that the system you want vim enhancements for has git and curl installed.

Installation & Setup

To begin using this module, install it in your master's codedir and write a profile (wrapper) to set up whatever user's vim environments you need. Classify agents with the profile (or a role containing it) and you're set.

For convenience or a quick test, there is a default config class in init.pp. So if you classify your machine with puppet_vim_env you'll get that default.

Alternatively, puppet module install jpadams-puppet_vim_env to an agent machine and puppet apply -e 'include puppet_vim_env' with the modulepath set if necessary.