Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: normalize effective getter methods #631

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

timo-a
Copy link
Contributor

@timo-a timo-a commented Dec 15, 2024

What's changed?

Adds recipe that renames "effective getter methods" to the way lombok would name them.

What's your motivation?

When a team starts without lombok, their getter and setter methods will over time stop adhering to the way lombok names them. Maybe the team never followed the lombok naming, maybe fields got renamed but not their getter methods. Maybe previously more complex methods morph into just being just getters but keep their old name...
This recipe will normalize those methods names, so the converter can find them.
This is a separate recipe on purpose. Reasons:

  • due to the edge cases listed in the recipe, it makes sense to split functionality to keep things simple.
  • maybe some recipes follow a different naming convention on purpose. This recipe will make it easy to spot these cases which might be overlooked in the many changes of one big fuzzy recipe
  • if a user only wants to convert lombok naming compliant getters and not rename any recipes, separate recipes make that possible

Anything in particular you'd like reviewers to focus on?

Please evaluate the edge cases. I've estimated that the effort needed to cover them is not worth it, but maybe you can see a way.
Also, I overloaded a method in LombokUtils with the original version. Maybe the methods can be merged?

Anyone you would like to review specifically?

Have you considered any alternatives or workarounds?

Any additional context

Checklist

  • I've added unit tests to cover both positive and negative cases
  • I've read and applied the recipe conventions and best practices
  • I've used the IntelliJ IDEA auto-formatter on affected files

@timo-a timo-a changed the title feat• normalize effective getter methods feat: normalize effective getter methods Dec 15, 2024
timo-a and others added 2 commits December 15, 2024 21:33
…terTest.java

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@timo-a timo-a marked this pull request as ready for review December 21, 2024 22:05
@timtebeek timtebeek self-requested a review December 22, 2024 10:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

1 participant