Avoid adding `org.jspecify:jspecify` when running `MigrateFromSpringFrameworkAnnotations`

[scordio]

What problem are you trying to solve?

When running the Migrate from Spring Framework annotations to JSpecify recipe on a Spring-based project, OpenRewrite adds the org.jspecify:jspecify dependency.

As this is already included transitively by the Spring Core module, the explicit declaration is not required in the project running the recipe.

Describe the solution you'd like

Ideally, after the recipe runs, there should be no new JSpecify dependency added to the build configuration, regardless of whether it's Maven or Gradle.

Have you considered any alternatives or workarounds?

Yes: inspect all build configurations manually after recipe execution and delete the newly introduced dependency.

Additional context

This was spotted during the work at spring-projects/spring-batch@d519849.

Are you interested in contributing this feature to OpenRewrite?

If the project agrees to this change, I'd be happy to contribute! 🙂

---

Relates to:

• Migrate Spring annotations to JSpecify #572

[timtebeek]

Thanks for the offer to help! Great to see you help spring-batch adopt JSpecify. I agree we should not be adding the dependency if it's already present directly or transitively. Looks like we forgot to add this option to these recipes:

rewrite-migrate-java/src/main/resources/META-INF/rewrite/jspecify.yml

Lines 53 to 57 in 67f98d9

	- org.openrewrite.java.dependencies.AddDependency:
	groupId: org.jspecify
	artifactId: jspecify
	version: latest.release
	onlyIfUsing: javax.annotation.*ull*

Look forward to your PR! Or let us know if you'd prefer some of us to pick that up.

[scordio]

@timtebeek I noticed that https://github.com/openrewrite/rewrite-migrate-java/tree/main/src/test/java/org/openrewrite/java/migrate/jspecify has only tests for the JSpecifyBestPractices recipe.

Do you agree to adding test classes for all other JSpecify-related recipes? At least, to have coverage for this issue.

[scordio]

I realized now that JSpecifyBestPracticesTest conceptually wraps all others, so my question is likely not relevant anymore 🙂

[timtebeek]

Indeed, since the test runs JSpecifyBestPractices, that then in turn runs all the others as well:

rewrite-migrate-java/src/main/resources/META-INF/rewrite/jspecify.yml

Lines 18 to 28 in 67f98d9

	name: org.openrewrite.java.jspecify.JSpecifyBestPractices
	displayName: JSpecify best practices
	description: >-
	Apply JSpecify best practices, such as migrating off of alternatives, and adding missing `@Nullable` annotations.
	tags:
	- java
	recipeList:
	- org.openrewrite.java.jspecify.MigrateToJSpecify
	- org.openrewrite.staticanalysis.AnnotateNullableMethods
	- org.openrewrite.staticanalysis.AnnotateNullableParameters
	- org.openrewrite.staticanalysis.NullableOnMethodReturnType