diff --git a/pmd-doc/src/main/java/net/sourceforge/pmd/docs/RuleDocGenerator.java b/pmd-doc/src/main/java/net/sourceforge/pmd/docs/RuleDocGenerator.java index 5eb70b5fa6..72d7a1f61b 100644 --- a/pmd-doc/src/main/java/net/sourceforge/pmd/docs/RuleDocGenerator.java +++ b/pmd-doc/src/main/java/net/sourceforge/pmd/docs/RuleDocGenerator.java @@ -247,6 +247,7 @@ public class RuleDocGenerator { lines.add("folder: pmd/rules/" + languageTersename); lines.add("sidebaractiveurl: /" + LANGUAGE_INDEX_PERMALINK_PATTERN.replace("${language.tersename}", languageTersename)); lines.add("editmepath: ../" + getRuleSetSourceFilepath(ruleset)); + lines.add("keywords: " + getRuleSetKeywords(ruleset)); lines.add("---"); for (Rule rule : getSortedRules(ruleset)) { @@ -347,6 +348,14 @@ public class RuleDocGenerator { } } + private String getRuleSetKeywords(RuleSet ruleset) { + List ruleNames = new LinkedList<>(); + for (Rule rule : ruleset.getRules()) { + ruleNames.add(rule.getName()); + } + return ruleset.getName() + ", " + StringUtils.join(ruleNames, ", "); + } + private List getSortedRules(RuleSet ruleset) { List sortedRules = new ArrayList<>(ruleset.getRules()); Collections.sort(sortedRules, new Comparator() { diff --git a/pmd-doc/src/test/resources/expected/sample.md b/pmd-doc/src/test/resources/expected/sample.md index 72a9d3cf91..f66c6fb20e 100644 --- a/pmd-doc/src/test/resources/expected/sample.md +++ b/pmd-doc/src/test/resources/expected/sample.md @@ -5,6 +5,7 @@ permalink: pmd_rules_java_sample.html folder: pmd/rules/java sidebaractiveurl: /pmd_rules_java.html editmepath: ../rulesets/ruledoctest/sample.xml +keywords: Sample, OverrideBothEqualsAndHashcode, JumbledIncrementer, DeprecatedSample, RenamedRule, MovedRule --- ## DeprecatedSample