Add name and dependencies to recipe markdown generation

openrewrite / rewrite-recipe-markdown-generator

Utility that generates OpenRewrite recipe documentation in markdown format for all recipes on the classpath.

https://docs.openrewrite.org/recipes

Apache License 2.0

2 stars 8 forks source link

Add name and dependencies to recipe markdown generation #1

Closed kmccarp closed 3 years ago

kmccarp commented 3 years ago

As the owner of a service that uses a framework (e.g. JUnit 4)
I want to know the exact code I need to add to my workspace
So that I can add the recipe to my pom or build.gradle without guessing at dependencies

Example recipe: https://docs.openrewrite.org/reference/recipes/java/changemethodname

Ideally this would do the following:

Auto-generated Maven snippet
Auto-generated Gradle snippet
Link to the recipe on Github (optional)

okundzich commented 3 years ago

Also https://github.com/openrewrite/rewrite-docs/issues/42, not sure if it's a duplicate or related

kmccarp commented 3 years ago

Good catch -- this definitely looks like a duplicate of (or extension to) openrewrite/rewrite-docs#42. Ideally we would have yaml, maven, gradle examples auto-generated for the framework owner.

sambsnyd commented 3 years ago

It has been done https://github.com/openrewrite/rewrite-recipe-markdown-generator/commit/912d678e151afefe15df0f6acc8feb3f438cebe3