Skip to content

Commit 56aebd7

Browse files
authored
Point all documentation to the official Ruby LSP docs (#455)
1 parent fc99832 commit 56aebd7

24 files changed

+8
-178
lines changed

.github/workflows/ci.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,3 @@ jobs:
5555

5656
- name: Lint Ruby files
5757
run: bin/rubocop
58-
59-
- name: Check if documentation is up to date
60-
run: bundle exec rake ruby_lsp:check_docs

.github/workflows/publish_docs.yml

Lines changed: 0 additions & 31 deletions
This file was deleted.

FEATURES.md

Lines changed: 0 additions & 98 deletions
This file was deleted.

Gemfile

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ gem "rubocop-shopify", "~> 2.15", require: false
1414
gem "rubocop-minitest", "~> 0.35.0", require: false
1515
gem "rubocop-rake", "~> 0.6.0", require: false
1616
gem "rubocop-sorbet", "~> 0.8", require: false
17-
gem "rdoc", require: false, github: "Shopify/rdoc", branch: "create_snapper_generator"
1817
gem "sorbet-static-and-runtime", platforms: :ruby
1918
gem "tapioca", "~> 0.13", require: false, platforms: :ruby
2019
gem "psych", "~> 5.1", require: false

Gemfile.lock

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
GIT
2-
remote: https://github.com/Shopify/rdoc.git
3-
revision: 92a6b4fcf8b72dd6776c9aa6714abe6f90d4a99e
4-
branch: create_snapper_generator
5-
specs:
6-
rdoc (6.6.3.1)
7-
psych (>= 4.0.0)
8-
91
PATH
102
remote: .
113
specs:
@@ -207,6 +199,8 @@ GEM
207199
sorbet-runtime (>= 0.5.9204)
208200
rbs (3.5.2)
209201
logger
202+
rdoc (6.6.3.1)
203+
psych (>= 4.0.0)
210204
regexp_parser (2.9.0)
211205
reline (0.5.7)
212206
io-console (~> 0.5)
@@ -302,7 +296,6 @@ DEPENDENCIES
302296
psych (~> 5.1)
303297
puma
304298
rails
305-
rdoc!
306299
rubocop-minitest (~> 0.35.0)
307300
rubocop-rake (~> 0.6.0)
308301
rubocop-shopify (~> 2.15)
@@ -316,4 +309,4 @@ DEPENDENCIES
316309
webmock
317310

318311
BUNDLED WITH
319-
2.5.6
312+
2.5.19

README.md

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,20 @@
11
[![Ruby DX Slack](https://img.shields.io/badge/Slack-Ruby%20DX-success?logo=slack)](https://join.slack.com/t/ruby-dx/shared_invite/zt-2c8zjlir6-uUDJl8oIwcen_FS_aA~b6Q)
22

3-
# Ruby LSP Rails
3+
# Rails addon
44

5-
Ruby LSP Rails is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) addon for extra [Rails editor features](https://shopify.github.io/ruby-lsp-rails/FEATURES_md.html).
5+
The Rails addon is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) [addon](https://shopify.github.io/ruby-lsp/addons.html) for extra [Rails editor features](https://shopify.github.io/ruby-lsp/rails-addon.html).
66

77
## Installation
88

9-
If you haven't already done so, you'll need to first [set up Ruby LSP](https://github.com/Shopify/ruby-lsp#usage).
9+
If you haven't already done so, you'll need to first [set up Ruby LSP](https://shopify.github.io/ruby-lsp/#usage).
1010

1111
As of v0.3.0, Ruby LSP will automatically include the Ruby LSP Rails addon in its custom bundle when a Rails app is detected.
1212
There is no need to add the gem to your bundle.
1313

1414
## Documentation
1515

16-
See the [documentation](https://shopify.github.io/ruby-lsp-rails) for more in-depth details about the
17-
[supported features](https://shopify.github.io/ruby-lsp-rails/FEATURES_md.html).
18-
19-
## How Runtime Introspection Works
20-
21-
LSP tooling is typically based on static analysis, but `ruby-lsp-rails` actually communicates with your Rails app for
22-
some features.
23-
24-
When Ruby LSP Rails starts, it spawns a `rails runner` instance which runs
25-
[`server.rb`](https://github.com/Shopify/ruby-lsp-rails/blob/main/lib/ruby_lsp/ruby_lsp_rails/server.rb).
26-
The addon communicates with this process over a pipe (i.e. `stdin` and `stdout`) to fetch runtime information about the application.
27-
28-
When extension is stopped (e.g. by quitting the editor), the server instance is shut down.
29-
30-
> [!NOTE]
31-
> Prior to v0.3.0, `ruby-lsp-rails` used a different approach which involved mounting a Rack application within the Rails app.
32-
> That approach was brittle and susceptible to the application's configuration, such as routing and middleware.
16+
See the [documentation](https://shopify.github.io/ruby-lsp/rails-addon.html) for more in-depth details about the
17+
[supported features](https://shopify.github.io/ruby-lsp/rails-addon.html#features).
3318

3419
## Contributing
3520

Rakefile

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,11 @@ load "rails/tasks/statistics.rake"
99

1010
require "bundler/gem_tasks"
1111
require "rake/testtask"
12-
require "ruby_lsp/check_docs"
13-
require "rdoc/task"
1412

1513
Rake::TestTask.new(:test) do |t|
1614
t.libs << "test"
1715
t.libs << "lib"
1816
t.test_files = FileList["test/**/*_test.rb"]
1917
end
2018

21-
RDoc::Task.new do |rdoc|
22-
rdoc.main = "README.md"
23-
rdoc.rdoc_files.include("*.md", "lib/**/*.rb")
24-
rdoc.rdoc_dir = "docs"
25-
rdoc.markup = "markdown"
26-
rdoc.title = "Ruby LSP Rails"
27-
rdoc.generator = "snapper"
28-
rdoc.options.push("--copy-files", "misc")
29-
rdoc.options.push("--copy-files", "LICENSE.txt")
30-
end
31-
32-
RubyLsp::CheckDocs.new(FileList["#{__dir__}/lib/ruby_lsp/**/*.rb"], FileList["#{__dir__}/misc/**/*.gif"])
33-
3419
task default: [:"db:setup", :test]

misc/code_lens.gif

-641 KB
Binary file not shown.

misc/definition.gif

-93.9 KB
Binary file not shown.

misc/document_symbol.gif

-874 KB
Binary file not shown.

misc/hover.gif

-213 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.

misc/ruby-lsp-rails-debug.gif

-565 KB
Binary file not shown.
-989 KB
Binary file not shown.
-263 KB
Binary file not shown.
-154 KB
Binary file not shown.
-1.27 MB
Binary file not shown.
-124 KB
Binary file not shown.
-180 KB
Binary file not shown.
-141 KB
Binary file not shown.
-416 KB
Binary file not shown.

misc/ruby-lsp-rails-run.gif

-276 KB
Binary file not shown.
-737 KB
Binary file not shown.

0 commit comments

Comments
 (0)