vim-openvox

A comprehensive Puppet 8 IDE plugin for Vim. Replaces multiple Puppet-related plugins with a single, cohesive solution built around the official Puppet Style Guide.

Features

Feature	Description
Syntax Highlighting	Full Puppet 8 language — resource types, 90+ built-in functions, data types, heredocs, string interpolation, regex, operators, EPP templates
Indentation	Style-guide-compliant 2-space soft tabs with smart block indentation
puppet-lint	Async linting with all 39+ checks, quickfix integration, auto-fix support
metadata-json-lint	Validates module metadata.json files
yamllint	Lints Hiera YAML data files
Omni-completion	Context-aware completion for types, attributes, functions, variables, ensure values
Arrow Alignment	Align => arrows per style guide (visual selection or auto-detect block)
Navigation	Go-to-definition (gd), block jumping ([[ / ]])
Documentation	Press K to open Puppet docs in browser
Snippets	Generate class, defined type, and init.pp boilerplate with Puppet Strings docs
EPP Templates	Host-language syntax detection (.conf.epp → conf + Puppet)
Filetype Detection	.pp, .epp, Puppetfile, Hiera YAML, metadata.json
Compiler	:make integration via puppet-lint and puppet validate
Code Folding	Fold by indent level

Requirements

• Vim 8.0+ (async job support)
• puppet-lint — gem install puppet-lint
• metadata-json-lint — gem install metadata-json-lint
• yamllint — pip install yamllint

Installation

Pathogen:

cd ~/.vim/bundle
git clone https://github.com/cvquesty/vim-openvox.git

vim-plug:

Plug 'cvquesty/vim-openvox'

Native packages (Vim 8+):

mkdir -p ~/.vim/pack/plugins/start
cd ~/.vim/pack/plugins/start
git clone https://github.com/cvquesty/vim-openvox.git

Quick Start

vim-openvox works out of the box. Open any .pp file and you get syntax highlighting, indentation, and auto-linting on save.

Key Mappings

Mode	Mapping	Action
Normal	<LocalLeader>l	Run puppet-lint
Normal	<LocalLeader>v	Validate puppet syntax
Normal	<LocalLeader>f	Auto-fix lint issues
Normal	gd	Go to class/define definition
Normal	K	Open Puppet documentation
Normal	[[	Jump to previous class/define/node
Normal	]]	Jump to next class/define/node
Visual	<LocalLeader>a	Align => arrows in selection

Commands

:OpenvoxLint            " Run puppet-lint on current file
:OpenvoxLintFix         " Auto-fix puppet-lint issues
:OpenvoxValidate        " Run puppet parser validate
:OpenvoxMetadataLint    " Lint metadata.json
:OpenvoxYamlLint        " Lint YAML file with yamllint
:OpenvoxAlign           " Align => arrows (visual selection)
:OpenvoxAlignBlock      " Align => arrows in current block
:OpenvoxGotoDef         " Jump to definition
:OpenvoxDoc             " Open documentation
:OpenvoxClass name      " Insert class boilerplate
:OpenvoxDefine name     " Insert defined type boilerplate
:OpenvoxInit            " Insert init.pp boilerplate

Configuration

Add to your .vimrc:

" Auto-lint on save (default: 1)
let g:openvox_auto_lint = 1

" Line length limit (default: 140)
let g:openvox_max_line_length = 140

" Disable specific puppet-lint checks
let g:openvox_lint_disabled_checks = ['80chars', 'documentation']

" Custom yamllint config for Hiera files
let g:openvox_yamllint_args = ['-c', '~/.yamllint.yml']

" Custom linter paths (if not in $PATH)
let g:openvox_lint_command = '/usr/local/bin/puppet-lint'
let g:openvox_puppet_command = '/opt/puppetlabs/bin/puppet'

" Disable auto-mappings
let g:openvox_no_mappings = 0

" Enable code folding (default: 1)
let g:openvox_fold = 1

Replacing Other Plugins

vim-openvox is designed to replace:

Old Plugin	vim-openvox Replacement
puppet-syntax-vim / vim-puppet (rodjek)	Full syntax, indent, ftdetect, ftplugin
vim-puppet-lint	Async puppet-lint + quickfix
Syntastic (puppet checker)	Async puppet-lint + puppet validate
ALE (puppet linters)	puppet-lint, metadata-json-lint, yamllint
Tabular / vim-easy-align (for =>)	Built-in arrow alignment

To disable old plugins with Pathogen:

let g:pathogen_disabled = ['puppet-syntax-vim', 'vim-puppet']

Style Guide Compliance

Every feature is built around the Puppet Style Guide:

• Indentation: 2-space soft tabs, no hard tabs
• Strings: Single quotes preferred; double quotes only for interpolation
• Resources: ensure first, arrows aligned, metaparams last
• Line length: 140 characters (configurable)
• Comments: # only (C-style comments highlighted as warnings)
• Variables: $snake_case with namespace qualification

License

Apache-2.0