phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add report properties to help message

Browse Source
This commit is contained in:
Juan Martín Sotuyo Dodero
2022-08-17 10:50:24 -03:00
parent 7da4668532
commit a0dcf384bf
1 changed files with 30 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
pmd-cli/src/main/java/net/sourceforge/pmd/cli/commands/internal/PmdCommand.java
View File

@ -31,6 +31,8 @@ import net.sourceforge.pmd.cli.internal.ExecutionResult;
import net.sourceforge.pmd.lang.Language;
import net.sourceforge.pmd.lang.LanguageRegistry;
import net.sourceforge.pmd.lang.LanguageVersion;
import net.sourceforge.pmd.properties.PropertyDescriptor;
import net.sourceforge.pmd.renderers.Renderer;
import net.sourceforge.pmd.renderers.RendererFactory;
import net.sourceforge.pmd.reporting.ReportStats;
import net.sourceforge.pmd.util.StringUtil;
@ -47,6 +49,31 @@ import picocli.CommandLine.TypeConversionException;
description = "The PMD standard source code analyzer")
public class PmdCommand extends AbstractAnalysisPmdSubcommand {
static {
final Properties emptyProps = new Properties();
final StringBuilder reportPropertiesHelp = new StringBuilder();
for (final String rendererName : RendererFactory.supportedRenderers()) {
final Renderer renderer = RendererFactory.createRenderer(rendererName, emptyProps);
if (renderer.getPropertyDescriptors().size() > 0) {
reportPropertiesHelp.append(rendererName + ":" + System.getProperty("line.separator"));
for (final PropertyDescriptor<?> property : renderer.getPropertyDescriptors()) {
reportPropertiesHelp.append(" ").append(property.name()).append(" - ")
.append(property.description()).append(System.getProperty("line.separator"));
final Object deflt = property.defaultValue();
if (deflt != null && !"".equals(deflt)) {
reportPropertiesHelp.append(" Default: ").append(deflt)
.append(System.getProperty("line.separator"));
}
}
}
}
// System Properties are the easier way to inject dynamically computed values into the help of an option
System.setProperty("pmd-cli.pmd.report.properties.help", reportPropertiesHelp.toString());
}
private List<String> rulesets;
private Path ignoreListPath;
@ -136,8 +163,9 @@ public class PmdCommand extends AbstractAnalysisPmdSubcommand {
this.minimumPriority = priority;
}
// TODO : Figure out how to surface the supported properties for each report format
@Option(names = { "--property", "-P" }, description = "Key-value pair defining a property for the report format.")
// TODO : Autocomplete candidates?
@Option(names = { "--property", "-P" }, description = "Key-value pair defining a property for the report format.%n"
+ "Supported values for each report format:%n${sys:pmd-cli.pmd.report.properties.help}")
public void setProperties(final Properties properties) {
this.properties = properties;
}