Config Doc - Use a common pattern for formatting data

danielsoro · Sep 20, 2024 · a22271a · a22271a
1 parent dee8bc1
commit a22271a
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 7 deletions.
diff --git a/.../config-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/AsciidocFormatter.java b/.../config-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/AsciidocFormatter.java
@@ -7,6 +7,7 @@
 
 import io.quarkus.annotation.processor.documentation.config.model.ConfigProperty;
 import io.quarkus.annotation.processor.documentation.config.model.ConfigSection;
+import io.quarkus.annotation.processor.documentation.config.model.Extension;
 import io.quarkus.annotation.processor.documentation.config.model.JavadocElements.JavadocElement;
 import io.quarkus.annotation.processor.documentation.config.util.Types;
 
@@ -185,6 +186,14 @@ String formatSectionTitle(ConfigSection configSection) {
         return javadoc.substring(0, dotIndex);
     }
 
+    String formatName(Extension extension) {
+        if (extension.name() == null) {
+            return extension.artifactId();
+        }
+
+        return extension.name();
+    }
+
     /**
      * Note that this is extremely brittle. Apparently, colons breaks the tooltips but if escaped with \, the \ appears in the
      * output.

diff --git a/...nfig-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/GenerateAsciidocMojo.java b/...nfig-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/GenerateAsciidocMojo.java
@@ -438,22 +438,28 @@ private static Engine initializeQuteEngine(AsciidocFormatter asciidocFormatter)
                         .build())
                 .addValueResolver(ValueResolver.builder()
                         .applyToBaseClass(ConfigProperty.class)
-                        .applyToName("typeDescription")
+                        .applyToName("formatTypeDescription")
                         .applyToNoParameters()
                         .resolveSync(ctx -> asciidocFormatter.formatTypeDescription((ConfigProperty) ctx.getBase()))
                         .build())
                 .addValueResolver(ValueResolver.builder()
                         .applyToBaseClass(ConfigProperty.class)
-                        .applyToName("description")
+                        .applyToName("formatDescription")
                         .applyToNoParameters()
                         .resolveSync(ctx -> asciidocFormatter.formatDescription((ConfigProperty) ctx.getBase()))
                         .build())
                 .addValueResolver(ValueResolver.builder()
                         .applyToBaseClass(ConfigSection.class)
-                        .applyToName("title")
+                        .applyToName("formatTitle")
                         .applyToNoParameters()
                         .resolveSync(ctx -> asciidocFormatter.formatSectionTitle((ConfigSection) ctx.getBase()))
                         .build())
+                .addValueResolver(ValueResolver.builder()
+                        .applyToBaseClass(Extension.class)
+                        .applyToName("formatName")
+                        .applyToNoParameters()
+                        .resolveSync(ctx -> asciidocFormatter.formatName((Extension) ctx.getBase()))
+                        .build())
                 .build();
 
         engine.putTemplate("configReference.qute.adoc",

diff --git a/devtools/config-doc-maven-plugin/src/main/resources/templates/allConfig.qute.adoc b/devtools/config-doc-maven-plugin/src/main/resources/templates/allConfig.qute.adoc
@@ -5,7 +5,7 @@ icon:lock[title=Fixed at build time] Configuration property fixed at build time
 |===
 {#for extensionConfigRootsEntry in configRootsByExtensions}
 
-h|{extensionConfigRootsEntry.key.name.or(extensionConfigRootsEntry.key.artifactId)}
+h|{extensionConfigRootsEntry.key.formatName.escapeCellContent}
 h|Type
 h|Default
 

diff --git a/...fig-doc-maven-plugin/src/main/resources/templates/tags/configProperty.qute.adoc b/...fig-doc-maven-plugin/src/main/resources/templates/tags/configProperty.qute.adoc
@@ -6,8 +6,8 @@ a|{#if configProperty.phase.fixedAtBuildTime}icon:lock[title=Fixed at build time
 
 [.description]
 --
-{configProperty.description.escapeCellContent.or("")}
+{configProperty.formatDescription.escapeCellContent.or("")}
 {#envVar configProperty /}
 --
-{#if configProperty.enum}a{/if}|{configProperty.typeDescription}
+{#if configProperty.enum}a{/if}|{configProperty.formatTypeDescription.escapeCellContent.or("")}
 |{#if configProperty.defaultValue}`{configProperty.defaultValue.escapeCellContent}`{#else if !configProperty.optional}required icon:exclamation-circle[title=Configuration property is required]{/if}
diff --git a/...nfig-doc-maven-plugin/src/main/resources/templates/tags/configSection.qute.adoc b/...nfig-doc-maven-plugin/src/main/resources/templates/tags/configSection.qute.adoc
@@ -1,4 +1,4 @@
-h|[[{configSection.toAnchor(extension)}]] {configSection.title.escapeCellContent}
+h|[[{configSection.toAnchor(extension)}]] {configSection.formatTitle.escapeCellContent}
 h|Type
 h|Default