Implement automatic fixes for ImmutablesStyle
#1846
Conversation
Generate changelog in
|
|
Another option is to just fix by suppressing warnings for this check. This check is really targeted at libraries - it matters less for servers. And most of our widely used libraries are well maintained and not blocked on this check. The check will still prevent new occurrences because we don't apply fixes by default, so that seems like a reasonable compromise. Especially given that this check has been out for almost 2 months now. |
|
That's fair, I've updated the top-level-class case to suppress, while nested classes still get a new meta-annotation |
| " @Target(ElementType.TYPE)", | ||
| " @Retention(RetentionPolicy.SOURCE)", | ||
| " @Value.Style(visibility = Value.Style.ImplementationVisibility.PUBLIC)", | ||
| " @interface PersonStyle {}", |
There was a problem hiding this comment.
Can this be private? Or does that not work with immutables?
There was a problem hiding this comment.
It would fail to compile when encapsulated within an interface, in that case the annotation will be public. I’m not terribly worried about that case because it won’t have any runtime impact, only build time.
|
Released 4.5.0 |
###### _excavator_ is a bot for automating changes across repositories. Changes produced by the roomba/latest-baseline-oss check. # Release Notes ## 4.5.0 | Type | Description | Link | | ---- | ----------- | ---- | | Improvement | Implement automatic fixes for `ImmutablesStyle` | palantir/gradle-baseline#1846 | ## 4.6.0 | Type | Description | Link | | ---- | ----------- | ---- | | Improvement | Suppress existing `ProxyNonConstantType` failures to ease rollout | palantir/gradle-baseline#1850 | To enable or disable this check, please contact the maintainers of Excavator.
Before this PR
Lots of blocked baseline-upgrade excavators, which in turn block Gradle 7 rollout.
After this PR
Autofix the
ImmutablesStylecheck in a naive way. I'm not thrilled with the code we produce, but I think it satisfies the classpath cleanliness concern without requiring manual intervention.==COMMIT_MSG==
Implement automatic fixes for
ImmutablesStyle==COMMIT_MSG==
Possible downsides?
The error-prone fix api doesn't allow us to create new files, so I've added suppressions for our
OuterTypeFilenameandOneTopLevelClasscheckstyle rules.Ideally we'd detect style configurations that match our style library and use that instead.
Ideally we'd aggregate identical style configurations into a single meta-annotation instead of creating one per class.