nvim-formula

A SaltStack formula to install and configure Neovim.

Table of Contents

• General notes
• Contributing to this repo
• Special notes
• Available states
• Testing

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.

If you need (non-default) configuration, please refer to:

• how to configure the formula with map.jinja
• the pillar.example file
• the Special notes section

Contributing to this repo

Commit messages

Commit message formatting is significant!!

Please see How to contribute for more details.

pre-commit

pre-commit is configured for this formula, which you may optionally use to ease the steps involved in submitting your changes. First install the pre-commit package manager using the appropriate method, then run bin/install-hooks and now pre-commit will run automatically on each git commit.

$ bin/install-hooks
pre-commit installed at .git/hooks/pre-commit
pre-commit installed at .git/hooks/commit-msg

Special notes

None

Available states

• nvim
• nvim.install
• nvim.config
• nvim.vimplug
• nvim.config.clean

nvim

Meta-state (This is a state that includes other states).

This installs the nvim package, manages the nvim configuration file and then installs and runs vimplug.

nvim.install

This state installs the nvim package.

By default, it installs via the Github Releases page. On Linux, it will also prepend its install directory to $PATH in your .bashrc file. You can set a custom bashrc path with the pillar nvim:pkg:bashrc_path.

You can optionally install through your OS package manager instead. See the pillar.example file.

nvim.config

This state configures neovim by populating the config directory.

Any files in the salt://nvim/files/default/nvim_config_dir/ directory will be used. See the files_switch macro for more information.

nvim.vimplug

This state runs vimplug's PlugInstall command to install any plugins specified in the config file.

nvim.config.clean

This state wipes the config directory.

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