Add val for "compile-time" sbt Configuration #1889
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
This is another change that makes upgrading to sbt 1.0 easier
and which is compatible with sbt 0.13.
With sbt 1.0 the following line in `commonSettings`:
```
ivyConfigurations += config("compile-time").hide
```
leads to this exception:
```
[info] Loading settings from build.sbt,version.sbt ...
[info] Resolving key references (15580 settings) ...
[error] java.lang.IllegalArgumentException: requirement failed: id must be capitalized: commonSettings
[error] at scala.Predef$.require(Predef.scala:277)
[error] at sbt.librarymanagement.Configuration.<init>(Configuration.scala:19)
[error] at sbt.librarymanagement.Configuration$.of(Configuration.scala:72)
[error] at $61255add5b0123fd7403$.$anonfun$commonSettings$9(build.sbt:47)
```
The reason why `commonSettings` is used as `id` for this "compile-time"
configuration can be found in [this sbt-librarymanagement macro](https://github.com/sbt/librarymanagement/blob/53c80f076a5e9ab469037f352a4d68173140e216/core/src/main/scala/sbt/librarymanagement/ConfigurationExtra.scala#L109-L114).
As the macro suggests, extracting the defintion of the `Configuration`
and assigning it to a `val` fixes the error.
The "compile-time" configuration was added in
typelevel#1638 to remove simulacrum from
the dependencies in the POM. I therefore checked that simulacrum is
still not present in the POM after this change.
Codecov Report
@@ Coverage Diff @@
## master #1889 +/- ##
=======================================
Coverage 95.17% 95.17%
=======================================
Files 248 248
Lines 4352 4352
Branches 126 126
=======================================
Hits 4142 4142
Misses 210 210Continue to review full report at Codecov.
|
kailuowang
approved these changes
Sep 3, 2017
ceedubs
approved these changes
Sep 8, 2017
ghost
mentioned this pull request
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.
This is another change that makes upgrading to sbt 1.0 easier
and which is compatible with sbt 0.13.
With sbt 1.0 the following line in
commonSettings:leads to this exception:
The reason why
commonSettingsis used asidfor this "compile-time"configuration can be found in this sbt-librarymanagement macro.
As the macro suggests, extracting the defintion of the
Configurationand assigning it to a
valfixes the error.The "compile-time" configuration was added in
#1638 to remove simulacrum from
the dependencies in the POM. I therefore checked that simulacrum is
still not present in the POM after this change.