7e400abdc0
Due to emacs-straight/org-mode@e22b4eb, a replacement major mode (for org-mode) can no longer be specified from .dir-locals.el, as it spirals into infinite recursion. Therefore, a mode: line is needed in all Doom docs. Ref: emacs-straight/org-mode@e22b4eb7aa
4.7 KiB
:lang ruby
Description unfold
This module add Ruby and optional Ruby on Rails support to Emacs.
- Code completion (robe)
- Syntax checking (flycheck)
- Jump-to-definitions (robe)
- Bundler
- Rubocop integration (flycheck)
Maintainers
Module flags
- +chruby
- Enable chruby integration.
- +lsp
-
Enable LSP support for
ruby-mode. Requires :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 :tools tree-sitter.
Packages
Hacks
No hacks documented for this module.
TODO Changelog
This module does not have a changelog yet.
Installation
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.
TODO Usage
🔨 This module's usage documentation is incomplete. Complete it?
Commands
robe
| 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. |
projectile-rails
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 |
bundler
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 |
rspec-mode
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 |
TODO Configuration
🔨 This module has no configuration documentation yet. Write some?
Troubleshooting
There are no known problems with this module. Report one?
Frequently asked questions
This module has no FAQs yet. Ask one?
TODO Appendix
🔨 This module has no appendix yet. Write one?