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

Find @Option annotations without example values #3917

Merged
merged 2 commits into from
Jan 15, 2024

Conversation

timtebeek
Copy link
Contributor

@timtebeek timtebeek self-assigned this Jan 15, 2024
@timtebeek timtebeek added the recipe Requested Recipe label Jan 15, 2024
@timtebeek
Copy link
Contributor Author

@koppor / @MBoegers since you were involved; if this gets a thumbs up I'll merge and deploy. :)

@knutwannheden
Copy link
Contributor

Should we possibly exclude Boolean typed options?

Copy link

@koppor koppor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I miss some documentation for one test case

@timtebeek timtebeek merged commit ddf55a1 into main Jan 15, 2024
1 check passed
@timtebeek timtebeek deleted the find-option-annotations-without-example-values branch January 15, 2024 16:34
@MBoegers
Copy link
Contributor

nice! just out of curiositiy, wouldn't be a //todo: be easier to find?

@timtebeek
Copy link
Contributor Author

Right now we produce a search marker, which has separate handling in the Moderne Platform to show the results there. That would be my main goal with this recipe to have a list of missing examples, and a hint at how to resolve that on a PR. Inserting a comment is also an option, but lacks that more sophisticated handling.

@MBoegers
Copy link
Contributor

MBoegers commented Jan 15, 2024 via email

@timtebeek
Copy link
Contributor Author

Adding a link to the recipe as it can be run from the platform:
https://app.moderne.io/recipes/org.openrewrite.java.recipes.MissingOptionExample
From this initial run it appears we only have a handful of cases still to cover 🎉
https://app.moderne.io/results/cCwlMe3wr

image

@timtebeek
Copy link
Contributor Author

Looking over the results once more we can flag even fewer cases by ignoring primitives b044c5d

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
recipe Requested Recipe
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants