Skip to content

Commit

Permalink
Add a note about recommended option in the README.md
Browse files Browse the repository at this point in the history
I've heard from several users that they run `rubocop -a` (`rubocop -A`) from the command line,
unaware of the "Format On Save" global setting. This PR aims to add a mention of "Format On Save"
to ensure users don't overlook this option.
  • Loading branch information
koic committed Oct 30, 2023
1 parent 2a39c68 commit 41dbc93
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ It supports the following capabilities:
- Fast Document Formatting
- Execute Command ([Trigger autocorrect](https://github.com/rubocop/vscode-rubocop#manually-triggering-a-format-with-autocorrects))

:star2: Enabling [**Format On Save**](https://github.com/rubocop/vscode-rubocop#editorformatonsave) is recommended.
By activating just this one setting, code gets autocorrected every time a file is saved. Don't miss out on this game-changing boost to your development experience!

## Requirements

* [RuboCop](https://rubygems.org/gems/rubocop) 1.53.0+
Expand Down

0 comments on commit 41dbc93

Please sign in to comment.