Skip to content

Commit 65c9d0c

Browse files
authored
Docs/add rubocop minimum version (#2828)
* Add rubocop version in the documentation * Add reminder to update the documentation when changing the minimum version of Rubocop * Fix wrong text in the documentation about rubocop being a required dependency * Replace implicit dependencies text to dependency compatibility
1 parent 6a75c1f commit 65c9d0c

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

jekyll/index.markdown

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Want to discuss Ruby developer experience? Consider joining the public
2323
- [With VS Code](#with-vs-code)
2424
- [With other editors](#with-other-editors)
2525
- [Composed Ruby LSP bundle](#composed-ruby-lsp-bundle)
26+
- [Dependency Compatibility](#dependency-compatibility)
2627
- [Add-ons](#add-ons)
2728
- [General features](#general-features)
2829
- [Hover](#hover)
@@ -88,6 +89,10 @@ project's dependencies).
8889
The Ruby LSP executable generates a composed bundle with the goal of not requiring users to add the `ruby-lsp` gem to
8990
their Gemfiles, and at the same time being able to hook into project dependencies. [Learn more](composed-bundle).
9091

92+
### Dependency Compatibility
93+
94+
The Ruby LSP can provide an enhanced experience if RuboCop is present in the project. While using it is optional, if you do choose to include RuboCop, make sure it’s version 1.4.0 or higher.
95+
9196
## Add-ons
9297

9398
The Ruby LSP provides an add-on system that allows other gems to enhance the base functionality with more editor

lib/ruby_lsp/requests/support/rubocop_runner.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
return
1616
end
1717

18+
# Remember to update the version in the documentation (usage/dependency-compatibility section) if you change this
1819
# Ensure that RuboCop is at least version 1.4.0
1920
begin
2021
gem("rubocop", ">= 1.4.0")

0 commit comments

Comments
 (0)