You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "kwin (via GitHub)" <gi...@apache.org> on 2023/12/30 11:48:39 UTC
[PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
kwin opened a new pull request, #171:
URL: https://github.com/apache/maven-site-plugin/pull/171
This is WIP to gather early feedback
--
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-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
Posted by "michael-o (via GitHub)" <gi...@apache.org>.
michael-o commented on PR #171:
URL: https://github.com/apache/maven-site-plugin/pull/171#issuecomment-1890398224
@kwin Can you adapt to recent changes to the sitetools PR? I'd like to review this today.
--
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-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
Posted by "michael-o (via GitHub)" <gi...@apache.org>.
michael-o commented on code in PR #171:
URL: https://github.com/apache/maven-site-plugin/pull/171#discussion_r1444061958
##########
src/main/java/org/apache/maven/plugins/site/render/ReportDocumentRenderer.java:
##########
@@ -131,6 +131,7 @@ public Sink createSink(File outputDirectory, String outputName) {
docRenderingContext.getBasedirRelativePath(),
document,
docRenderingContext.getParserId(),
+ docRenderingContext.getParserConfiguration(), // TODO: use another config?
Review Comment:
This does not make sense for reports.
--
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-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
Posted by "jira-importer (via GitHub)" <gi...@apache.org>.
jira-importer commented on PR #171:
URL: https://github.com/apache/maven-site-plugin/pull/171#issuecomment-2974825270
Resolve #1121
--
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: dev-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
Posted by "kwin (via GitHub)" <gi...@apache.org>.
kwin commented on code in PR #171:
URL: https://github.com/apache/maven-site-plugin/pull/171#discussion_r1439879467
##########
src/main/java/org/apache/maven/plugins/site/render/ParserConfiguration.java:
##########
@@ -0,0 +1,72 @@
+/*
+ * 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.plugins.site.render;
+
+import java.util.LinkedList;
+import java.util.List;
+
+import org.apache.maven.shared.utils.io.MatchPattern;
+import org.apache.maven.shared.utils.io.MatchPatterns;
+
+public class ParserConfiguration {
+
+ /**
+ * List of {@link MatchPattern} strings. If not set this configurations applies to all documents.
+ */
+ private final List<String> patterns;
+ /**
+ * @see {@link Parser#setEmitComments(boolean)}
+ */
+ private boolean emitComments;
+ /**
+ * @see {@link Parser#setEmitAnchorsForIndexableEntries(boolean)}
+ */
+ private boolean emitAnchorsForIndexableEntries;
+
+ public ParserConfiguration() {
+ patterns = new LinkedList<>();
+ }
+
+ public boolean isEmitComments() {
+ return emitComments;
+ }
+
+ public void setEmitComments(boolean emitComments) {
+ this.emitComments = emitComments;
+ }
+
+ public boolean isEmitAnchorsForIndexableEntries() {
+ return emitAnchorsForIndexableEntries;
+ }
+
+ public void setEmitAnchorsForIndexableEntries(boolean emitAnchorsForIndexableEntries) {
+ this.emitAnchorsForIndexableEntries = emitAnchorsForIndexableEntries;
+ }
+
+ public void addPattern(String pattern) {
+ patterns.add(pattern);
+ }
+
+ public MatchPatterns getPatterns() {
Review Comment:
Returning a Predicate on the file name is probably better instead of exposing the impl here.
--
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-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
Posted by "kwin (via GitHub)" <gi...@apache.org>.
kwin commented on code in PR #171:
URL: https://github.com/apache/maven-site-plugin/pull/171#discussion_r1438573138
##########
src/main/java/org/apache/maven/plugins/site/render/ParserConfiguration.java:
##########
@@ -0,0 +1,72 @@
+/*
+ * 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.plugins.site.render;
+
+import java.util.LinkedList;
+import java.util.List;
+
+import org.apache.maven.shared.utils.io.MatchPattern;
+import org.apache.maven.shared.utils.io.MatchPatterns;
+
+public class ParserConfiguration {
Review Comment:
This is supposed to be passed to https://github.com/apache/maven-doxia-sitetools/blob/dacaa552c1b8e89eed84db0f43b6b0a72be91d0c/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java
--
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-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org