1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
---
layout: default
title: Rails add-on
nav_order: 10
---
# Rails add-on
[Ruby LSP Rails](https://github.com/Shopify/ruby-lsp-rails) is a Ruby LSP add-on that enhances the base Ruby LSP functionality
with Rails-specific features. It provides improved code navigation, document symbols for Rails-specific elements,
and runtime introspection capabilities.
It [communicates with a running Rails instance](#runtime-introspection) to provide dynamic information about the application,
enabling more accurate and context-aware language server features.
## Table of Contents
- [Installation](#installation)
- [Runtime Introspection](#runtime-introspection)
- [Features](#features)
- [**Document Symbol**](#document-symbol)
- [Active Record Callbacks, Validations, and Associations](#active-record-callbacks-validations-and-associations)
- [Active Support Test Cases](#active-support-test-cases)
- [**Go to Controller Action Route**](#go-to-controller-action-route)
- [**Go to Controller Action View**](#go-to-controller-action-view)
- [**Go to Definition**](#go-to-definition)
- [Go to Active Record Callback and Validation Definitions](#go-to-active-record-callback-and-validation-definitions)
- [Go to Active Record Associations](#go-to-active-record-associations)
- [Go to Route Helper Definitions](#go-to-route-helper-definitions)
- [**Ruby File Operations**](#ruby-file-operations)
- [Commands](#commands)
- [**Run and Debug**](#run-and-debug)
- [Run Tests With Test Explorer](#run-tests-with-test-explorer)
- [Run Tests In The Terminal](#run-tests-in-the-terminal)
- [Debug Tests With VS Code](#debug-tests-with-vs-code)
## Installation
{: .important }
> The Rails add-on is installed automatically.
Ruby LSP detects Rails projects and installs the [Rails add-on](https://github.com/Shopify/ruby-lsp-rails) for you.
## Runtime Introspection
LSP tooling is typically based on static analysis, but `ruby-lsp-rails` actually communicates with your Rails app for
some features.
When Ruby LSP Rails starts, it spawns a `rails runner` instance which runs
[`server.rb`](https://github.com/Shopify/ruby-lsp-rails/blob/main/lib/ruby_lsp/ruby_lsp_rails/server.rb).
The add-on communicates with this process over a pipe (i.e. `stdin` and `stdout`) to fetch runtime information about the application.
When extension is stopped (e.g. by quitting the editor), the server instance is shut down.
## Features
### **Document Symbol**
Document Symbol is a way to represent the structure of a document. They are used to provide a quick overview of the
document and to allow for quick navigation.
Ruby LSP already provides document symbols for Ruby files, such as classes, modules, methods, etc. But the Rails add-on
provides additional document symbols for Rails specific features.
In VS Code, you can open the document symbols view by pressing `Cmd + Shift + O` (Mac) or `Ctrl + Shift + O` (Windows/Linux).
### Active Record Callbacks, Validations, and Associations
Navigates between Active Record callbacks, validations, and associations using the `Document Symbol` feature.
<video src="images/ruby-lsp-rails-document-symbol-ar-model.mp4" width="100%" controls>
Sorry, your browser doesn't support embedded videos. This video shows navigating Active Record callbacks, validations, and associations via document symbols.
</video>
### Active Support Test Cases
Navigates between Active Support test cases using the `Document Symbol` feature.
<video src="images/ruby-lsp-rails-test-document-symbol.mp4" width="100%" controls>
Sorry, your browser doesn't support embedded videos. This video shows navigating Active Support test cases via document symbols.
</video>
### **Go to Controller Action Route**
Navigates to the route definition of a controller action using the `Code Lens` feature.
<video src="images/ruby-lsp-rails-controller-action-to-route.mp4" width="100%" controls>
Sorry, your browser doesn't support embedded videos. This video demonstrates navigating from a controller action to its route definition using code lens.
</video>
### **Go to Controller Action View**
Navigates to the view file(s) of a controller action using the `Code Lens` feature.
<video src="images/ruby-lsp-rails-controller-action-to-view.mp4" width="100%" controls>
Sorry, your browser doesn't support embedded videos. This video demonstrates navigating from a controller action to its view files using code lens.
</video>
### **Go to Definition**
Go to definition is a feature that allows you to navigate to the definition of a symbol.
In VS Code, you can trigger go to definition in 3 different ways:
- Select `Go to Definition` from the context menu
- `F12` on a symbol
- `Cmd + Click` on a symbol
In the following demos, we will use the `Cmd + Click` method to trigger go to definition.
### Go to Active Record Callback and Validation Definitions
Navigates to the definitions of Active Record callbacks and validations.
<video src="images/ruby-lsp-rails-go-to-ar-dsl-definitions.mp4" width="100%" controls>
Sorry, your browser doesn't support embedded videos. This video shows jumping to an Active Record callback definition.
</video>
### Go to Active Record Associations
Navigates to the definitions of Active Record associations.
<video src="images/ruby-lsp-rails-go-to-ar-associations.mp4" width="100%" controls>
Sorry, your browser doesn't support embedded videos. This video shows navigating to Active Record association definitions.
</video>
### Go to Route Helper Definitions
<video src="images/ruby-lsp-rails-go-to-route-definitions.mp4" width="100%" controls>
Sorry, your browser doesn't support embedded videos. This video demonstrates navigating to route helper definitions.
</video>
### **Ruby File Operations**
The Ruby LSP extension provides a `Ruby file operations` icon in the Explorer view that can be used to trigger
the `Rails generate` and `Rails destroy` commands.
<video src="images/ruby-lsp-rails-file-operations-icon.mp4" width="100%" controls>
Sorry, your browser doesn't support embedded videos. This video shows using the Ruby file operations icon for Rails generate/destroy commands.
</video>
### Commands
These commands are also available in the Command Palette.
#### Rails Generate
<video src="images/ruby-lsp-rails-generate-command.mp4" width="100%" controls>
Sorry, your browser doesn't support embedded videos. This video shows running a Rails generate command from VS Code.
</video>
#### Rails Destroy
<video src="images/ruby-lsp-rails-destroy-command.mp4" width="100%" controls>
Sorry, your browser doesn't support embedded videos. This video shows running a Rails destroy command from VS Code.
</video>
### **Run and Debug**
The Rails add-on provides 3 ways to run and debug `ActiveSupport` tests using the `Code Lens` feature.
### Run Tests With Test Explorer
<video src="images/ruby-lsp-rails-run.mp4" width="100%" controls>
Sorry, your browser doesn't support embedded videos. This video shows running tests with Test Explorer.
</video>
### Run Tests In The Terminal
<video src="images/ruby-lsp-rails-run-in-terminal.mp4" width="100%" controls>
Sorry, your browser doesn't support embedded videos. This video shows running tests in the terminal via code lens.
</video>
### Debug Tests With VS Code
<video src="images/ruby-lsp-rails-debug.mp4" width="100%" controls>
Sorry, your browser doesn't support embedded videos. This video shows debugging tests with VS Code.
</video>
## Settings
The following setting configures aspects of the Rails add-on. Values shown are the defaults.
```jsonc
// Settings for all add-ons
"rubyLsp.addonSettings": {
// Settings for the Rails add-on
"Ruby LSP Rails": {
// Enable prompt for pending migrations
"enablePendingMigrationsPrompt": true
}
}
```
|
