feat(maven-plugin): make execution-root-only rendering opt-out

Adds figlet.executionRootOnly (default true) so a module can still
render its own banner when explicitly configured, instead of always
being skipped in favor of the reactor's execution-root project.

Author: spannm

figlet-maven-plugin/src/main/java/io/github/spannm/figlet/maven/plugin/RenderMojo.java

@@ -36,6 +36,12 @@
  * wrapped in one {@code <figletFont>} tag referencing that font.
  *
  * <h2>Minimal configuration</h2>
+ * An {@code <execution>} is required to bind the goal into the build — a plugin
+ * merely listed in {@code <build><plugins>} without one is never invoked
+ * automatically. No {@code <phase>} is needed inside it, though: the goal
+ * defaults to the {@code validate} phase (see {@link LifecyclePhase#VALIDATE}).
+ * To avoid repeating the {@code <execution>} block in every module, declare it
+ * once in a shared parent POM instead.
  * <pre>{@code
  * <plugin>
  *   <groupId>io.github.spannm</groupId>
@@ -63,10 +69,16 @@
  * }</pre>
  *
  * <h2>Multi-module builds</h2>
- * This goal only executes for the execution-root project (the module Maven
- * was invoked on) and is a no-op for every other module in the reactor, even
- * if bound in a child module's own {@code pom.xml}. This prevents the same
- * banner from being printed once per module.
+ * By default, this goal only executes for the execution-root project (the
+ * module Maven was invoked on) and is a no-op for every other module in the
+ * reactor, even if bound in a child module's own {@code pom.xml}. This
+ * prevents the same banner from being printed once per module when the
+ * execution is inherited from a shared parent POM.
+ * <p>
+ * Some use cases do want a banner per module (e.g. a distinct name per
+ * artifact). Set {@code executionRootOnly} to {@code false} — typically
+ * overridden in a specific module's own {@code <configuration>}, not
+ * globally in the parent — to render there too.
  *
  * @since 1.0.0
  */
@@ -102,7 +114,8 @@ public class RenderMojo extends AbstractFontMojo {
      */
     @Parameter(property = "figlet.content",
         defaultValue = "<lineBreak/><figletFont name=\"standard\">${project.name}</figletFont><lineBreak/><preserveWhitespace>    v${project.version}</preserveWhitespace><lineBreak/>",
-        required = true, alias = "content")
+        required = true,
+        alias = "content")
     private String               parmContent;
 
     /**
@@ -112,16 +125,31 @@ public class RenderMojo extends AbstractFontMojo {
      * When {@code false}, unsupported characters are silently replaced by
      * {@code '?'}, and unresolved placeholders are left as-is (with a warning logged).
      */
-    @Parameter(property = "figlet.strict", defaultValue = "true", alias = "strict")
+    @Parameter(property = "figlet.strict",
+        defaultValue = "true",
+        alias = "strict")
     private boolean              parmStrict;
 
     /**
      * Where to output the ASCII art banner.<br>
      * Supported values are: {@code info}, {@code debug}, {@code stdout}, {@code stderr}.
      */
-    @Parameter(property = "figlet.target", defaultValue = "info", alias = "target")
+    @Parameter(property = "figlet.target",
+        defaultValue = "info",
+        alias = "target")
     private String               parmTarget;
 
+    /**
+     * When {@code true} (the default), this goal only runs for the
+     * execution-root project and is a no-op in every other reactor module —
+     * see the class Javadoc for why. Set to {@code false} in a module that
+     * should render its own banner regardless of reactor position.
+     */
+    @Parameter(property = "figlet.executionRootOnly",
+        defaultValue = "true",
+        alias = "executionRootOnly")
+    private boolean               parmExecutionRootOnly;
+
     /** The current Maven project, injected automatically. */
     @Parameter(defaultValue = "${project}", readonly = true, required = true, alias = "project")
     private MavenProject         parmProject;
@@ -132,8 +160,9 @@ int getWidth() {
 
     @Override
     protected void executeImpl() throws MojoExecutionException, MojoFailureException {
-        if (!parmProject.isExecutionRoot()) {
-            getLog().debug("Skipping figlet rendering: project is not the execution root");
+        if (parmExecutionRootOnly && !parmProject.isExecutionRoot()) {
+            getLog().debug("Skipping figlet rendering: project is not the execution root "
+                + "(set executionRootOnly=false to render in this module too)");
             return;
         }
 

figlet-maven-plugin/src/main/resources/figlet-help.txt

@@ -22,6 +22,9 @@ GOALS
       figlet.width    Output width     (default: 72)
       figlet.strict   Fail on unknown chars (default: true)
       figlet.target   Output target: info/debug/stdout/stderr (default: info)
+      figlet.executionRootOnly
+                      Only render for the execution-root project, skip in
+                      other reactor modules (default: true)
       figlet.skip     Skip this goal   (default: false)
 
   figlet:list-fonts   (no default phase — run standalone)

figlet-maven-plugin/src/test/java/io/github/spannm/figlet/maven/plugin/RenderMojoTest.java

@@ -40,6 +40,7 @@ void setUp() {
         setField(mojo, "parmWidth", 200);
         setField(mojo, "parmStrict", false);
         setField(mojo, "parmProject", createMinimalProject("test-artifact", "test-name", "0.8.15"));
+        setField(mojo, "parmExecutionRootOnly", true);
     }
 
     @Test
@@ -210,6 +211,18 @@ void execute_notExecutionRoot_shouldSkipRendering() throws Exception {
         assertThat(log.debugContains("Skipping figlet rendering")).isTrue();
     }
 
+    @Test
+    void execute_notExecutionRoot_executionRootOnlyFalse_shouldRender() throws Exception {
+        MavenProject project = (MavenProject) getField(mojo, "parmProject");
+        project.setExecutionRoot(false);
+        setField(mojo, "parmExecutionRootOnly", false);
+        setField(mojo, "parmContent", "Hello");
+
+        mojo.execute();
+
+        assertThat(log.infoMessages).isNotEmpty();
+    }
+
     @Test
     void execute_invalidFont_shouldThrowMojoExecutionException() {
         setField(mojo, "parmFont", "invalid-font-name-xyz");