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

[doc] Consider deprecated/renamed rules when generating rule docs

Browse Source
This commit is contained in:
Andreas Dangel
2021-06-10 17:41:58 +02:00
parent 3ccc4c3115
commit ceaad8e8be
2 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
pmd-doc/src/main/java/net/sourceforge/pmd/docs/GenerateRuleDocsCmd.java
View File

@@ -37,7 +37,8 @@ public final class GenerateRuleDocsCmd {
System.out.println("Generating docs into " + output);
// important: use a RuleSetFactory that includes all rules, e.g. deprecated rule references
List<RuleSet> registeredRuleSets = new RuleSetLoader().getStandardRuleSets();
List<RuleSet> registeredRuleSets = new RuleSetLoader().includeDeprecatedRuleReferences(true)
.getStandardRuleSets();
List<String> additionalRulesets = findAdditionalRulesets(output);
RuleDocGenerator generator = new RuleDocGenerator(new DefaultFileWriter(), output);

11
pmd-doc/src/test/java/net/sourceforge/pmd/docs/RuleDocGeneratorTest.java
View File

@@ -21,11 +21,8 @@ import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import net.sourceforge.pmd.RulePriority;
import net.sourceforge.pmd.RuleSet;
import net.sourceforge.pmd.RuleSetFactory;
import net.sourceforge.pmd.RuleSetNotFoundException;
import net.sourceforge.pmd.RulesetsFactoryUtils;
import net.sourceforge.pmd.RuleSetLoader;
import net.sourceforge.pmd.docs.MockedFileWriter.FileEntry;
public class RuleDocGeneratorTest {
@@ -59,11 +56,11 @@ public class RuleDocGeneratorTest {
}
@Test
public void testSingleRuleset() throws RuleSetNotFoundException, IOException {
public void testSingleRuleset() throws IOException {
RuleDocGenerator generator = new RuleDocGenerator(writer, root);
RuleSetFactory rsf = RulesetsFactoryUtils.createFactory(RulePriority.LOW, false, false, true);
RuleSet ruleset = rsf.createRuleSet("rulesets/ruledoctest/sample.xml");
RuleSetLoader rsl = new RuleSetLoader().includeDeprecatedRuleReferences(true);
RuleSet ruleset = rsl.loadFromResource("rulesets/ruledoctest/sample.xml");
generator.generate(Arrays.asList(ruleset),
Arrays.asList(