Prepare for Doxia 2.0.0

apache · Oct 11, 2023 · 86fad5f · 86fad5f
1 parent 8092879
commit 86fad5f
Show file tree

Hide file tree

Showing 23 changed files with 56 additions and 79 deletions.
diff --git a/maven-plugin-annotations/pom.xml b/maven-plugin-annotations/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-annotations</artifactId>

diff --git a/maven-plugin-plugin/pom.xml b/maven-plugin-plugin/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <groupId>org.apache.maven.plugins</groupId>

diff --git a/maven-plugin-report-plugin/pom.xml b/maven-plugin-report-plugin/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <groupId>org.apache.maven.plugins</groupId>
@@ -86,7 +86,12 @@
     <dependency>
       <groupId>org.apache.maven.doxia</groupId>
       <artifactId>doxia-sink-api</artifactId>
-      <version>1.11.1</version>
+      <version>2.0.0-M7</version>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.maven.doxia</groupId>
+      <artifactId>doxia-integration-tools</artifactId>
+      <version>2.0.0-M11</version>
     </dependency>
 
     <!-- shared -->
@@ -243,8 +248,9 @@
               <settingsFile>src/it/settings.xml</settingsFile>
               <streamLogsOnFailures>true</streamLogsOnFailures>
               <filterProperties>
-                <sitePluginVersion>3.12.1</sitePluginVersion>
-                <projectInfoReportsPlugin>3.4.1</projectInfoReportsPlugin>
+                <sitePluginVersion>4.0.0-M9</sitePluginVersion>
+                <projectInfoReportsPlugin>4.0.0-M1-SNAPSHOT</projectInfoReportsPlugin>
+                <compilerPluginVersion>3.11.0</compilerPluginVersion>
                 <antVersion>${antVersion}</antVersion>
               </filterProperties>
               <properties>

