Add copy button for configuration property

quarkusio · Nov 15, 2024 · 77cbd3b · 77cbd3b
1 parent 0d1aa9a
commit 77cbd3b
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 3 deletions.
diff --git a/...fig-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/GenerateConfigDocMojo.java b/...fig-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/GenerateConfigDocMojo.java
@@ -40,6 +40,7 @@
 import io.quarkus.maven.config.doc.generator.GenerationReport;
 import io.quarkus.maven.config.doc.generator.GenerationReport.GenerationViolation;
 import io.quarkus.qute.Engine;
+import io.quarkus.qute.EngineBuilder;
 import io.quarkus.qute.ReflectionValueResolver;
 import io.quarkus.qute.UserTagSectionHelper;
 import io.quarkus.qute.ValueResolver;
@@ -296,7 +297,7 @@ public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) th
     }
 
     private static Engine initializeQuteEngine(Formatter formatter, Format format, String theme) {
-        Engine engine = Engine.builder()
+        EngineBuilder engineBuilder = Engine.builder()
                 .addDefaults()
                 .addSectionHelper(new UserTagSectionHelper.Factory("configProperty", "configProperty"))
                 .addSectionHelper(new UserTagSectionHelper.Factory("configSection", "configSection"))
@@ -402,9 +403,13 @@ private static Engine initializeQuteEngine(Formatter formatter, Format format, S
                         .applyToName("formatName")
                         .applyToNoParameters()
                         .resolveSync(ctx -> formatter.formatName((Extension) ctx.getBase()))
-                        .build())
-                .build();
+                        .build());
+
+        if (format == Format.asciidoc) {
+            engineBuilder.addSectionHelper(new UserTagSectionHelper.Factory("propertyCopyButton", "propertyCopyButton"));
+        }
 
+        Engine engine = engineBuilder.build();
         engine.putTemplate("configReference",
                 engine.parse(getTemplate("templates", format, theme, "configReference", false)));
         engine.putTemplate("allConfig",
@@ -420,6 +425,11 @@ private static Engine initializeQuteEngine(Formatter formatter, Format format, S
         engine.putTemplate("memorySizeNote",
                 engine.parse(getTemplate("templates", format, theme, "memorySizeNote", true)));
 
+        if (format == Format.asciidoc) {
+            engine.putTemplate("propertyCopyButton",
+                    engine.parse(getTemplate("templates", format, theme, "propertyCopyButton", true)));
+        }
+
         return engine;
     }
 

diff --git a/...gin/src/main/resources/templates/asciidoc/default/tags/configProperty.qute.adoc b/...gin/src/main/resources/templates/asciidoc/default/tags/configProperty.qute.adoc
@@ -1,7 +1,14 @@
 a|{#if configProperty.phase.fixedAtBuildTime}icon:lock[title=Fixed at build time]{/if} [[{configProperty.toAnchor(extension, additionalAnchorPrefix)}]] [.property-path]##link:#{configProperty.toAnchor(extension, additionalAnchorPrefix)}[`{configProperty.path.property}`]##
+ifdef::add-copy-button-to-config-props[]
+{#propertyCopyButton configProperty.path.property /}
+endif::add-copy-button-to-config-props[]
+
 {#for additionalPath in configProperty.additionalPaths}
 
 `{additionalPath.property}`
+ifdef::add-copy-button-to-config-props[]
+{#propertyCopyButton additionalPath.property /}
+endif::add-copy-button-to-config-props[]
 {/for}
 
 [.description]

diff --git a/...src/main/resources/templates/asciidoc/default/tags/propertyCopyButton.qute.adoc b/...src/main/resources/templates/asciidoc/default/tags/propertyCopyButton.qute.adoc
@@ -0,0 +1 @@
+config_property_copy_button:+++{it}+++[]