Tweak the auto-correction result console output for clarity #3522
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A colleague was confused by the output of `swiftlint autocorrect`, she couldn't understand why SwiftLint told her it corrected thousands of files when she only touched one. The "Done correcting \(files.count) ..." output made her think that a change was made on each of the `files`, when really they had only been inspected. A good solution would be to adopt a similar approach as the `lint` command does. Not being familiar with the codebase, I though a good first step could have been to tweak the message a bit, making it clearer that the count printed to the console is the inspected files.
Generated by 🚫 Danger |
|
Sure, thanks for the PR! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello dear SwiftLint maintainers 👋
A colleague was confused by the output of
swiftlint autocorrect, she couldn't understand why SwiftLint told her it corrected thousands of files when she only touched one.The
Done correcting \(files.count)...output made her think that a change was made on each of thefiles, when really they had only been inspected.A good solution would be to adopt a similar approach as the
lintcommand does.Not being familiar with the codebase, I though a good first step could have been to tweak the message a bit, making it clearer that the count printed to the console is the inspected files.
If the idea resonates and you'd rather implement a more refined solution, feel free to take over the branch or close this PR. I don't have the time to dive in and see if I can get it to work myself right now, but loop me in the conversation and let me know if there's anything you need from me to help.
Thanks for maintaining this great tool 🙇♂️