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

Jump to bottom

Specify in Readme that global rubocop command is not supported #1911

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Specify in Readme that global rubocop command is not supported #1911

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5dfdd1c
Add code example of how one can enable ruby formatter in VS Code
bibstha Apr 10, 2024
610044b
PR Feedback
bibstha Apr 10, 2024
8c6e0e1
Update README.md
bibstha May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions vscode/README.md
View file
Open in desktop
Expand Up @@ -331,3 +331,17 @@ When `rubyLsp.formatter` is set to `auto`, Ruby LSP tries to determine which for

If the bundle has a **direct** dependency on a supported formatter, such as `rubocop` or `syntax_tree`, that will be used.
Otherwise, formatting will be disabled and you will need add one to the bundle.

Here's a code example:

```ruby
# Gemfile
bibstha marked this conversation as resolved.
Show resolved Hide resolved
group :development do
Copy link
Contributor

Choose a reason for hiding this comment

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

Linters usually need to also run in CI, so let's say group :development, :test do. This matches what Rails 8 will do: https://github.com/rails/rails/blob/main/railties/lib/rails/generators/rails/app/templates/Gemfile.tt

# You can uncomment one of the following to get either rubocp or syntax_tree formatter enabled.
Copy link
Contributor

Choose a reason for hiding this comment

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

Since this is an example, I think it's enough to just say gem "rubocop" and remove the comment.

# gem "rubocop"
# gem "syntax_tree"
end
```

Make sure to run `bundle install` after making the above change.

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 the final new line or an extra empty line at the end? If it's an empty line, can we please remove it?