Reduce Clojure linter warning noise #17491
Merged
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
ilmotta
requested review from
cammellos,
flexsurfer,
yqrashawn,
ajayesivan and
mohsen-ghafouri
Jenkins BuildsClick to see older builds (8)
|
mohsen-ghafouri
approved these changes
Oct 3, 2023
yqrashawn
approved these changes
Oct 4, 2023
Thanks for reporting that @yqrashawn. I was super puzzled by that too, but then I found a fix in the Makefile. If we add a missing ampersand between the clj-kondo and the previous command , the target prints the warnings (see commit 2f29d3e). |
ilmotta
force-pushed
the
chore/reduce-warning-noise
branch
from
8788a4e to
30ab933
Compare
jakubgs
reviewed
Oct 4, 2023
jakubgs
reviewed
Oct 4, 2023
jakubgs
reviewed
Oct 4, 2023
ilmotta
force-pushed
the
chore/reduce-warning-noise
branch
from
30ab933 to
2f2f4dc
Compare
jakubgs
approved these changes
Oct 4, 2023
Warnings can be printed by:
make lint CLJ_LINTER_PRINT_WARNINGS=true
ilmotta
force-pushed
the
chore/reduce-warning-noise
branch
from
2f2f4dc to
e09032e
Compare
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.
Summary
This PR changes the make
linttarget default behavior to NOT show clj-kondo warnings.In the CI I kept the same behavior, i.e. show all warnings and errors simultaneously.
Motivation
When devs run
make lint, most of the time, they don't want to see a long list of warnings. Their focus is on the errors. Additionally, the majority of devs in the mobile team see clj-kondo warnings in their editors of choice already.We (some of us) believe the editor feedback/warnings are sufficiently noisy.
But I don't like this new default!
Okay, add the following somewhere in your config files:
export CLJ_LINTER_PRINT_WARNINGS=trueDo you think we should invert the logic?
I can also change this PR to invert the logic, i.e. we keep the current behavior (a bit noisy) and then devs can export a
CLJ_LINTER_HIDE_WARNINGS=truein their own environments if they want less noise.Areas that may be impacted
None
Steps to test
make lintmake lint CLJ_LINTER_PRINT_WARNINGS=truestatus: ready