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

Document Refaster rule & recipe development #230

Closed
timtebeek opened this issue Sep 4, 2023 · 1 comment · Fixed by #242
Closed

Document Refaster rule & recipe development #230

timtebeek opened this issue Sep 4, 2023 · 1 comment · Fixed by #242
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@timtebeek
Copy link
Contributor

timtebeek commented Sep 4, 2023

What problem are you trying to solve?

Allow users to discover Refaster rules as a quick way to get started with recipe development.
Either as a complete solution, or a starting point by copying the generate recipe into src/main.

Describe the solution you'd like

A page describing how Refaster recipe development works, and what that offers as compared to the other ways of defining recipes.

Additional context

Example here: https://github.com/openrewrite/rewrite-migrate-java/blob/v2.0.10/src/main/java/org/openrewrite/java/migrate/apache/commons/lang/ApacheCommonsStringUtils.java#L168-L178

Partially covered here: moderneinc/springboot-migration-workshop#18

Requires the annotation processor here: https://github.com/openrewrite/rewrite-templating

@timtebeek timtebeek added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 4, 2023
@timtebeek
Copy link
Contributor Author

@mike-solomon this one might be worthwhile to document & link back to under types of recipes here. Knut knows more if I'm unavailable.

@timtebeek timtebeek moved this to Backlog in OpenRewrite Sep 13, 2023
@timtebeek timtebeek linked a pull request Oct 27, 2023 that will close this issue
@github-project-automation github-project-automation bot moved this from Backlog to Done in OpenRewrite Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant