jnbt / vscode-rufo

VS Code plugin for ruby-formatter/rufo

vscode-rufo

This Visual Studio Code extension provides formatting via Rufo. It will be used with files that have the “Ruby” syntax. Supports setups via RVM or rbenv.

Installation

Press F1, type ext install then search for jnbt.vscode-rufo.

rufo installation

Before using this plugin, you must ensure that rufo, version 0.10.0 or higher, is installed on your system. To install rufo, do the following:

1. Install Ruby.

2. Install Rufo by typing the following in a terminal:

   gem install rufo

If you're are using RVM or rbenv, seek for more information below.

Settings

You can configure vscode-rufo in your workspace or user settings. You can either

a) Open VS Code settings menu, select "Extensions" and scroll down to "Rufo"

b) Manually adjust your settings via your settings.json file:

{
  ...
  "rufo.exe": "rufo",  // can be an absolute path
  "rufo.useBundler": false,
}

Attention: Restart Visual Studio Code after you have made changes to the settings.

Using RVM

If your setup instruments RVM to install Ruby version you might receive errors indicating Rufo can't be found. Because rufo might not be in your current PATH, you need to change the executable to the RVM-wrapped one:

"rufo.exe": "/Users/You/.rvm/gems/ruby-2.3.6/wrappers/rufo"

Using rbenv

If your setup instruments rbenv, you should point the executable to the Rufo shim generated by rbenv. This way the extension will continue to work after you upgrade your Ruby:

"rufo.exe": "/Users/You/.rbenv/shims/rufo"

Develop

• Use Visual Studio Code to develop this extension
• Press F5 to open a new window with the extension loaded
• Open a Ruby file or paste some Ruby code into the window
• Open the command palette by pressing (Ctrl+Shift+P or Cmd+Shift+P on Mac)
• Choose either "Format Document" for "Format Selection".
• Find output from the extension in the debug console.

Testing

• Open the debug viewlet (Ctrl+Shift+D or Cmd+Shift+D on Mac) and from the launch configuration dropdown pick Launch Tests
• Press F5 to run the tests in a new window with your extension loaded
• See the output of the test result in the debug console

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request