Fix addition of unwanted options to console task #66

seveneves · 2022-04-15T06:46:20Z

#61 broke filtering of console scalacOptions

This is fixed with the help of a new setting key tpolecatExcludeOptions that is used to filter out all options and not just the current additions.

Also, this PR adds tests to console, ThisProject and ThisBuild direct usages of scalacOptions

seveneves · 2022-04-15T06:55:32Z

@DavidGregory084 Addition of the new key and vals broke the binary compatibility with 0.2.0. I guess this is resolvable by a new version 0.3.0. Let me know what you think

… of unwanted options to console task Fix test reference Fix test reference Fix test reference

DavidGregory084 · 2022-04-15T13:15:58Z

@seveneves I don't mind the addition of new methods (I don't think we should promise forward binary compatibility in this plugin), but I think the main problem is this:

[error]  * method tpolecatConsoleOptionsFilter()scala.Function1 in object io.github.davidgregory084.TpolecatPlugin#autoImport does not have a correspondent in current version
[error]    filter with: ProblemFilters.exclude[DirectMissingMethodProblem]("io.github.davidgregory084.TpolecatPlugin#autoImport.tpolecatConsoleOptionsFilter")

Do you think there is a way that we can make this change and still retain that method? If not I don't mind cutting 0.3.0.

seveneves · 2022-04-15T14:24:40Z

method tpolecatConsoleOptionsFilter

Yes of course, it was removed thus it is backwards incompatible. I didn't consider it to be public API till I noticed it's mentioned in the readme.

I think it is possible to change tpolecatExcludeOptions to be accepting a function of Set[ScalacOption] => Set[ScalacOption] that would be performing "modifications" to options. But then you could also add or remove options with it. In this case, the renamed setting key can point to the removed tpolecatConsoleOptionsFilter. This will be a backwards compatible change on the binary level.

But it won't be possible to still keep the following working

IntegrationTest / console / tpolecatScalacOptions ~= tpolecatConsoleOptionsFilter

And I think it is a nicer sbt "API" just to have a Set[ScalacOption] to exclude options that are not needed/unwanted in different scopes. Also, it is clear what is the intention of tpolecatExcludeOptions is. Besides, any additions should be done via += operators to the corresponding settings keys instead of using a function Set[ScalacOption] => Set[ScalacOption]. I think it is more of "natural" sbt way of doing changes to ones build.

But this is just my opinion and you might think differently. Let me know if I should do it via Set[ScalacOption] => Set[ScalacOption]

seveneves · 2022-04-15T14:25:47Z

@DavidGregory084 ☝️
forgot to tag you

seveneves · 2022-04-15T14:35:14Z

src/main/scala/io/github/davidgregory084/TpolecatPlugin.scala

+        val filters    = scalacOptionsFor(scalaV, tpolecatExcludeOptions.value).toSet
+        val newOptions = scalacOptionsFor(scalaV, tpolecatScalacOptions.value)
+        (previous ++ newOptions).filterNot(filters).distinct
+      }
    ),
    tpolecatDevModeOptions := ScalacOptions.default,


@DavidGregory084 I would also move this to build or global settings as "common" defaults. If one uses ThisBuild / tpolecatDevModeOptions it will have same problems as did scalacOptions in #60. Wdyt?

Yeah we can definitely try that!

DavidGregory084 · 2022-04-22T15:24:23Z

And I think it is a nicer sbt "API" just to have a Set[ScalacOption] to exclude options that are not needed/unwanted in different scopes. Also, it is clear what is the intention of tpolecatExcludeOptions is. Besides, any additions should be done via += operators to the corresponding settings keys instead of using a function Set[ScalacOption] => Set[ScalacOption]. I think it is more of "natural" sbt way of doing changes to ones build.

Yes I totally agree - when the consoleOptionsFilter was first added it was inspired by a recommendation I saw for filtering out scalacOptions for use with Tut and I didn't really think a great deal about it at the time!

DavidGregory084 · 2022-04-22T15:27:19Z

src/main/scala/io/github/davidgregory084/TpolecatPlugin.scala