diff --git a/...-plugin-report-plugin/src/it/plugin-report-annotations/src/main/java/org/DummyReport.java b/...-plugin-report-plugin/src/it/plugin-report-annotations/src/main/java/org/DummyReport.java
@@ -107,21 +107,18 @@ protected MavenProject getProject() {
      * {@inheritDoc}
      */
     public boolean canGenerateReport() {
+        if (skip || skipReport) {
+            getLog().info("Maven Plugin Plugin Report generation skipped.");
+            return false;
+        }
+
         return true;
     }
 
     /**
      * {@inheritDoc}
      */
     protected void executeReport(Locale locale) throws MavenReportException {
-        if (!canGenerateReport()) {
-            return;
-        }
-        if (skip || skipReport) {
-            getLog().info("Maven Plugin Plugin Report generation skipped.");
-            return;
-        }
-
         // Generate the plugin's documentation
         generatePluginDocumentation(locale);
     }

diff --git a/maven-plugin-report-plugin/src/it/plugin-report-with-javadoc-links/pom.xml b/maven-plugin-report-plugin/src/it/plugin-report-with-javadoc-links/pom.xml
@@ -100,9 +100,6 @@ under the License.
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-site-plugin</artifactId>
         <version>@sitePluginVersion@</version>
-        <configuration>
-          <locales>en</locales>
-        </configuration>
       </plugin>
     </plugins>
   </build>

diff --git a/maven-plugin-report-plugin/src/it/plugin-report-with-javadoc-links/verify.groovy b/maven-plugin-report-plugin/src/it/plugin-report-with-javadoc-links/verify.groovy
@@ -21,11 +21,11 @@ def mojoDoc = new File( basedir, 'target/site/test-mojo.html' )
 
 assert mojoDoc.isFile()
 
-assert mojoDoc.text.contains('<b>See also:</b> <a class="externalLink" href="https://docs.oracle.com/javase/8/docs/api/java/util/Collections.html">java.util.Collections</a></div>') // mojo description see javadoc tag
+assert mojoDoc.text.contains('<strong>See also:</strong> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collections.html" class="externalLink">java.util.Collections</a></div>') // mojo description see javadoc tag
 
 assert mojoDoc.text.contains('beans parameter leveraging <a href="apidocs/org/SimpleBean.html"><code>SimpleBean</code></a>.') // parameter description
 assert mojoDoc.text.contains('<td><code><a href="apidocs/org/SimpleBean.html">Collection&lt;SimpleBean&gt;</a></code></td>') // type link in parameter overview
-assert mojoDoc.text.contains('<li><b>Type</b>: <code><a href="apidocs/org/SimpleBean.html">java.util.Collection&lt;org.SimpleBean&gt;</a></code></li>') // type link in parameter details
+assert mojoDoc.text.contains('<li><strong>Type</strong>: <code><a href="apidocs/org/SimpleBean.html">java.util.Collection&lt;org.SimpleBean&gt;</a></code></li>') // type link in parameter details
 
 assert mojoDoc.text.contains('<div>invalid javadoc reference <code>org.apache.maven.artifact.Artifact</code>.</div>') // second parameter description with link being removed (as no javadoc site associated)
 

diff --git a/maven-plugin-report-plugin/src/it/plugin-report/pom.xml b/maven-plugin-report-plugin/src/it/plugin-report/pom.xml
@@ -91,7 +91,7 @@ under the License.
         <artifactId>maven-site-plugin</artifactId>
         <version>@sitePluginVersion@</version>
         <configuration>
-          <locales>en,de,fr</locales>
+          <locales>default,de,fr</locales>
         </configuration>
       </plugin>
     </plugins>

diff --git a/maven-plugin-report-plugin/src/it/plugin-report/src/main/java/org/DummyReport.java b/maven-plugin-report-plugin/src/it/plugin-report/src/main/java/org/DummyReport.java
@@ -101,19 +101,16 @@ protected MavenProject getProject() {
 
     /** {@inheritDoc} */
     public boolean canGenerateReport() {
+        if (skip || skipReport) {
+            getLog().info("Maven Plugin Plugin Report generation skipped.");
+            return false;
+        }
+
         return true;
     }
 
     /** {@inheritDoc} */
     protected void executeReport(Locale locale) throws MavenReportException {
-        if (!canGenerateReport()) {
-            return;
-        }
-        if (skip || skipReport) {
-            getLog().info("Maven Plugin Plugin Report generation skipped.");
-            return;
-        }
-
         // Generate the plugin's documentation
         generatePluginDocumentation(locale);
     }

diff --git a/...lugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java b/...lugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java
@@ -238,17 +238,16 @@ public String getOutputName() {
     private void generateMojosDocumentation(PluginDescriptor pluginDescriptor, Locale locale)
             throws MavenReportException {
         try {
+            PluginXdocGenerator generator = new PluginXdocGenerator(
+                    getProject(), locale, getReportOutputDirectory(), disableInternalJavadocLinkValidation);
+            PluginToolsRequest pluginToolsRequest = new DefaultPluginToolsRequest(getProject(), pluginDescriptor);
             File outputDir;
             if (!locale.equals(SiteTool.DEFAULT_LOCALE)) {
                 outputDir = new File(new File(generatedSiteDirectory, locale.toString()), "xdoc");
             } else {
                 outputDir = new File(generatedSiteDirectory, "xdoc");
             }
             outputDir.mkdirs();
-
-            PluginXdocGenerator generator = new PluginXdocGenerator(
-                    getProject(), locale, getReportOutputDirectory(), disableInternalJavadocLinkValidation);
-            PluginToolsRequest pluginToolsRequest = new DefaultPluginToolsRequest(getProject(), pluginDescriptor);
             generator.execute(outputDir, pluginToolsRequest);
         } catch (GeneratorException e) {
             throw new MavenReportException("Error writing plugin documentation", e);
@@ -524,7 +523,7 @@ private void renderUsageSection(boolean hasMavenReport) {
             sb.append("  ...").append(Markup.EOL);
             sb.append("</project>");
 
-            verbatimText(sb.toString());
+            verbatimSource(sb.toString());
 
             sink.paragraph();
             linkPatternedText(getI18nString("configuration.end"));

diff --git a/maven-plugin-tools-annotations/pom.xml b/maven-plugin-tools-annotations/pom.xml
@@ -22,7 +22,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-tools-annotations</artifactId>

diff --git a/maven-plugin-tools-api/pom.xml b/maven-plugin-tools-api/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-tools-api</artifactId>

diff --git a/maven-plugin-tools-generators/pom.xml b/maven-plugin-tools-generators/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-tools-generators</artifactId>
@@ -62,7 +62,7 @@
     <!-- other -->
     <dependency>
       <groupId>org.apache.velocity</groupId>
-      <artifactId>velocity</artifactId>
+      <artifactId>velocity-engine-core</artifactId>
     </dependency>
 
     <dependency>

diff --git a/...generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java b/...generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
@@ -81,20 +81,20 @@ public class PluginXdocGenerator implements Generator {
     private final boolean disableInternalJavadocLinkValidation;
 
     /**
-     * Default constructor using <code>Locale.ENGLISH</code> as locale.
+     * Default constructor using <code>Locale.ROOT</code> as locale.
      * Used only in test cases.
      */
     public PluginXdocGenerator() {
         this(null);
     }
 
     /**
-     * Constructor using <code>Locale.ENGLISH</code> as locale.
+     * Constructor using <code>Locale.ROOT</code> as locale.
      *
      * @param project not null Maven project.
      */
     public PluginXdocGenerator(MavenProject project) {
-        this(project, Locale.ENGLISH, new File("").getAbsoluteFile(), false);
+        this(project, Locale.ROOT, new File("").getAbsoluteFile(), false);
     }
 
     /**
@@ -135,7 +135,8 @@ public void execute(File destinationDirectory, PluginToolsRequest request) throw
      * @throws IOException if any
      */
     protected void processMojoDescriptor(MojoDescriptor mojoDescriptor, File destinationDirectory) throws IOException {
-        File outputFile = new File(destinationDirectory, getMojoFilename(mojoDescriptor, "xml"));
+        // TODO Rewrite to: Sink sink = new XdocSinkFactory().createSink(outputDir, "*-mojo.xml", encoding);
+        File outputFile = new File(destinationDirectory, mojoDescriptor.getGoal() + "-mojo.xml");
         try (Writer writer = new OutputStreamWriter(new CachingOutputStream(outputFile), UTF_8)) {
             XMLWriter w = new PrettyPrintXMLWriter(new PrintWriter(writer), UTF_8.name(), null);
             writeBody(mojoDescriptor, w);
@@ -144,15 +145,6 @@ protected void processMojoDescriptor(MojoDescriptor mojoDescriptor, File destina
         }
     }
 
-    /**
-     * @param mojo not null
-     * @param ext  not null
-     * @return the output file name
-     */
-    private String getMojoFilename(MojoDescriptor mojo, String ext) {
-        return mojo.getGoal() + "-mojo." + ext;
-    }
-
     /**
      * @param mojoDescriptor not null
      * @param w              not null
@@ -623,7 +615,6 @@ private void writeParameterList(String title, List<Parameter> parameterList, XML
         w.addAttribute("name", title);
 
         w.startElement("table");
-        w.addAttribute("border", "0");
         w.addAttribute("class", "bodyTable");
 
         w.startElement("tr");

diff --git a/maven-plugin-tools-generators/src/main/resources/pluginxdoc.properties b/maven-plugin-tools-generators/src/main/resources/pluginxdoc.properties
@@ -43,7 +43,7 @@ pluginxdoc.mojodescriptor.parameter.details=Parameter Details
 pluginxdoc.mojodescriptor.parameter.deprecated=<strong>Deprecated.</strong> {0}
 pluginxdoc.mojodescriptor.parameter.name=Name
 pluginxdoc.mojodescriptor.parameter.name_link=<code><a href="#{0}">&lt;{0}&gt;</a></code>
-pluginxdoc.mojodescriptor.parameter.name_internal=<strong><a name="{0}">&lt;{0}&gt;</a></strong>
+pluginxdoc.mojodescriptor.parameter.name_internal=<strong><a id="{0}">&lt;{0}&gt;</a></strong>
 pluginxdoc.mojodescriptor.parameter.description=Description
 pluginxdoc.mojodescriptor.parameter.type=Type
 pluginxdoc.mojodescriptor.parameter.type_link=<a href="{1}">{0}</a>

diff --git a/maven-plugin-tools-generators/src/test/resources/expected-testGoal-mojo.xml b/maven-plugin-tools-generators/src/test/resources/expected-testGoal-mojo.xml
@@ -47,7 +47,7 @@
         </li>
       </ul>
       <subsection name="Required Parameters">
-        <table border="0" class="bodyTable">
+        <table class="bodyTable">
           <tr>
             <th>Name</th>
             <th>Type</th>
@@ -81,7 +81,7 @@
         </table>
       </subsection>
       <subsection name="Optional Parameters">
-        <table border="0" class="bodyTable">
+        <table class="bodyTable">
           <tr>
             <th>Name</th>
             <th>Type</th>
@@ -109,7 +109,7 @@
       <subsection name="Parameter Details">
         <h4>
           <strong>
-            <a name="dir">&lt;dir&gt;</a>
+            <a id="dir">&lt;dir&gt;</a>
           </strong>
         </h4>
         <div>Test parameter description</div>
@@ -142,7 +142,7 @@
         <hr/>
         <h4>
           <strong>
-            <a name="withoutSince">&lt;withoutSince&gt;</a>
+            <a id="withoutSince">&lt;withoutSince&gt;</a>
           </strong>
         </h4>
         <div>(no description)</div>

diff --git a/maven-plugin-tools-java/pom.xml b/maven-plugin-tools-java/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-tools-java</artifactId>

diff --git a/maven-script/maven-plugin-tools-ant/pom.xml b/maven-script/maven-plugin-tools-ant/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-script</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-tools-ant</artifactId>

diff --git a/maven-script/maven-plugin-tools-beanshell/pom.xml b/maven-script/maven-plugin-tools-beanshell/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-script</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-tools-beanshell</artifactId>

diff --git a/maven-script/maven-plugin-tools-model/pom.xml b/maven-script/maven-plugin-tools-model/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-script</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-tools-model</artifactId>

diff --git a/maven-script/maven-script-ant/pom.xml b/maven-script/maven-script-ant/pom.xml
@@ -23,7 +23,7 @@ under the License.
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-script</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-script-ant</artifactId>

diff --git a/maven-script/maven-script-beanshell/pom.xml b/maven-script/maven-script-beanshell/pom.xml
@@ -23,7 +23,7 @@ under the License.
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-script</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-script-beanshell</artifactId>

diff --git a/maven-script/pom.xml b/maven-script/pom.xml
@@ -23,7 +23,7 @@ under the License.
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-script</artifactId>