Add lombok.checkReturnValueAnnotation to Lombok best practices - #1214
Merged
Conversation
Lombok 1.18.47 adds the `lombok.checkReturnValueAnnotation` config key, which makes Lombok generate `@lombok.CheckReturnValue` on methods whose return value should not be ignored, such as `@With` methods and `@Builder`'s `build()`.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
lombok.checkReturnValueAnnotationconfig key, which makes Lombok generate@lombok.CheckReturnValueon methods whose return value should not be ignored, such as@Withmethods and@Builder'sbuild(); a future Lombok release may enable it by default.LombokBestPracticesnow appendslombok.checkReturnValueAnnotation += lombokto any existinglombok.configviaAppendToTextFilewithexistingFileStrategy: Merge, which makes it idempotent. The glob{,**/}lombok.configis used rather than**/lombok.configbecause Java'sPathMatcherdoes not match a repository-rootlombok.configagainst the latter; as a consequence nolombok.configis created for projects that lack one.Note that 1.18.47 is not on Maven Central yet (latest is 1.18.46), so until it ships Lombok will print an unknown-config-key warning to stderr;
UpdateLombokToJava11floats on1.18.*and will pick it up automatically.