@@ -129,7 +123,13 @@ object TpolecatPlugin extends AutoPlugin {

  override def projectSettings: Seq[Setting[_]] = Seq(
    Def.derive(
-      scalacOptions ++= scalacOptionsFor(scalaVersion.value, tpolecatScalacOptions.value)
+      scalacOptions := {


I have just noticed the change from ++= back to := - does that still behave correctly in relation to the issue you saw on #60?

Yes. Look at the back reference of scalacOptions.value in the body of the task

Cool, just wanted to understand whether it affected the fix of the previous issue 😛

I added a test to catch the problem. It should be working :)

DavidGregory084 · 2022-04-22T15:30:46Z

Other than the question about := vs ++= this looks great to me.

In order to unblock your build I think we need to set mimaPreviousArtifacts in build.sbt to Set.empty on this PR until we can publish 0.3.0.

We can also empty out the mimaBinaryIssueFilters as they will no longer be relevant for 0.3.0!

seveneves · 2022-04-22T16:12:14Z

In order to unblock your build I think we need to set mimaPreviousArtifacts in build.sbt to Set.empty on this PR until we can publish 0.3.0.
We can also empty out the mimaBinaryIssueFilters as they will no longer be relevant for 0.3.0!

I set both of them to empty values. I'm not entirely sure how to populate mimaBinaryIssueFilters back.

DavidGregory084 · 2022-04-22T16:14:39Z

I set both of them to empty values. I'm not entirely sure how to populate mimaBinaryIssueFilters back.

That's absolutely fine - since we are going to move to a new reference "mimaPreviousArtifact" there will be no binary compatibility issues to filter out, hopefully that makes sense. The existing filters were there to ignore methods that were added since 0.2.0.

DavidGregory084 · 2022-04-22T16:15:10Z

Thanks for this @seveneves!

seveneves force-pushed the bugfix/consoleOptions branch from 6b42ab1 to 1a9f26e Compare April 15, 2022 06:56

Introduce tpolecatExcludeOptions setting key and fix wrong addition…

20f29c4

… of unwanted options to console task Fix test reference Fix test reference Fix test reference

seveneves force-pushed the bugfix/consoleOptions branch from e0aa717 to 20f29c4 Compare April 15, 2022 07:12

Ivan Stanislavciuc added 2 commits April 15, 2022 10:42

Fix README.md

de56931

Remove ignored keyword

9f7cdaf

seveneves commented Apr 15, 2022

View reviewed changes

DavidGregory084 reviewed Apr 22, 2022

View reviewed changes

Ivan Stanislavciuc added 2 commits April 22, 2022 18:09

Move tpolecatDevModeOptions to build scope

930a4bb

Reset mimaPreviousArtifacts and mimaBinaryIssueFilters

d245e64

DavidGregory084 merged commit 6494873 into typelevel:main Apr 22, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix addition of unwanted options to console task #66

Fix addition of unwanted options to console task #66

seveneves commented Apr 15, 2022

seveneves commented Apr 15, 2022 •

edited

Loading

DavidGregory084 commented Apr 15, 2022

seveneves commented Apr 15, 2022 •

edited

Loading

seveneves commented Apr 15, 2022

seveneves Apr 15, 2022

DavidGregory084 Apr 22, 2022

DavidGregory084 commented Apr 22, 2022

DavidGregory084 Apr 22, 2022

seveneves Apr 22, 2022 •

edited

Loading

DavidGregory084 Apr 22, 2022

seveneves Apr 22, 2022

DavidGregory084 commented Apr 22, 2022 •

edited

Loading

seveneves commented Apr 22, 2022

DavidGregory084 commented Apr 22, 2022

DavidGregory084 commented Apr 22, 2022

Fix addition of unwanted options to console task #66

Fix addition of unwanted options to console task #66

Conversation

seveneves commented Apr 15, 2022

seveneves commented Apr 15, 2022 • edited Loading

DavidGregory084 commented Apr 15, 2022

seveneves commented Apr 15, 2022 • edited Loading

seveneves commented Apr 15, 2022

seveneves Apr 15, 2022

Choose a reason for hiding this comment

DavidGregory084 Apr 22, 2022

Choose a reason for hiding this comment

DavidGregory084 commented Apr 22, 2022

DavidGregory084 Apr 22, 2022

Choose a reason for hiding this comment

seveneves Apr 22, 2022 • edited Loading

Choose a reason for hiding this comment

DavidGregory084 Apr 22, 2022

Choose a reason for hiding this comment

seveneves Apr 22, 2022

Choose a reason for hiding this comment

DavidGregory084 commented Apr 22, 2022 • edited Loading

seveneves commented Apr 22, 2022

DavidGregory084 commented Apr 22, 2022

DavidGregory084 commented Apr 22, 2022

seveneves commented Apr 15, 2022 •

edited

Loading

seveneves commented Apr 15, 2022 •

edited

Loading

seveneves Apr 22, 2022 •

edited

Loading

DavidGregory084 commented Apr 22, 2022 •

edited

Loading