improve --files CLI UX #378
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
bjaglin
commented
Nov 12, 2023
| @@ -127,13 +127,6 @@ object ScalafixPlugin extends AutoPlugin { | |||
| Invisible | |||
| ) | |||
|
|
|||
| private val scalafixCompletions: SettingKey[ScalafixCompletions] = | |||
There was a problem hiding this comment.
inlining this saves some setting keys (sbt-scalafix adds a lot...)
There was a problem hiding this comment.
This caused a regression, see #405
bjaglin
commented
Nov 12, 2023
| @@ -1,2 +1,2 @@ | |||
| rules = [DisableSyntax] | |||
| rules = [DisableSyntax, RemoveUnused] | |||
There was a problem hiding this comment.
added a semantic rule to trigger the "semanticdb not found" error from the original bug report
bjaglin
commented
Nov 12, 2023
Comment on lines
+21
to
+22
| > scalafix -f=src/main/scala/OK.scala |
There was a problem hiding this comment.
implemented in this PR, thanks to the isAllowedPrefix check on aggregated projects which makes sbt skip aggregated executions silently
bjaglin
commented
Nov 12, 2023
Comment on lines
+31
to
+38
| -> ok_only / scalafixAll -f=ok_only/src/main/scala/OK.scala | ||
|
|
||
| # Targeting valid files from a different project fails | ||
| -> ok_only / scalafix -f=ok_and_ko/src/main/scala/OK.scala | ||
|
|
||
| # Targeting valid files from a different configuration fails | ||
| -> ok_only / Test / scalafix -f=ok_only/src/main/scala/OK.scala |
There was a problem hiding this comment.
implemented in this PR
bjaglin
force-pushed
the
explicit-files
branch
from
371152c
to
e6d109e
Compare
bjaglin
commented
Nov 12, 2023
| loadedRules = () => scalafixInterfaceProvider.value().availableRules(), | ||
| terminalWidth = Some(JLineAccess.terminalWidth), | ||
| allowedTargetFilesPrefixes = | ||
| (scalafix / unmanagedSourceDirectories).value.map(_.toPath) |
There was a problem hiding this comment.
we don't rely on unmanagedSources here as
- we want to be able to target directories as well
- it's a task, not available at settings evaluation time anyway
To avoid getting false positive errors (missing SemanticDB in presence
of semantic rules), scalafix executions with `--files` should not
aggregate as they are by nature specific to a given project /
Configuration.
- prevent usage of scalafixAll --files
- validate --files values against unmanagedSourceDirectories
- allow accurate completions
- avoid aggregated executions: since requested files are not valid
outside the project on which the task input was crafted, sbt simply
ignores the runs
bjaglin
force-pushed
the
explicit-files
branch
from
e6d109e
to
32a9ff7
Compare
Merged
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.
Fixes scalacenter/scalafix#1874
To avoid getting false positive errors (missing SemanticDB in presence of semantic rules), scalafix executions with
--filesshould not aggregate as they are by nature specific to a given project / Configuration.scalafixAll --files--filesvalues againstunmanagedSourceDirectories