Read the variables from Maven/Gradle plugin

I use the plugin and the Maven plugin.

I defined some variables in the Maven plugin, e.g. sources_path, I only write sources_path and the Java class filename when I include some source codes. Then the Maven plugin can deal with the document.

But the plugin does not deal with the variables, so it does not show the code when I open the preview.

Could it read the variables from Maven/Gradle plugin?

[ahus1]

I mark this issue as a “help wanted”. I as a maintainer am willing to help anyone who wants to take up this task.

The current functionality around finding attributes inside the current project is within the class AsciiDocUtil.findAttributes(). Some search the whole file, some search attribute relevant to the selected PsiElement (that usually means the current file).

One first approach could be:

• find all pom.xml files in the project
• search for the Asciidoctor Maven Plugin and extract the attributes
• add the attributes to the list

The AsciiDocUtil.collectAntoraAttributes() take a similar approach to collect attributes specific to Antora.

Further improvements could include (not necessarily in the first iteration):

• support might be limited to those scenarios where the project has Maven support enabled in the IDE/in the project; it could try to leverage exiting Maven support within the JetBrains platform
• if the attribute value in the pom.xml contains Maven placeholders (like for example ${project.build.sourceDirectory}), these could be replaced
• the Maven plugin defines a sourcedir. Given some evaluation, it might make sense to restrict attributes declared in the maven module to files in that source directory. Please discuss.

Again, I’m willing to support everyone who wants to take up this task. The Contributor’s Guide for Coders contains information how to setup a coding environment for this plugin.

[diguage]

@ahus1 It is a great solution. Thanks a lot!

The best solution might take time. But the trade-off solution is already a huge improvement. Thank you again.