emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/lang/ruby
History
Henrik Lissner a70e634ebd
refactor(:lang): move tree-sitter init 
Moved add-hook calls (for tree-sitter initialization) into their
respective modes' config blocks, or nearby, to be consistent with how
other, similar tools (like lsp!) are initialized, and does so at
runtime, rather than at expansion/compile time, which eval-when! caused.
2022-07-25 17:34:44 +02:00
..
autoload.el Remove references to enh-ruby-mode 2020-03-12 11:29:54 -04:00
config.el refactor(:lang): move tree-sitter init 2022-07-25 17:34:44 +02:00
doctor.el docs(tree-sitter): add doctor checks for flag 2022-05-22 21:26:00 +01:00
packages.el bump: :lang 2022-03-31 21:09:38 +02:00
README.org Merge pull request #4261 from otavioschwanck/fix-rails-command 2021-02-26 21:34:09 -05:00

README.org

lang/ruby

Table of contents   TOC

Description

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)

Module Flags

  • +lsp Enables LangServer support for ruby. You must have :tools lsp enabled for this to work, as well as the langserver (solargraph) installed on your system.
  • +rvm Enables RVM (Ruby Version Manager) integration.
  • +rbenv Enables rbenv integration.
  • +chruby Enables chruby integration.
  • +rails Enables rails navigational commands, plus server+console integration.

Packages

Prerequisites

Many of this modules plugins require ruby with some version manager (RVM or Rbenv) and the rubocop gem.

Ubuntu

You can follow this guide. After ruby installation, run gem install rubocop.

MacOS

You can follow this guide. After ruby installation, run gem install rubocop.

Windows

You can follow this guide. After ruby installation, run gem install rubocop.

Appendix

Commands

robe

command key / ex command description
robe-start SPC m \' Open ruby lang server for auto-completions and jump to definitions
robe-rails-refresh SPC m R Refresh the lang server.

projectile-rails

The projectile-rails prefix is SPC m r. Here is some examples:

command key / ex command description
projectile-rails-console SPC m r r Open Rails console
projectile-rails-server SPC m r R Open Rails server
projectile-rails-find-model SPC m r m Find any model of the project
projectile-rails-find-model SPC m r M Find the model related of currently open resource

bundler

The bundler prefix is SPC m b. Here is some examples:

command key / ex command description
bundle-install SPC m b i Runs bundle install
bundle-update SPC m b u Runs bundle update

rspec-mode

The rspec-mode prefix is SPC m t. Here is some examples:

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