Make sbt-scalafix follow conventions around sbt configurations #587
Conversation
|
|
||
| > compile:scalafixTest ProcedureSyntax | ||
| > test:scalafixTest ProcedureSyntax | ||
| > it:scalafixTest ProcedureSyntax |
There was a problem hiding this comment.
This does not test that compile:scalafix is independent from test:scalafix
What about:
-> compile:scalafixTest ProcedureSyntax
-> test:scalafixTest ProcedureSyntax
-> it:scalafixTest ProcedureSyntax
> compile:scalafix ProcedureSyntax
> compile:scalafixTest ProcedureSyntax
-> test:scalafixTest ProcedureSyntax
-> it:scalafixTest ProcedureSyntax
> test:scalafix ProcedureSyntax
> test:scalafixTest ProcedureSyntax
-> it:scalafixTest ProcedureSyntax
> it:scalafix ProcedureSyntax
> it:scalafixTest ProcedureSyntax
|
Missing: Update website/src/main/tut/docs/users/installation.md |
|
I'm in favor of breaking stuff in sbt-scalafix and cut a v0.6. Based on feedback, I think this PR is a good improvement. One more thing I would like to change is stop enabling semanticdb-scalac by default. The auto-installation does not work for all builds, so I prefer to require users to manually I documented the breaking changes I'd like to make for the next release https://github.com/scalacenter/scalafix/milestone/6 Are there any other breaking changes we want to make? |
| ): Seq[Def.Setting[InputTask[Unit]]] = | ||
| (task := impl(configurations).evaluated) +: | ||
| configurations.map(c => task.in(c) := impl(Seq(c)).evaluated) | ||
| lazy val scalafixConfigSettings: Seq[Def.Setting[_]] = scalafixSettings ++ |
There was a problem hiding this comment.
Can we move this to autoImport so users don't have to prefix ScalafixPlugin.?
|
|
||
| _Later this plugin has `scalafixConfigure` method to configure scalafix for custom configuration like IntegrationTest. | ||
| Since 0.6.0 version it now sticks to more canonical way for such configurations. | ||
| The plugin has `scalafixConfigSettings` that can be imported to every configuration by `inConfig(_)`. |
There was a problem hiding this comment.
Can we remove all updates to the sbt-scalafix installation docs? I will can do it in a followup PR.
A general note, sentences like
The plugin has
scalafixConfigSettingsthat can be imported to every configuration byinConfig(_).
are very helpful if you are not aware of what inConfig(_) does. I generally prefer concrete examples like below since that is useful for both expert and beginner users.
| > scalafixCli --rule file:rules/MyRule.scala // Run local custom rule | ||
| > scalafixCli --rule github:org/repo/v1 // Run library migration rule | ||
| > scalafixCli --test // Make sure no files needs to be fixed | ||
| > compile:scalafixCli // Run all rules configured in .scalafix.conf |
There was a problem hiding this comment.
Is the compile: prefix necessary? I would expect it to default to compile:
There was a problem hiding this comment.
Yeah, you're right :)
|
I added Olaf |
|
I included the updated doc in the previous commit, Olaf said:
Well, yes, that's right :) Let's discuss what we can do with the old tasks.
Don't know. It's easy to add, but is it really necessary? |
|
@MasseGuillaume docs will need to be updated separately. The next release will be breaking so it's fine to remove the old task. |
This can be left for a separate PR. |
|
|
olafurpg
changed the title
olafurpg
changed the title
See #461.
This PR breaks the compatibility with the old sbt-scalafix plugin in order to make sbt-scalafix behave more conventionally. Most critically,
scalafixalone runs only in Compile config,test:scalafixmust be explicitly triggered to run in Test configuration.inConfig(IntegrationTest)(scalafixConfigSettings)can be used to enable scalafix in the integration test configuration