You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2023/11/12 19:49:05 UTC
(maven-plugin-tools) 01/01: Prepare for Doxia 2.0.0
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch doxia-2.0.0
in repository https://gitbox.apache.org/repos/asf/maven-plugin-tools.git
commit c45d7489b000020d4aefa229e7ca6b61b0417b4a
Author: Michael Osipov <mi...@apache.org>
AuthorDate: Thu Jul 21 18:03:20 2022 +0200
Prepare for Doxia 2.0.0
---
maven-plugin-annotations/pom.xml | 2 +-
maven-plugin-plugin/pom.xml | 2 +-
maven-plugin-report-plugin/pom.xml | 2 +-
.../src/main/java/org/DummyReport.java | 12 ++++--------
.../src/it/plugin-report-with-javadoc-links/pom.xml | 3 ---
maven-plugin-report-plugin/src/it/plugin-report/pom.xml | 2 +-
.../src/it/plugin-report/src/main/java/org/DummyReport.java | 12 ++++--------
.../org/apache/maven/plugin/plugin/report/GoalRenderer.java | 4 ++--
.../maven/plugin/plugin/report/PluginOverviewRenderer.java | 2 +-
.../org/apache/maven/plugin/plugin/report/PluginReport.java | 8 +++-----
maven-plugin-tools-annotations/pom.xml | 2 +-
maven-plugin-tools-api/pom.xml | 2 +-
maven-plugin-tools-generators/pom.xml | 2 +-
.../src/test/resources/expected-testGoal-mojo.xml | 8 ++++----
maven-plugin-tools-java/pom.xml | 2 +-
maven-script/maven-plugin-tools-ant/pom.xml | 2 +-
maven-script/maven-plugin-tools-beanshell/pom.xml | 2 +-
maven-script/maven-plugin-tools-model/pom.xml | 2 +-
maven-script/maven-script-ant/pom.xml | 2 +-
maven-script/maven-script-beanshell/pom.xml | 2 +-
maven-script/pom.xml | 2 +-
pom.xml | 2 +-
22 files changed, 33 insertions(+), 46 deletions(-)
diff --git a/maven-plugin-annotations/pom.xml b/maven-plugin-annotations/pom.xml
index afd27424..2c7617a6 100644
--- 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.10.3-SNAPSHOT</version>
+ <version>3.11.0-SNAPSHOT</version>
</parent>
<artifactId>maven-plugin-annotations</artifactId>
diff --git a/maven-plugin-plugin/pom.xml b/maven-plugin-plugin/pom.xml
index e4db1c10..8845ec99 100644
--- 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.10.3-SNAPSHOT</version>
+ <version>3.11.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
index f7143f0b..e083fcc0 100644
--- 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.10.3-SNAPSHOT</version>
+ <version>3.11.0-SNAPSHOT</version>
</parent>
<groupId>org.apache.maven.plugins</groupId>
diff --git a/maven-plugin-report-plugin/src/it/plugin-report-annotations/src/main/java/org/DummyReport.java b/maven-plugin-report-plugin/src/it/plugin-report-annotations/src/main/java/org/DummyReport.java
index a962b54d..1ac5ad70 100644
--- a/maven-plugin-report-plugin/src/it/plugin-report-annotations/src/main/java/org/DummyReport.java
+++ b/maven-plugin-report-plugin/src/it/plugin-report-annotations/src/main/java/org/DummyReport.java
@@ -107,6 +107,10 @@ public class DummyReport extends AbstractMavenReport {
* {@inheritDoc}
*/
public boolean canGenerateReport() {
+ if (skip || skipReport) {
+ return false;
+ }
+
return true;
}
@@ -114,14 +118,6 @@ public class DummyReport extends AbstractMavenReport {
* {@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
index cabb67cf..b7162360 100644
--- 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/pom.xml b/maven-plugin-report-plugin/src/it/plugin-report/pom.xml
index a6559802..1dcc9937 100644
--- 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
index 2b139ed3..a949dc1f 100644
--- 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,15 @@ public class DummyReport extends AbstractMavenReport {
/** {@inheritDoc} */
public boolean canGenerateReport() {
+ if (skip || skipReport) {
+ 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/main/java/org/apache/maven/plugin/plugin/report/GoalRenderer.java b/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/GoalRenderer.java
index eac6c0c7..8e3b4655 100644
--- a/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/GoalRenderer.java
+++ b/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/GoalRenderer.java
@@ -37,7 +37,7 @@ import java.util.stream.Collectors;
import org.apache.commons.lang3.StringUtils;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics;
-import org.apache.maven.doxia.util.HtmlTools;
+import org.apache.maven.doxia.util.DoxiaUtils;
import org.apache.maven.plugin.descriptor.MojoDescriptor;
import org.apache.maven.plugin.descriptor.Parameter;
import org.apache.maven.plugin.logging.Log;
@@ -260,7 +260,7 @@ public class GoalRenderer extends AbstractPluginReportRenderer {
renderTableCellWithCode(
format("parameter.name", parameter.getName()),
// no need for additional URI encoding as it returns only URI safe characters
- Optional.of("#" + HtmlTools.encodeId(parameter.getName())));
+ Optional.of("#" + DoxiaUtils.encodeId(parameter.getName())));
// type
Map.Entry<String, Optional<String>> type = getLinkedType(parameter, true);
diff --git a/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginOverviewRenderer.java b/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginOverviewRenderer.java
index 5189357e..3a36822e 100644
--- a/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginOverviewRenderer.java
+++ b/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginOverviewRenderer.java
@@ -283,7 +283,7 @@ class PluginOverviewRenderer extends AbstractPluginReportRenderer {
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-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java b/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java
index 1e63aa29..b93d0e1e 100644
--- a/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java
+++ b/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java
@@ -137,7 +137,6 @@ public class PluginReport extends AbstractMavenReport {
@Override
protected void executeReport(Locale locale) throws MavenReportException {
if (skip) {
- getLog().info("Maven Plugin Plugin Report generation skipped.");
return;
}
@@ -205,24 +204,23 @@ public class PluginReport extends AbstractMavenReport {
*/
private void generateMojosDocumentation(PluginDescriptor pluginDescriptor, Locale locale)
throws MavenReportException {
-
if (pluginDescriptor.getMojos() != null) {
for (MojoDescriptor descriptor : pluginDescriptor.getMojos()) {
GoalRenderer renderer;
try {
String filename = descriptor.getGoal() + "-mojo.html";
- Sink sink = getSinkFactory().createSink(outputDirectory, filename);
+ Sink sink = getSinkFactory().createSink(getReportOutputDirectory(), filename);
renderer = new GoalRenderer(
sink,
i18n,
locale,
project,
descriptor,
- outputDirectory,
+ getReportOutputDirectory(),
disableInternalJavadocLinkValidation,
getLog());
} catch (IOException e) {
- throw new MavenReportException("Can not generate sink for mojo " + descriptor.getGoal(), e);
+ throw new MavenReportException("Cannot generate sink for mojo " + descriptor.getGoal(), e);
}
renderer.render();
}
diff --git a/maven-plugin-tools-annotations/pom.xml b/maven-plugin-tools-annotations/pom.xml
index d82fc956..634550c0 100644
--- 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.10.3-SNAPSHOT</version>
+ <version>3.11.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
index 8c1772d9..a6f96571 100644
--- 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.10.3-SNAPSHOT</version>
+ <version>3.11.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
index 13af689a..a37c0e29 100644
--- 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.10.3-SNAPSHOT</version>
+ <version>3.11.0-SNAPSHOT</version>
</parent>
<artifactId>maven-plugin-tools-generators</artifactId>
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
index 331787cb..ced84938 100644
--- 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"><dir></a>
+ <a id="dir"><dir></a>
</strong>
</h4>
<div>Test parameter description</div>
@@ -142,7 +142,7 @@
<hr/>
<h4>
<strong>
- <a name="withoutSince"><withoutSince></a>
+ <a id="withoutSince"><withoutSince></a>
</strong>
</h4>
<div>(no description)</div>
diff --git a/maven-plugin-tools-java/pom.xml b/maven-plugin-tools-java/pom.xml
index f31bc6d4..656c576d 100644
--- 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.10.3-SNAPSHOT</version>
+ <version>3.11.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
index b2c51fc9..e44f7865 100644
--- 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.10.3-SNAPSHOT</version>
+ <version>3.11.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
index 7e57376d..a6ce9929 100644
--- 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.10.3-SNAPSHOT</version>
+ <version>3.11.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
index 35985fda..2be84d01 100644
--- 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.10.3-SNAPSHOT</version>
+ <version>3.11.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
index 05c26b4c..20e2969a 100644
--- 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.10.3-SNAPSHOT</version>
+ <version>3.11.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
index 158acfab..fdc7e80c 100644
--- 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.10.3-SNAPSHOT</version>
+ <version>3.11.0-SNAPSHOT</version>
</parent>
<artifactId>maven-script-beanshell</artifactId>
diff --git a/maven-script/pom.xml b/maven-script/pom.xml
index b7a83e87..5c173a53 100644
--- 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.10.3-SNAPSHOT</version>
+ <version>3.11.0-SNAPSHOT</version>
</parent>
<artifactId>maven-script</artifactId>
diff --git a/pom.xml b/pom.xml
index 68306921..dd7d365c 100644
--- a/pom.xml
+++ b/pom.xml
@@ -29,7 +29,7 @@
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-tools</artifactId>
- <version>3.10.3-SNAPSHOT</version>
+ <version>3.11.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>Maven Plugin Tools</name>