[
https://issues.apache.org/jira/browse/DOXIASITETOOLS-324?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17829232#comment-17829232
]
ASF GitHub Bot commented on DOXIASITETOOLS-324:
-----------------------------------------------
kwin commented on code in PR #140:
URL:
https://github.com/apache/maven-doxia-sitetools/pull/140#discussion_r1532397290
##########
doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/ParserConfigurator.java:
##########
@@ -0,0 +1,38 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.maven.doxia.siterenderer;
+
+import java.nio.file.Path;
+
+import org.apache.maven.doxia.parser.Parser;
+
+/**
+ * Interface which allows to configure a particular {@link Parser} before it
is being used.
+ */
+public interface ParserConfigurator {
+
+ /**
+ * Configures the given parser, which is afterwards used to parse the
given source file.
+ * @param parserId the parser id
+ * @param filePath the absolute path of the file to parse
+ * @param parser the parser to configure
+ * @return {@code true} if the parser has been configured, otherwise
{@code false}
+ */
+ boolean configure(String parserId, Path filePath, Parser parser);
Review Comment:
pattern is optional, i.e. only parser id is mandatory in MSITE-1000, but
this signature allows an implementation to also make it dependent on file name.
I think passing the path here doesn't hurt and allows for more flexibility on
implementations.
> Allow configuration of parser per markup
> ----------------------------------------
>
> Key: DOXIASITETOOLS-324
> URL: https://issues.apache.org/jira/browse/DOXIASITETOOLS-324
> Project: Maven Doxia Sitetools
> Issue Type: New Feature
> Components: Site renderer
> Reporter: Konrad Windszus
> Assignee: Konrad Windszus
> Priority: Major
>
> Currently the Doxia parsers being used for the Doxia markup sources have a
> fix configuration
> (https://github.com/apache/maven-doxia-sitetools/blob/dacaa552c1b8e89eed84db0f43b6b0a72be91d0c/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java#L324).
> It would be beneficial to allow to dynamically configure the parsers (based
> on a matching markup source path pattern)
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
