Skip to content

v2.5.0

Latest
Latest
Compare
Choose a tag to compare
@github-actions github-actions released this 04 Dec 17:21
· 20 commits to main since this release
v2.5.0
dc5cf41

Anvil now experimentally supports incremental compilation and Gradle's build caching, as of v2.5.0.

This feature is disabled by default. It can be enabled via a Gradle property or the Gradle DSL:

Gradle Properties 
# gradle.properties
com.squareup.anvil.trackSourceFiles=true # default is false
Gradle DSL 
// build.gradle
anvil {
  trackSourceFiles = true // default is false
}

Removed

Added

  • Incremental compilation and build caching fixes (#836)
  • Configuration options can now be set via Gradle properties (#851)

Changed

  • Anvil's generated hints are now all generated to the same anvil.hint package, which simplifies hint lookups and better future-proofs future KSP work. Note that this is a user-invisible change, but it will require a one-time recompilation of any Anvil-generated hints. (#975)
  • Interface merging is now done in the IR backend, improving performance and future compatibility with K2.
  • @ContributesBinding and @ContributesMultibinding have been completely reworked to a new implementation that generates one binding dagger module for each contributed binding. While not an ABI-breaking change, this does change the generated code and requires users to re-run Anvil's code gen over any projects contributing bindings in order to be merged with the new implementation.

Deprecated

  • ClassReference.functions has been deprecated in favor of ClassReference.memberFunctions and ClassReference.declaredMemberFunctions
  • ClassReference.properties has been deprecated in favor of ClassReference.memberProperties and ClassReference.declaredMemberProperties
  • ClassName.generateClassName() and ClassReference.generateClassName() have been renamed to __.joinSimpleNames() for the sake of clarity. The ClassName version has also moved packages, so its new fully qualified name is com.squareup.anvil.compiler.internal.joinSimpleNames.
  • ClassName.generateClassNameString() has been renamed/moved to com.squareup.anvil.compiler.internal.generateHintFileName().
  • ContributesBinding.priority has been deprecated in favor of the int-value-based ContributesBinding.rank. This allows for more granular prioritization, rather than just the three enum entries that ContributesBinding.Priority offered.

Important

IDE auto-replace can auto-replace the enum entry with the corresponding integer, but not the named argument. Automatically-migrated code may wind up with something like priority = RANK_NORMAL. This is an IntelliJ limitation.

Fixed

  • don't leak Anvil's annotation artifacts to the target project's compile classpath (#822)
  • Gradle configuration caching will no longer be invalidated by changes to ir-merges.txt (#1045)
  • The Anvil plugin will no longer cause KaptGenerateStubsTask tasks to be configured eagerly (#1043)
  • resolve inherited field-injected generic properties to their substituted type (#1040)
  • Resolve generic types when checking Subcomponent factory return types (#1041)
  • consider ignoreQualifier arguments when checking for duplicate bindings (#1033)
  • incremental compilation is automatically disabled for source sets that perform interface or module merging (#1024)
  • include inherited functions in Subcomponent Factory checks (#1038)
  • Anvil will now attempt to shorten the names of hint files, generated "merged" subcomponents, and contributed binding modules so that all file names derived from them will have 255 characters or fewer.
  • cache generated file paths relative to the build directory (changed from project directory) (#979)
  • pass files with only top-level function/property declarations to CodeGenerator implementations (#956)
  • rename the new int-based priority to rank, restore the enum to priority (#957)
  • Fix private targets API use (#961)
  • Always generate provider factories for binding modules (#951)
  • use the resolved value of const arguments in propagated annotation arguments (#940)
  • re-run analysis between an incremental sync and code generation (#943)
  • delay @ContributesSubcomponent generation until the last analysis rounds (#946)
  • Code generated because of a @Contributes___ annotation in a dependency module is now correctly deleted when there is a relevant change in the dependency module.
  • Nested interfaces and modules can now be contributed to enclosing classes.
  • Don't fail the build when a @Binds-annotated function binds a generic type (#885)
    • This is a revert of the changes in (#833).
  • Binding supertype which is narrower than return type is wrongly allowed by @IlyaGulya in (#833)
  • Don't cache the projectDir or binaryFile as part of GeneratedFileCache (#883)
  • Add restored-from-cache, previously-generated files to analysis results after code generation (#882)

Dependencies

  • Update dependency gradle to v8.11.1 (#1072)
  • Update dagger to v2.51.1 (#944)
  • Upgrade Kotlin to 1.9.24 (#891)

Custom Code Generator

  • The GeneratedFile result type has been deprecated in favor of GeneratedFileWithSources. This new type allows for precise tracking of the generated files, which in turn drastically improves incremental compilation performance (#693).

Other Notes & Contributions

Full Changelog: v2.4.9...v2.5.0

Contributors

IlyaGulya and brentwatson
Assets 2
Loading