/grunt-rvm-switcher

Grunt plugin to allow Ruby Virtual Machine switching through grunt configuration

Primary LanguageJavaScriptMIT LicenseMIT

grunt-rvm-switcher

Grunt plugin to allow Ruby Virtual Machine switching through grunt configuration

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-rvm-switcher --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-rvm-switcher');

The "rvm_switch" task

Overview

In your project's Gruntfile, add a section named rvm_switcher to the data object passed into grunt.initConfig().

grunt.initConfig({
  rvm_switch: {
    options: {
      ruby_version: '2.1.2',
      gem_set: 'styleguide-1.0',
      rvm_path: '$HOME/.rvm/scripts/rvm'
    },
  },
});

Options

options.ruby_version

Type: String Default value: 2.1.2

The ruby version to use for the vm.

options.gem_set

Type: String Default value: styleguide-1.0

The gem set to use.

options.rvm_path

Type: String Default value: $HOME/.rvm/scripts/rvm

The path to your rvm script (this cannot be the bin)

Usage Examples

Default Options

In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3.

grunt.initConfig({
  rvm_switcher: {
    options: {
        ruby_version: '2.0.0',
        virtual_machine: 'MyVirtualMachineConfigName',
    },
  },
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)