From 41dbc934bc965364ba68a7c82e70d3cef70c40cd Mon Sep 17 00:00:00 2001 From: Koichi ITO Date: Mon, 30 Oct 2023 19:15:20 +0900 Subject: [PATCH] Add a note about recommended option in the README.md 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. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 5a5c639..e614e3d 100644 --- a/README.md +++ b/README.md @@ -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+