docs: explain how users can customize linting behavior of rules #2062
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
bjaglin
force-pushed
the
docs-lint-behavior
branch
2 times, most recently
from
90b6378 to
180421a
Compare
bjaglin
force-pushed
the
docs-lint-behavior
branch
from
180421a to
ab36713
Compare
bjaglin
commented
Sep 1, 2024
| ``` | ||
| scalafix ... \ | ||
| --settings.DisableSyntax.noFinalize=true \ | ||
| --settings.lint.error.includes=.* \ |
There was a problem hiding this comment.
In a shell context, this needs to be wrapped in single quotes so that * is not processed.
Suggested change
| --settings.lint.error.includes=.* \ | |
| '--settings.lint.error.includes=.*' \ |
However, this syntax is not supported on sbt-scalafix, so I'd rather document the sbt-scalafix one, and let CLI power users figure out by themselves (instead of being very verbose about it here and confusing sbt-scalafix users).
There was a problem hiding this comment.
It turns out that multiline syntax does not work on sbt, so I am taking back what I wrote above and will target CLI/shell syntax instead in another 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.
Closes #2000