Support intellij navigation with zuchini annotations

[jhorstmann]

Initial Idea:

• extract StepDefAnnotation from zuchini-compat-annotations into its own artifact zuchini-compat-step-definition
• have zuchini-annotations depend on this with scope provided or as optional
• annotate zuchini step annotations with cucumber StepDefAnnotation
• have zuchini-intellij-support depend on zuchini-compat-step-definition

[jhorstmann]

Unfortunately does not work since the intellij plugin does not look for the meta annotation, but for the package name of the annotations, see https://github.com/JetBrains/intellij-plugins/blob/35ea1b3433b523b7a4bf60f5a8dd9a989d254722/cucumber-java/src/org/jetbrains/plugins/cucumber/java/steps/AnnotationPackageProvider.java and https://github.com/JetBrains/intellij-plugins/blob/35ea1b3433b523b7a4bf60f5a8dd9a989d254722/cucumber-java/src/org/jetbrains/plugins/cucumber/java/CucumberJavaUtil.java

[whiskeysierra]

So there are two options now, right?

1. Change the IntelliJ plugin to check for meta annotations (and follow the initial idea) or
2. Stick with compatible annotations.

[jhorstmann]

I'd prefer (1), but I have no idea about the effort to get this change into the intellij plugin. Maybe there is also a simpler fix in the plugin, this https://github.com/JetBrains/intellij-plugins/blob/35ea1b3433b523b7a4bf60f5a8dd9a989d254722/cucumber-java/src/org/jetbrains/plugins/cucumber/java/CucumberJavaUtil.java#L64 seems to be comparing qualified names with simple names, if it just compared simple names it would also work for zuchini annotations.

[jhorstmann]

Maybe I looked in the wrong place, https://github.com/JetBrains/intellij-plugins/blob/35ea1b3433b523b7a4bf60f5a8dd9a989d254722/cucumber-java/src/org/jetbrains/plugins/cucumber/java/CucumberJavaExtension.java#L43 seems to do exactly what we want. Maybe the code from previous comments is for generating code snippets. Still does not work though.

[jhorstmann]

Finally got around to debug this. Intellij is building a correct index of step definitions based on the StepDefAnnotation meta annotation, but is using explicit package names when trying to extract the regex for matching.

The call stack (some levels omitted):

• findStepDefinitions: https://github.com/JetBrains/intellij-plugins/blob/d9505d4fa3624aa62be26e1d866de65dae23bdf7/cucumber/src/org/jetbrains/plugins/cucumber/steps/CucumberStepsIndex.java#L119
• getCucumberRegexFromElement: https://github.com/JetBrains/intellij-plugins/blob/35ea1b3433b523b7a4bf60f5a8dd9a989d254722/cucumber-java/src/org/jetbrains/plugins/cucumber/java/steps/JavaStepDefinition.java#L38
• isCucumberStepAnnotation: https://github.com/JetBrains/intellij-plugins/blob/d9505d4fa3624aa62be26e1d866de65dae23bdf7/cucumber-java/src/org/jetbrains/plugins/cucumber/java/CucumberJavaUtil.java#L56

The easiest solution would probably be to just use the same package name as cucumber for the zuchini annotations.

[jhorstmann]

See JetBrains/intellij-plugins#552