Skip to content
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

docs: Move Steep in Ruby Section & minor cleanups #2377

Merged
merged 5 commits into from
Dec 21, 2023
Merged

docs: Move Steep in Ruby Section & minor cleanups #2377

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
28860ea
Move Steep in Ruby Section
themilkman Dec 18, 2023
75a2468
Drop activation explanation for Steep
themilkman Dec 18, 2023
cb95d2b
Link to steep & use sh instead of bash for example
themilkman Dec 18, 2023
182a0db
Add `"enabled": true` to steep config example
themilkman Dec 20, 2023
88566b6
Convert steep example to global style
themilkman Dec 21, 2023
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
57 changes: 28 additions & 29 deletions docs/src/language_servers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -542,6 +542,34 @@ There are multiple options:
}
```

### Steep

1. Add the `steep` gem (see [github:soutaro/steep](https://github.com/soutaro/steep)) into your Gemfile and install it

```sh
bundle install
Copy link
Member

Choose a reason for hiding this comment

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

I don't know the ruby ecosystem but why are those instructions say to add to "gemfile" while instructions for other servers say to use gem install? Is it because this approach is local to the project while gem install is for installing globally? If so then shouldn't we recommend to install globally in this case also?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've been thinking about this, too. I already had a commit prepared but skipped it as I did not want to change too much in the scope of this PR. Especially that no other Ruby LSP mentions the "add it to your project" way, which it is when adding it to the Gemfile - I also thought it should be changed. I am not sure if dropping this & migrate it to the global way wouldn't be the best solution.
Generally speaking, in order to try steep & test it, locally I did the gem install way to verify it works - and not the described.
Shall I rewrite it to align it with the others?

Copy link
Member

Choose a reason for hiding this comment

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

I would say that project-specific setup should be combined with a project-specific configuration. Unless there is something specific about this server that makes it more suitable for project-specific use, I'd suggest following other setups for global server.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just pushed a commit with a global setup configuration.

```

2. Binstub steep executable

```sh
steep binstub
```

3. Open `Preferences > Package Settings > LSP > Settings` and add the `"steep"` client configuration to the `"clients"`:

```jsonc
{
"clients": {
"steep": {
"enabled": true,
"command": ["bin/steep", "langserver"],
Copy link
Member

Choose a reason for hiding this comment

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

Is this supposed to be a relative path? Because it is here but since this is a global server configuration, it's not likely to work.

"selector": "source.ruby | text.html.ruby",
}
}
}
```

## Rust

Follow installation instructions on [LSP-rust-analyzer](https://github.com/sublimelsp/LSP-rust-analyzer).
Expand Down Expand Up @@ -605,35 +633,6 @@ Follow installation instructions on [LSP-metals](https://github.com/scalameta/me
}
```

## Steep

1. Add the steep gem into your Gemfile and install it

```bash
bundle install
```

2. Binstub steep executable

```bash
steep binstub
```

3. Open `Preferences > Package Settings > LSP > Settings` and add the `"steep"` client configuration to the `"clients"`:

```jsonc
{
"clients": {
"steep": {
"command": ["bin/steep", "langserver"],
"selector": "source.ruby | text.html.ruby",
}
}
}
```

4. Activate server for the currect project - open Command Palette `LSP: Enable Language Server in Project > steep`

## Stylelint

Follow installation instructions on [LSP-stylelint](https://github.com/sublimelsp/LSP-stylelint).
Expand Down