openrewrite / rewrite-docs

Stores the markdown documents used to generate docs.openrewrite.org
https://docs.openrewrite.org
Apache License 2.0
40 stars 46 forks source link

Expand upon current IDE setup instructions #138

Open timtebeek opened 1 year ago

timtebeek commented 1 year ago

We already have a few places where we describe how to best tune your local environment and IDE for recipe development:

Yet we can possibly do more to lower the barrier for entry into development. Two questions that came up on my end for instance:

  1. When I execute the tests, there is a noticeable delay before the tests start executing, possibly related to resolving latest.release dependencies. What can be done (and documented) to prevent that?
  2. When a recipe does not produce the expected diff, the expected and actual values are printed to the console by default. How to open a dialog for easier visual comparison?

Possibly there will be more such questions for people just getting started, and it would be good to ensure those are resolved to create a smooth recipe development experience.

timtebeek commented 1 year ago

Could be worth documenting the toggle to Run tests using: IntelliJ rather than Gradle for both a speed up and easier result comparison. image