https://github.com/soutaro/steep-vscode

VSCode extension for Steep
https://github.com/soutaro/steep-vscode

Last synced: 10 days ago
JSON representation

VSCode extension for Steep

• Host: GitHub
• URL: https://github.com/soutaro/steep-vscode
• Owner: soutaro
• License: mit
• Created: 2020-01-09T14:04:58.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-23T20:50:16.000Z (13 days ago)
• Last Synced: 2024-10-24T08:40:45.062Z (13 days ago)
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=soutaro.steep-vscode
• Size: 656 KB
• Stars: 75
• Watchers: 3
• Forks: 6
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Steep VSCode Integration

This extension is to integrate [Steep](https://github.com/soutaro/steep) to Visual Studio Code.

It has LSP features including:

* On-the-fly error reporting

* Hover for method calls and variables

* Completion for method names and variables

## Commands and options

* *Restart all* command restarts all Steep processes running for the VSCode. Try this command if something is not working correctly.

* *Loglevel* option allows to control log level of Steep command. If you set `debug`, many debug prints will be printed and will help you debugging Steep.

* *Steepfile* option allows to change the `Steepfile` path.

* *Gemfile* option allows to change the `Gemfile` path.

## How it works

When you open folder in VSCode, it checks if there is a `Steepfile` in the directory.

When `Steepfile` is found, it starts Steep by `bundle exec steep langserver`.

If you have a binstub `bin/steep`, it will be used instead of `bundle exec steep`. (`bin/steep langserver`)

Requirements are:

1. You have to have `Steepfile` in the root of the folder. You can change the filename via `steepfile` option.

2. You have to use Bundler.

## Acknowledgments

I want to thank [@wata727](https://github.com/wata727) for his works related to language server protocol support.

He implemented the initial version of VSCode extension ([wata727/vscode-steep-lsc](https://github.com/wata727/vscode-steep-lsc)) and [LSP support in Steep](https://github.com/soutaro/steep/pull/79).