mirror of
https://github.com/doomemacs/doomemacs
synced 2025-08-01 12:17:25 -05:00
de355b009a
Andersbakken/rtags@db39790fda -> Andersbakken/rtags@9e442e5b30 ananthakumaran/tide@b93e555858 -> ananthakumaran/tide@29475d9eee asok/projectile-rails@772f4766b5 -> asok/projectile-rails@701784df7b brotzeit/rustic@6eec971387 -> brotzeit/rustic@39423d1cf4 dgutov/robe@11207bd549 -> dgutov/robe@b9d5ab549f emacs-lsp/emacs-ccls@675a5704c1 -> emacs-lsp/emacs-ccls@29d231590f emacs-lsp/lsp-haskell@485c1148ce -> emacs-lsp/lsp-haskell@3249cde75f emacs-typescript/typescript.el@88f317f0b6 -> emacs-typescript/typescript.el@4fcb459481 emacsmirror/cmake-mode@d5d77de8c4 -> emacsmirror/cmake-mode@6ce5633144 haskell/haskell-mode@90503413f4 -> haskell/haskell-mode@a34ccdc54b jart/disaster@10a785facc -> jart/disaster@0c13bd244c nonsequitur/inf-ruby@dbf4386bac -> nonsequitur/inf-ruby@0ce7f4049e pd/yard-mode.el@ba74a47463 -> pd/yard-mode.el@ef3426ff55 pezra/rspec-mode@4215ff1f2d -> pezra/rspec-mode@62853a428b senny/rvm.el@c1f2642434 -> senny/rvm.el@e1e83b5466 - (#7070) lsp-haskell update should address lag and errors in haskell-mode when using LSP. Ref: #7070
:lang ruby
Description unfold
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)
Maintainers
Module flags
- +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.
Packages
- 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
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?