Update lombok section at README.md#1624
Conversation
From the [release notes](https://projectlombok.org/changelog) of Lombok: > v1.18.34 (June 28th, 2024) > IMPROBABLE BREAKING CHANGE: Lombok now adds @lombok.Generated by default to methods and types it generates. This may result in accidentally increasing your test coverage percentage. Issue #3667.
|
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughThe README’s Lombok section now states that Lombok v1.18.34+ adds Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 86-88: Add a language specifier to the fenced code block in the
README snippet so the markdownlint warning is resolved; update the Lombok config
example around the `lombok.addLombokGeneratedAnnotation` entry to use a labeled
fence such as `properties` (or `text`) while keeping the snippet content
otherwise unchanged.
- Line 87: The README Lombok configuration snippet is wrong because it shows the
setting disabled instead of enabled; update the
`lombok.addLombokGeneratedAnnotation` example in the README so it matches the
intended guidance and the `lombok.config` usage. Use the existing Lombok config
example and the surrounding text in the README to locate the snippet, and make
sure the documented value is the one that emits `@lombok.Generated` for Lombok
versions before 1.18.34.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: ffa2ef5b-2b98-4068-855f-6619d594b398
📒 Files selected for processing (1)
README.md
There was a problem hiding this comment.
♻️ Duplicate comments (1)
README.md (1)
87-87: 🎯 Functional Correctness | 🔴 Critical | ⚡ Quick winSet this Lombok flag to
true
lombok.addLombokGeneratedAnnotation = falsedisables@lombok.Generated, but this section tells users to enable the behavior for Lombok < 1.18.34.Suggested change
- lombok.addLombokGeneratedAnnotation = false + lombok.addLombokGeneratedAnnotation = true🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` at line 87, The README’s Lombok configuration is inconsistent with the surrounding guidance for Lombok < 1.18.34: update the documented flag value from false to true in the Lombok settings section so the example matches the intended behavior. Locate the `lombok.addLombokGeneratedAnnotation` entry and change it to the enabled setting without altering the rest of the explanation.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Duplicate comments:
In `@README.md`:
- Line 87: The README’s Lombok configuration is inconsistent with the
surrounding guidance for Lombok < 1.18.34: update the documented flag value from
false to true in the Lombok settings section so the example matches the intended
behavior. Locate the `lombok.addLombokGeneratedAnnotation` entry and change it
to the enabled setting without altering the rest of the explanation.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 4ed17cb8-282d-4b56-934f-4c927fb0d442
📒 Files selected for processing (1)
README.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 86-89: Add a language specifier to the fenced snippet in the
README so the Lombok configuration block is marked as properties. Update the
markdown code fence around the lombok.addLombokGeneratedAnnotation setting to
use the properties tag, keeping the existing content unchanged and ensuring the
README markdownlint warning is resolved.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 870d415f-d316-4b56-a418-e8800aef0876
📒 Files selected for processing (1)
README.md
|
@jevanlingen you'll need to sign the CLA before we can accept this PR. Thanks again! |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1624 +/- ##
=========================================
Coverage 88.10% 88.10%
Complexity 3046 3046
=========================================
Files 105 105
Lines 10181 10181
Branches 2062 2062
=========================================
Hits 8970 8970
Misses 572 572
Partials 639 639 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
3 participants
The README.md regarding Lombok is outdated. The
@lombok.Generatedannotation is set by default. From the release notes of Lombok:I tested it myself, seems to work just fine.
Summary by CodeRabbit
@lombok.Generatedis added by default to generated code.lombok.configsetting.@lombok.Generatedbehavior may break compatibility.