This module add Ruby and optional Ruby on Rails support to Emacs.
- Code completion (doom-package:robe)
- Syntax checking (doom-package:flycheck)
- Jump-to-definitions (doom-package:robe)
- Bundler
- Rubocop integration (doom-package:flycheck)
- @hlissner
Become a maintainer?
- +chruby
- Enable chruby integration.
- +lsp
-
Enable LSP support for
ruby-mode. Requires doom-module::tools lsp and a langserver (supports solargraph). - +rails
- Enable rails navigational commands, plus server+console integration.
- +rbenv
- Enable rbenv integration.
- +rvm
- Enable RVM (Ruby Version Manager) integration.
- +tree-sitter
- Leverages tree-sitter for better syntax highlighting and structural text editing. Requires doom-module::tools tree-sitter.
- doom-package:bundler
- doom-package:chruby if doom-module:+chruby
- doom-package:company-inf-ruby if :completion company
- doom-package:inf-ruby
- doom-package:minitest
- doom-package:rake
- doom-package:rbenv if doom-module:+rbenv
- doom-package:robe
- doom-package:rspec-mode
- doom-package:rubocop
- doom-package:rvm if doom-module:+rvm
- if doom-module:+rails
- doom-package:inflections
- doom-package:projectile-rails
No hacks documented for this module.
This module does not have a changelog yet.
Enable this module in your doom! block.
This module requires Ruby and the Rubocop gem. It is recommended you install both with some version manager (RVM or Rbenv).
These guides will help you install Ruby:
Then run $ gem install rubocop to install rubocop.
🔨 This module’s usage documentation is incomplete. Complete it?
| command | key / ex command | description |
|---|---|---|
robe-start | <localleader> ’ | Open ruby lang server for auto-completions and jump to definitions |
robe-rails-refresh | <localleader> R | Refresh the lang server. |
The projectile-rails prefix is <localleader> r:
| command | key / ex command | description |
|---|---|---|
projectile-rails-console | <localleader> r r | Open Rails console |
projectile-rails-server | <localleader> r R | Open Rails server |
projectile-rails-find-model | <localleader> r m | Find any model of the project |
projectile-rails-find-model | <localleader> r M | Find the model related of currently open resource |
The bundler prefix is <localleader> b:
| command | key / ex command | description |
|---|---|---|
bundle-install | <localleader> b i | Runs bundle install |
bundle-update | <localleader> b u | Runs bundle update |
The rspec-mode prefix is <localleader> t:
| command | key / ex command | description |
|---|---|---|
rspec-verify | SPC m t v | Runs rspec on current file |
rspec-verify-method | SPC m t s | Runs rspec for the item on cursor |
🔨 This module has no configuration documentation yet. Write some?
There are no known problems with this module. Report one?
This module has no FAQs yet. Ask one?
🔨 This module has no appendix yet. Write one?