gitback/doomemacs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
7ecda0d8e7
doomemacs/modules/lang/ruby
History
Henrik Lissner 088d0d14ea
Merge pull request #3177 from otavioschwanck/feature/better-rake 
use default search on rake tasks on :ruby lang
2020-05-24 22:53:38 -04:00
..
autoload.el
config.el Merge pull request #3177 from otavioschwanck/feature/better-rake 2020-05-24 22:53:38 -04:00
doctor.el
packages.el Bump :lang ruby 2020-05-11 03:00:08 -04:00
README.org hack to description 2020-05-17 02:20:53 -03: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

Hacks

  • projectile-rails-custom-server-command were changed to suppress extraneous output logged to console. This was done to prevent a memory leak where the underlying process would continue logging to an Emacs buffer, which would grow forever. You can change to default behaviour by setting this variable to nil.

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