Skip to content

Latest commit

 

History

History
53 lines (31 loc) · 2.2 KB

README.md

File metadata and controls

53 lines (31 loc) · 2.2 KB

rsense

rsense package

Gitter chat

RSense is a tool for doing static analysis of Ruby source code. Rsense is used in conjunction with an editor plugin. This is the plugin for the Atom editor.

RSense is currently in beta and ready for testing. Currently we have exposed code-completion. In the near future we'll also be ready to expose some of Rsense's other basic features like find-definition. After that, there's plenty to do in the long term. See the waffle link below to find out where you can pitch in. It would be awesome if you helped get things done.

Stories in Ready

A screenshot of your spankin' package

Installation

Add this line to your application's Gemfile:

gem 'rsense'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rsense

Then install this package via Atom's package manager, within preferences. Just search for rsense. You will also need to install autocomplete-plus.

These can also be installed at the command line via atom's package manager:

    $ apm install rsense
    $ apm install autocomplete-plus

Sometimes it is necessary to restart atom after installing these two packages.

Usage

You'll need to run rsense start from the command line, though we do eventually plan to add an atom command for starting and stopping the server. Completions are triggered on . and ::. You won't see the popup until typing a letter, however. For instance:

x = "hello"
x.s

The above will trigger a list of completions, using fuzzy filtering on 's'. Navigate the dropbox with the up ▲ and down ▼ arrows, then select completion with the tab ⇥ key.

More information about rsense can be found at http://rsense.github.io/ .