Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]

[via GitHub]

kwin commented on code in PR #177:
URL: https://github.com/apache/maven-site-plugin/pull/177#discussion_r1583427213


##########
src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java:
##########
@@ -94,6 +97,37 @@ public abstract class AbstractSiteRenderingMojo extends 
AbstractSiteDescriptorMo
     @Parameter
     private Map<String, Object> attributes;
 
+    /**
+     * Parser configurations (per matching Doxia markup source file path 
patterns).
+     * Each configuration item has the following format:
+     * <p/>
+     * <pre><code>
+     * &lt;parserId&gt
+     *   &lt;configurations&gt;
+     *     &lt;configuration&gt;
+     *       &lt;patterns&gt;
+     *         &lt;pattern&gt;glob:**&#47;*.md&lt;/pattern&gt;&lt;!-- is 
either glob or regex syntax with the according prefix --&gt;
+     *       &lt;/patterns&gt;
+     *       &lt;!-- all configurations apart from pattern are directly 
applied to the underlying parser --&gt;
+     *       &lt;emitComments&gt;true&lt;/emitComments&gt;&lt;!-- false by 
default --&gt;
+     *       
&lt;emitAnchorsForIndexableEntries&gt;false&lt;/emitAnchorsForIndexableEntries&gt;&lt;!--
 true by default --&gt;
+     *     &lt;/configuration&gt;
+     *   &lt;/configurations&gt;
+     * &lt;/parserId&gt
+     * </code></pre>
+     * The configuration is only applied if both
+     * <ul>
+     * <li>the parser id matches the parser used for a specific markup source 
file and</li>
+     * <li>one of the given patterns matches the Doxia markup source file path 
(or no pattern is given at all).</li>
+     * </ul>
+     *
+     * The first matching configuration wins (i.e. is applied).
+     * @since 4.0.0
+     * @see java.nio.file.FileSystem#getPathMatcher(String) 
FileSystem.getPathMatcher(String) for the supported patterns
+     */
+    @Parameter
+    private Map<String, List<PlexusConfiguration>> parserConfigurations;

Review Comment:
   This will make it more complex as then we need to merge multiple 
configurations potentially



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscr...@maven.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org