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

[doc] Render rule names as keywords, so that the rules can be searched

Browse Source
This commit is contained in:
Andreas Dangel
2017-08-14 12:53:34 +02:00
parent 85c41033f5
commit 3972be80cc
2 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
pmd-doc/src/main/java/net/sourceforge/pmd/docs/RuleDocGenerator.java
View File

@ -247,6 +247,7 @@ public class RuleDocGenerator {
lines.add("folder: pmd/rules/" + languageTersename); lines.add("folder: pmd/rules/" + languageTersename);
lines.add("sidebaractiveurl: /" + LANGUAGE_INDEX_PERMALINK_PATTERN.replace("${language.tersename}", languageTersename)); lines.add("sidebaractiveurl: /" + LANGUAGE_INDEX_PERMALINK_PATTERN.replace("${language.tersename}", languageTersename));
lines.add("editmepath: ../" + getRuleSetSourceFilepath(ruleset)); lines.add("editmepath: ../" + getRuleSetSourceFilepath(ruleset));
lines.add("keywords: " + getRuleSetKeywords(ruleset));
lines.add("---"); lines.add("---");
for (Rule rule : getSortedRules(ruleset)) { for (Rule rule : getSortedRules(ruleset)) {
@ -347,6 +348,14 @@ public class RuleDocGenerator {
} }
} }
private String getRuleSetKeywords(RuleSet ruleset) {
List<String> ruleNames = new LinkedList<>();
for (Rule rule : ruleset.getRules()) {
ruleNames.add(rule.getName());
}
return ruleset.getName() + ", " + StringUtils.join(ruleNames, ", ");
}
private List<Rule> getSortedRules(RuleSet ruleset) { private List<Rule> getSortedRules(RuleSet ruleset) {
List<Rule> sortedRules = new ArrayList<>(ruleset.getRules()); List<Rule> sortedRules = new ArrayList<>(ruleset.getRules());
Collections.sort(sortedRules, new Comparator<Rule>() { Collections.sort(sortedRules, new Comparator<Rule>() {

1
pmd-doc/src/test/resources/expected/sample.md
View File

@ -5,6 +5,7 @@ permalink: pmd_rules_java_sample.html
folder: pmd/rules/java folder: pmd/rules/java
sidebaractiveurl: /pmd_rules_java.html sidebaractiveurl: /pmd_rules_java.html
editmepath: ../rulesets/ruledoctest/sample.xml editmepath: ../rulesets/ruledoctest/sample.xml
keywords: Sample, OverrideBothEqualsAndHashcode, JumbledIncrementer, DeprecatedSample, RenamedRule, MovedRule
--- ---
## DeprecatedSample ## DeprecatedSample