https://github.com/saltstack-formulas/vim-formula
Trick out vim
https://github.com/saltstack-formulas/vim-formula
Last synced: 18 days ago
JSON representation
Trick out vim
- Host: GitHub
- URL: https://github.com/saltstack-formulas/vim-formula
- Owner: saltstack-formulas
- License: apache-2.0
- Created: 2013-06-12T22:13:24.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2025-04-07T20:03:57.000Z (10 months ago)
- Last Synced: 2025-04-07T21:23:08.601Z (10 months ago)
- Language: Vim script
- Homepage: http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html
- Size: 317 KB
- Stars: 32
- Watchers: 37
- Forks: 108
- Open Issues: 2
-
Metadata Files:
- Readme: docs/README.rst
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Authors: AUTHORS.md
Awesome Lists containing this project
README
.. _readme:
vim-formula
===========
|img_travis| |img_sr|
.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/vim-formula.svg?branch=master
:alt: Travis CI Build Status
:scale: 100%
:target: https://travis-ci.com/saltstack-formulas/vim-formula
.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
:alt: Semantic Release
:scale: 100%
:target: https://github.com/semantic-release/semantic-release
Formula to set up and configure vim.
.. contents:: **Table of Contents**
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
----------------
.. contents::
:local:
``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
.. code-block:: bash
$ 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.