micronaut-data icon indicating copy to clipboard operation
micronaut-data copied to clipboard

Discrepancy between documentation and pre-generated-project using wizard

Open EnriqueWood opened this issue 1 year ago • 3 comments
trafficstars

Issue description

According to the documentation, you should add this dependency using "annotationProcessor" (https://micronaut-projects.github.io/micronaut-data/snapshot/guide/#dbc)

image

However, when you go to the wizard and generate a pre-configured project using the link https://micronaut.io/launch?features=data-jdbc&lang=GROOVY&build=GRADLE it has that same dependency marked as "compileOnly" image

EnriqueWood avatar Mar 28 '24 22:03 EnriqueWood

Groovy doesn't have a concept of annotation processors, because it's dynamic it uses compile plugins

dstepanov avatar Apr 15 '24 10:04 dstepanov

Thanks for pointing out the reasons why it's that way it's implemented in the wizard.

To improve the clarity of the projects' documentation, it would be beneficial to specify that for Groovy-based projects, dependencies should be declared as compileOnly instead of annotationProcessor. This clarification will help anyone integrating micronaut-data into their existing projects, instead of using the wizard to start from scratch. This could prevent potential confusion and ensure smoother integration for these users.

I hope you'll consider making this change as it could help avoid confusions in the integration process

EnriqueWood avatar Apr 15 '24 15:04 EnriqueWood

@wetted revise our documentation in every module that adds an annotation processor and add an asciidoc callout.

NOTE: For Kotlin, add the REPLACE_ANN_ARTIFACT_ID dependency in https://docs.micronaut.io/4.4.3/guide/#kaptOrKsp[kapt or ksp scope], and for Groovy add REPLACE_ANN_ARTIFACT_ID in compileOnly scope.

sdelamo avatar Apr 19 '24 08:04 sdelamo

@wetted revise our documentation in every module that adds an annotation processor and add an asciidoc callout.

I have completed this for all the modules I found with docs for annotation processors.

wetted avatar Apr 30 '24 14:04 wetted