https://github.com/ulhpc/puppet-vim
Puppet module to configure and manage vim
https://github.com/ulhpc/puppet-vim
Last synced: 4 months ago
JSON representation
Puppet module to configure and manage vim
- Host: GitHub
- URL: https://github.com/ulhpc/puppet-vim
- Owner: ULHPC
- License: other
- Created: 2015-05-08T09:45:47.000Z (about 11 years ago)
- Default Branch: devel
- Last Pushed: 2024-06-25T14:21:27.000Z (almost 2 years ago)
- Last Synced: 2025-06-11T01:52:50.418Z (about 1 year ago)
- Language: Vim Script
- Homepage:
- Size: 63.5 KB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
-*- mode: markdown; mode: auto-fill; fill-column: 80 -*-
# Vim Puppet Module
[](https://forge.puppetlabs.com/ULHPC/vim)
[](LICENSE)
Configure and manage vim
Copyright (c) 2015 ULHPC Management Team
* [Online Project Page](https://github.com/ULHPC/vim) -- [Sources](https://github.com/ULHPC/vim) -- [Issues](https://github.com/ULHPC/vim/issues)
## Synopsis
Configure and manage vim
This module implements the following elements:
* __classes__: `vim`
The various operations of this repository are piloted from a `Rakefile` which
assumes that you have [RVM](https://rvm.io/) installed on your system.
## Dependencies
See [`metadata.json`](metadata.json). In particular, this module depends on
* [puppetlabs/stdlib](https://forge.puppetlabs.com/puppetlabs/stdlib)
## General Parameters
See [manifests/params.pp](manifests/params.pp)
## Overview and Usage
### class `vim`
include 'vim'
## Librarian-Puppet / R10K Setup
You can of course configure ULHPC-sudo in your `Puppetfile` to make it
available with [Librarian puppet](http://librarian-puppet.com/) or
[r10k](https://github.com/adrienthebo/r10k) by adding the following entry:
# Modules from the Puppet Forge
mod "ULHPC/vim"
or, if you prefer to work on the git version:
mod "ULHPC/vim",
:git => https://github.com/ULHPC/vim,
:ref => production
## Issues / Feature request
You can submit bug / issues / feature request using the
[ULHPC/vim Puppet Module Tracker](https://github.com/ULHPC/vim/issues).
## Developments / Contributing to the code
If you want to contribute to the code, you shall be aware of the way this module
is organized.
These elements are detailed on [`doc/contributing.md`](doc/contributing.md)
You are more than welcome to contribute to its development by
[sending a pull request](https://help.github.com/articles/using-pull-requests).
## Tests on Vagrant box
The best way to test this module in a non-intrusive way is to rely on
[Vagrant](http://www.vagrantup.com/). The `Vagrantfile` at the root of the
repository pilot the provisioning of the vagrant box and relies on boxes
generated through my [vagrant-vms](https://github.com/falkor/vagrant-vms)
repository.
Once cloned, run
$> rake packer:Debian:init
To create a template. Select the version matching the once mentioned on the
`Vagrantfile` (`7.6.0-amd64` for instance)
Then run
$> rake packer:Debian:build
This shall generate the vagrant box `debian-7.6.0-amd64.box` that you can then
add to your box lists:
$> vagrant box add debian-7.6.0-amd64 packer/debian-7.6.0-amd64/debian-7.6.0-amd64.box
Now you can run `vagrant up` from this repository to boot the VM, provision it
to be ready to test this module (see the [`.vagrant_init.rb`](.vagrant_init.rb)
script). For instance, you can test the manifests of the `tests/` directory
within the VM:
$> vagrant ssh
[...]
(vagrant)$> sudo puppet apply -t /vagrant/tests/init.pp
Run `vagrant halt` (or `vagrant destroy`) to stop (or kill) the VM once you've
finished to play with it.
## Resources
### Git
You should become familiar (if not yet) with Git. Consider these resources:
* [Git book](http://book.git-scm.com/index.html)
* [Github:help](http://help.github.com/mac-set-up-git/)
* [Git reference](http://gitref.org/)