Fork of vim-puppet
Go to file
Gürkan Gür f9f38eb3fb 4-space tabs 2021-08-14 23:42:27 +02:00
.github/workflows Run shellcheck on shell scripts 2021-07-26 13:29:04 -04:00
after Add naive integration with gutentags plugin 2018-04-18 22:24:38 +02:00
autoload/puppet Implement linting recommendations from Vint 2021-07-26 13:25:43 -04:00
compiler Implement linting recommendations from Vint 2021-07-26 13:25:43 -04:00
ctags add tag for class name with leading colons 2020-03-02 15:12:10 +01:00
ftdetect Disable check for augroup in ftdetect file 2021-01-29 00:09:48 -05:00
ftplugin 4-space tabs 2021-08-14 23:42:27 +02:00
indent Implement linting recommendations from Vint 2021-07-26 13:25:43 -04:00
syntax Implement linting recommendations from Vint 2021-07-26 13:25:43 -04:00
test implement lint fixes for run-tests.sh from shellcheck 2021-07-26 13:29:04 -04:00
.gitignore Add naive integration with gutentags plugin 2018-04-18 22:24:38 +02:00
LICENSE License under Apache-2.0 2018-11-15 13:52:56 +11:00
README.md README: implement suggestions from markdownlint and wrap around 80 chars 2021-01-12 12:14:08 -05:00

README.md

vim-puppet

BuildStatus

Make vim more Puppet friendly!

Provides

  • Formatting based on the latest Puppetlabs Style Guide
  • Syntax highlighting compatible with puppet 4.x
  • Automatic => alignment
    • If you don't like that, add let g:puppet_align_hashes = 0 to your vimrc.
  • Ctags support
  • Doesn't require a bloated JRE
  • Doesn't take minutes to open

Additional useful plugins

  • vim-yardoc Syntax coloration for YARD tags and directives. It can also colorize the tags and directives in puppet files.
  • syntastic plugin for automatic syntax checking while in vim.
  • vim-snippets is a library of snippets for multiple languages, including Puppet. Works with both snipmate and ultisnips.
  • Tagbar plugin for Ctags support.

Installation

If you're using pathogen to manage your vim modules (and if you're not, why aren't you), you can simply add this as a submodule in your ~/.vim/bundle/ directory.

My entire home directory is a git repository, so for me it's simply a case of

git submodule add -f git://github.com/rodjek/vim-puppet.git .vim/bundle/puppet

If you're not using pathogen, you can just manually place the files in the appropriate places under ~/.vim/

Testing

Testing is based on vader.vim testing framework, see: https://github.com/junegunn/vader.vim . To run full test suit use ./test/run-tests.sh, this will also download vader.vim plugin to project's folder.