Skip to content

Improve the project's readme #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 18, 2023
Merged

Improve the project's readme #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 28 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,41 @@
# RailsRubyLsp
# Rails Ruby Lsp

The RailsRubyLsp is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) extension for extra Rails editor features. As long
as this gem is a part of the project's bundle, the Ruby LSP will automatically load it to provide extra features.
The Rails Ruby Lsp is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) extension for extra Rails editor features, such as:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The Rails Ruby Lsp is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) extension for extra Rails editor features, such as:
The Rails Ruby LSP is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) extension for extra Rails editor features, such as:


## Usage

This gem includes two elements that together allow for more Rails functionality in the editor. The first is a Rails
engine that automatically exposes some APIs when running the Rails server in development mode. The second is a Ruby LSP
extension that knows how to connect to the exposed APIs to fetch runtime information from the Rails server.

In order to get the extra functionality in the editor, the Rails server must be running.
- Displaying an ActiveRecord model's database columns and types when hovering over it
- (More to come!)

Note: the Ruby LSP does not need to be restarted every time the Rails server is booted. If you need to shutdown the
server, the extra features will simply disappear and come back once the server is running again.

## Installation

Add this line to your application's Gemfile:
To install, add the following line to your application's Gemfile:

```ruby
gem "rails_ruby_lsp"
group :development do
gem "rails_ruby_lsp"
end
```

## Usage

1. Start your Rails server
1. Hover over an ActiveRecord model to see its details
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Hover over an ActiveRecord model to see its details
1. Hover over an ActiveRecord model class name to see its details

(in case people mistakenly try to hover over the filename, etc.)


## How It Works

This gem consists of two components that enable enhanced Rails functionality in the editor:

1. A Rails engine that automatically exposes APIs when Rails server is running
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. A Rails engine that automatically exposes APIs when Rails server is running
1. A Rails engine that exposes APIs while the Rails server is running.

1. A Ruby LSP extension that connects to the exposed APIs to fetch runtime information from the Rails server

This is why the Rails server needs to be running for features to work.

> **Note**
>
> There is no need to restart the Ruby LSP every time the Rails server is booted.
> If the server is shut down, the extra features will temporarily disappear and reappear once the server is running again.


## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/rails_ruby_lsp. This project is
Expand Down