Skip to content

Commit b639c13

Browse files
committed
Add FEATURES.md to demonstrate Ruby LSP Rails features
1 parent b47335b commit b639c13

14 files changed

+84
-0
lines changed

FEATURES.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Features
2+
3+
- [Document Symbol](#document-symbol)
4+
- [Active Record DSLs and Associations](#active-record-dsls-and-associations)
5+
- [Active Support Test Cases](#active-support-test-cases)
6+
- [Go to Controller Action Route](#go-to-controller-action-route)
7+
- [Go to Controller Action View](#go-to-controller-action-view)
8+
- [Go to Definition](#go-to-definition)
9+
- [Active Record DSLs and Associations](#active-record-dsls-and-associations-1)
10+
- [Route Helpers](#route-helpers)
11+
- [Ruby File Operations](#ruby-file-operations)
12+
- [Commands](#commands)
13+
- [Rails Generate](#rails-generate)
14+
- [Rails Destroy](#rails-destroy)
15+
- [Icon](#icon)
16+
- [Run and Debug](#run-and-debug)
17+
- [Run Tests With Test Explorer](#run-tests-with-test-explorer)
18+
- [Run Tests In The Terminal](#run-tests-in-the-terminal)
19+
- [Debug Tests With VS Code](#debug-tests-with-vs-code)
20+
21+
## Document Symbol
22+
23+
### Active Record DSLs and Associations
24+
25+
![Document Symbol for Active Record DSLs and Associations](./ruby-lsp-rails-ar-dsl-document-symbol.gif)
26+
27+
### Active Support Test Cases
28+
29+
![Document Symbol for tests](./ruby-lsp-rails-test-document-symbol.gif)
30+
31+
## Go to Controller Action Route
32+
33+
![Go to Controller Action Route](./ruby-lsp-rails-controller-action-to-route.gif)
34+
35+
## Go to Controller Action View
36+
37+
![Go to Controller Action View](./ruby-lsp-rails-controller-action-to-view.gif)
38+
39+
## Go to Definition
40+
41+
### Active Record DSLs and Associations
42+
43+
This feature enables quick navigation between related model files in Rails projects. Developers can jump between
44+
associations like `belongs_to` and `has_many` using IDE shortcuts, improving code exploration and productivity.
45+
46+
![Active Record DSLs and Associations](./ruby-lsp-rails-ar-definitions-demo.gif)
47+
48+
### Route Helpers
49+
50+
![Route Helpers](./ruby-lsp-rails-go-to-route-definition.gif)
51+
52+
## Ruby File Operations
53+
54+
### Commands
55+
56+
#### Rails Generate
57+
58+
![Rails Generate](./ruby-lsp-rails-generate-command.gif)
59+
60+
#### Rails Destroy
61+
62+
![Rails Destroy](./ruby-lsp-rails-destroy-command.gif)
63+
64+
### Icon
65+
66+
The Ruby LSP extension also provides a `Ruby file operations` icon in the Explorer view that can be used to trigger
67+
the above commands.
68+
69+
![Ruby file operations](./ruby-lsp-rails-file-operations-icon.gif)
70+
71+
## Run and Debug
72+
73+
### Run Tests With Test Explorer
74+
75+
![Run Tests With Test Explorer](./ruby-lsp-rails-run.gif)
76+
77+
### Run Tests In The Terminal
78+
79+
![Run Tests In The Terminal](./ruby-lsp-rails-run-in-terminal.gif)
80+
81+
### Debug Tests With VS Code
82+
83+
![Debug Tests With VS Code](./ruby-lsp-rails-debug.gif)

Rakefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ RDoc::Task.new do |rdoc|
2323
rdoc.rdoc_files.include("*.md", "lib/**/*.rb")
2424
rdoc.rdoc_dir = "docs"
2525
rdoc.markup = "markdown"
26+
rdoc.title = "Ruby LSP Rails"
2627
rdoc.generator = "snapper"
2728
rdoc.options.push("--copy-files", "misc")
2829
rdoc.options.push("--copy-files", "LICENSE.txt")
1.03 MB
Loading
282 KB
Loading
Loading
Loading

misc/ruby-lsp-rails-debug.gif

565 KB
Loading
989 KB
Loading
154 KB
Loading
1.27 MB
Loading
141 KB
Loading
416 KB
Loading

misc/ruby-lsp-rails-run.gif

276 KB
Loading
737 KB
Loading

0 commit comments

Comments
 (0)