Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
michael-o commented on PR #177: URL: https://github.com/apache/maven-site-plugin/pull/177#issuecomment-2088535907 Here is a fix: https://github.com/apache/maven-plugin-tools/pull/281 -- 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
Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
michael-o commented on PR #177: URL: https://github.com/apache/maven-site-plugin/pull/177#issuecomment-2088483641 The bug is in `org.apache.maven.tools.plugin.generator.PluginDescriptorFilesGenerator.getJavadocUrlForType(JavadocLinkGenerator, String)`. I guess it should until all generics are resolved. -- 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
Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
michael-o commented on PR #177: URL: https://github.com/apache/maven-site-plugin/pull/177#issuecomment-2088245135 It also fails with: `Error generating maven-plugin-report-plugin:3.12.0:report report:` -- 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
Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
michael-o commented on code in PR #177:
URL: https://github.com/apache/maven-site-plugin/pull/177#discussion_r1585980633
##
src/main/java/org/apache/maven/plugins/site/render/ParserConfiguratorImpl.java:
##
@@ -0,0 +1,156 @@
+/*
+ * 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.io.Closeable;
+import java.io.IOException;
+import java.nio.file.FileSystem;
+import java.nio.file.FileSystems;
+import java.nio.file.Path;
+import java.nio.file.PathMatcher;
+import java.util.Collection;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+import org.apache.maven.doxia.parser.Parser;
+import org.apache.maven.doxia.siterenderer.ParserConfigurator;
+import org.apache.maven.plugin.descriptor.MojoDescriptor;
+import org.codehaus.plexus.PlexusContainer;
+import
org.codehaus.plexus.component.configurator.ComponentConfigurationException;
+import org.codehaus.plexus.component.configurator.ComponentConfigurator;
+import
org.codehaus.plexus.component.repository.exception.ComponentLifecycleException;
+import
org.codehaus.plexus.component.repository.exception.ComponentLookupException;
+import org.codehaus.plexus.configuration.PlexusConfiguration;
+
+/**
+ * Configures a parser based on a {@link PlexusConfiguration} for a particular
parser id and optionally matching one of multiple patterns.
+ * It internally leverages the {@link ComponentConfigurator} for calling the
right methods inside the parser implementation.
+ */
+public class ParserConfiguratorImpl implements ParserConfigurator, Closeable {
+
+private static final class ParserConfigurationKey {
+
+ParserConfigurationKey(String parserId, PlexusConfiguration
patternsConfiguration) {
+this(parserId,
PlexusConfigurationUtils.getStringArrayValues(patternsConfiguration));
+}
+
+ParserConfigurationKey(String parserId, Collection patterns) {
+this.parserId = parserId;
+// lazily populate all matchers
+matchers = patterns.stream()
+.map(p -> FileSystems.getDefault().getPathMatcher(p))
+.collect(Collectors.toList());
Review Comment:
I am fine with that.
--
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
Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
michael-o commented on PR #177: URL: https://github.com/apache/maven-site-plugin/pull/177#issuecomment-2084555013 I will happily review again after #185 has been merged. -- 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
Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
kwin commented on code in PR #177:
URL: https://github.com/apache/maven-site-plugin/pull/177#discussion_r1583435793
##
src/main/java/org/apache/maven/plugins/site/render/ParserConfiguratorImpl.java:
##
@@ -0,0 +1,156 @@
+/*
+ * 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.io.Closeable;
+import java.io.IOException;
+import java.nio.file.FileSystem;
+import java.nio.file.FileSystems;
+import java.nio.file.Path;
+import java.nio.file.PathMatcher;
+import java.util.Collection;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+import org.apache.maven.doxia.parser.Parser;
+import org.apache.maven.doxia.siterenderer.ParserConfigurator;
+import org.apache.maven.plugin.descriptor.MojoDescriptor;
+import org.codehaus.plexus.PlexusContainer;
+import
org.codehaus.plexus.component.configurator.ComponentConfigurationException;
+import org.codehaus.plexus.component.configurator.ComponentConfigurator;
+import
org.codehaus.plexus.component.repository.exception.ComponentLifecycleException;
+import
org.codehaus.plexus.component.repository.exception.ComponentLookupException;
+import org.codehaus.plexus.configuration.PlexusConfiguration;
+
+/**
+ * Configures a parser based on a {@link PlexusConfiguration} for a particular
parser id and optionally matching one of multiple patterns.
+ * It internally leverages the {@link ComponentConfigurator} for calling the
right methods inside the parser implementation.
+ */
+public class ParserConfiguratorImpl implements ParserConfigurator, Closeable {
+
+private static final class ParserConfigurationKey {
+
+ParserConfigurationKey(String parserId, PlexusConfiguration
patternsConfiguration) {
+this(parserId,
PlexusConfigurationUtils.getStringArrayValues(patternsConfiguration));
+}
+
+ParserConfigurationKey(String parserId, Collection patterns) {
+this.parserId = parserId;
+// lazily populate all matchers
+matchers = patterns.stream()
+.map(p -> FileSystems.getDefault().getPathMatcher(p))
+.collect(Collectors.toList());
Review Comment:
Hopefully the javadoc comment on the affected parameter is clear enough. I
really don't want to rely on plexus classes for the ant pattern support.
--
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
Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
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 attributes; +/** + * Parser configurations (per matching Doxia markup source file path patterns). + * Each configuration item has the following format: + * + * + * parserId + * configurations + * configuration + * patterns + * patternglob:***.md/pattern!-- is either glob or regex syntax with the according prefix -- + * /patterns + * !-- all configurations apart from pattern are directly applied to the underlying parser -- + * emitCommentstrue/emitComments!-- false by default -- + * emitAnchorsForIndexableEntriesfalse/emitAnchorsForIndexableEntries!-- true by default -- + * /configuration + * /configurations + * /parserId + * + * The configuration is only applied if both + * + * the parser id matches the parser used for a specific markup source file and + * one of the given patterns matches the Doxia markup source file path (or no pattern is given at all). + * + * + * 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> 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
Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
michael-o commented on code in PR #177:
URL: https://github.com/apache/maven-site-plugin/pull/177#discussion_r1572746343
##
src/main/java/org/apache/maven/plugins/site/render/ParserConfiguratorImpl.java:
##
@@ -0,0 +1,156 @@
+/*
+ * 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.io.Closeable;
+import java.io.IOException;
+import java.nio.file.FileSystem;
+import java.nio.file.FileSystems;
+import java.nio.file.Path;
+import java.nio.file.PathMatcher;
+import java.util.Collection;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+import org.apache.maven.doxia.parser.Parser;
+import org.apache.maven.doxia.siterenderer.ParserConfigurator;
+import org.apache.maven.plugin.descriptor.MojoDescriptor;
+import org.codehaus.plexus.PlexusContainer;
+import
org.codehaus.plexus.component.configurator.ComponentConfigurationException;
+import org.codehaus.plexus.component.configurator.ComponentConfigurator;
+import
org.codehaus.plexus.component.repository.exception.ComponentLifecycleException;
+import
org.codehaus.plexus.component.repository.exception.ComponentLookupException;
+import org.codehaus.plexus.configuration.PlexusConfiguration;
+
+/**
+ * Configures a parser based on a {@link PlexusConfiguration} for a particular
parser id and optionally matching one of multiple patterns.
+ * It internally leverages the {@link ComponentConfigurator} for calling the
right methods inside the parser implementation.
+ */
+public class ParserConfiguratorImpl implements ParserConfigurator, Closeable {
+
+private static final class ParserConfigurationKey {
+
+ParserConfigurationKey(String parserId, PlexusConfiguration
patternsConfiguration) {
+this(parserId,
PlexusConfigurationUtils.getStringArrayValues(patternsConfiguration));
+}
+
+ParserConfigurationKey(String parserId, Collection patterns) {
+this.parserId = parserId;
+// lazily populate all matchers
+matchers = patterns.stream()
+.map(p -> FileSystems.getDefault().getPathMatcher(p))
+.collect(Collectors.toList());
Review Comment:
I wonder how this might deviate from what we use to match path patterns. I
not opposing, just mentioning. People are used the stuff we have with Plexus
matching. Keep that in mind.
##
src/main/java/org/apache/maven/plugins/site/render/ParserConfiguratorImpl.java:
##
@@ -0,0 +1,156 @@
+/*
+ * 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.io.Closeable;
+import java.io.IOException;
+import java.nio.file.FileSystem;
+import java.nio.file.FileSystems;
+import java.nio.file.Path;
+import java.nio.file.PathMatcher;
+import java.util.Collection;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+import org.apache.maven.doxia.parser.Parser;
+import org.apache.maven.doxia.siterenderer.ParserConfigurator;
+import org.apache.maven.plugin.descriptor.MojoDescriptor;
+import org.codehaus.plexus.PlexusContainer;
+import
org.codehaus.plexus.component.configurator.ComponentConfigurationException;
+import org.codehaus.plexus.component.configurator.ComponentConfigurator;
+import
Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
michael-o commented on code in PR #177: URL: https://github.com/apache/maven-site-plugin/pull/177#discussion_r1572744522 ## src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java: ## @@ -94,6 +97,37 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo @Parameter private Map attributes; +/** + * Parser configurations (per matching Doxia markup source file path patterns). + * Each configuration item has the following format: + * + * + * parserId + * configurations + * configuration + * patterns + * patternglob:***.md/pattern!-- is either glob or regex syntax with the according prefix -- + * /patterns + * !-- all configurations apart from pattern are directly applied to the underlying parser -- + * emitCommentstrue/emitComments!-- false by default -- + * emitAnchorsForIndexableEntriesfalse/emitAnchorsForIndexableEntries!-- true by default -- + * /configuration + * /configurations + * /parserId + * + * The configuration is only applied if both + * + * the parser id matches the parser used for a specific markup source file and + * one of the given patterns matches the Doxia markup source file path (or no pattern is given at all). + * + * + * 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> parserConfigurations; Review Comment: Do you want to support `*` parser? -- 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
Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
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-unsubscr...@maven.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
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-unsubscr...@maven.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
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 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-unsubscr...@maven.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
Re: [PR] [MSITE-1000] Introduce parser configuration parameter [maven-site-plugin]
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-unsubscr...@maven.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
