saltstack-formulas / vim-formula

Trick out vim

vim-formula

Formula to set up and configure vim.

Table of Contents

• General notes
• Contributing to this repo
• Available states
  • vim
  • vim.salt
  • vim.nerdtree
  • vim.pyflakes
  • vim.absent
• Testing
  • Requirements
  • bin/kitchen converge
  • bin/kitchen verify
  • bin/kitchen destroy
  • bin/kitchen test
  • bin/kitchen login

General notes

See the full SaltStack Formulas installation and usage instructions.

If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.

If you want to use this formula, please pay attention to the FORMULA file and/or git tag, which contains the currently released version. This formula is versioned according to Semantic Versioning.

See Formula Versioning Section for more details.

Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

Available states

• vim
• vim.salt
• vim.nerdtree
• vim.pyflakes
• vim.absent

vim

Installs and configures the vim package.

vim.salt

Add the global plugins for editing sls files

vim.nerdtree

Add nerdtree plugin globally for vim

vim.pyflakes

Add pyflakes detection globaly for salt (may require installing gvim on some platforms)

vim.absent

Ensure vim is purged.

Testing

Linux testing is done with kitchen-salt.

Requirements

• Ruby
• Docker

$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]

Where [platform] is the platform name defined in kitchen.yml, e.g. debian-9-2019-2-py3.

bin/kitchen converge

Creates the docker instance and runs the vim main state, ready for testing.

bin/kitchen verify

Runs the inspec tests on the actual instance.

bin/kitchen destroy

Removes the docker instance.

bin/kitchen test

Runs all of the stages above in one go: i.e. destroy + converge + verify + destroy.

bin/kitchen login

Gives you SSH access to the instance for manual testing.