Merge pull request #177 from adangel:export-pmd-api

Export PMD API #177

Author: adangel

ReleaseNotes.md

@@ -18,9 +18,26 @@ This is a minor release.
 ### Fixed Issues
 
 * [#176](https://github.com/pmd/pmd-eclipse-plugin/pull/176): Update to pmd 7.0.0-rc2
+* [#177](https://github.com/pmd/pmd-eclipse-plugin/pull/177): Export PMD API
 
 ### API Changes
 
+The following PMD packages from pmd-core are exported and can be used by other plugins:
+* net.sourceforge.pmd
+* net.sourceforge.pmd.cpd
+* net.sourceforge.pmd.cpd.renderer
+* net.sourceforge.pmd.lang
+* net.sourceforge.pmd.lang.ast
+* net.sourceforge.pmd.lang.document
+* net.sourceforge.pmd.lang.metrics
+* net.sourceforge.pmd.lang.rule
+* net.sourceforge.pmd.lang.rule.xpath
+* net.sourceforge.pmd.properties
+* net.sourceforge.pmd.properties.constraints
+* net.sourceforge.pmd.renderers
+* net.sourceforge.pmd.reporting
+* net.sourceforge.pmd.util
+
 ### External Contributions
 
 ## 10-April-2023: 7.0.0.v20230410-1321-rc1

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/BasicPMDTest.java

@@ -4,10 +4,6 @@
 
 package net.sourceforge.pmd.eclipse;
 
-import java.io.ByteArrayInputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 import java.util.List;
 
@@ -20,41 +16,13 @@
 import net.sourceforge.pmd.RuleSet;
 import net.sourceforge.pmd.RuleSetLoader;
 import net.sourceforge.pmd.RuleViolation;
-import net.sourceforge.pmd.lang.LanguageRegistry;
-import net.sourceforge.pmd.lang.java.JavaLanguageModule;
-import net.sourceforge.pmd.util.datasource.DataSource;
 
 /**
- * Test if PMD can be run correctly
+ * Test if PMD can be run correctly.
  * 
  * @author Philippe Herlin
- * 
  */
 public class BasicPMDTest {
-
-    static class StringDataSource implements DataSource {
-        private final ByteArrayInputStream is;
-
-        StringDataSource(final String source) {
-            this.is = new ByteArrayInputStream(source.getBytes(StandardCharsets.UTF_8));
-        }
-
-        @Override
-        public InputStream getInputStream() {
-            return is;
-        }
-
-        @Override
-        public String getNiceFileName(final boolean shortNames, final String inputFileName) {
-            return "somefile.txt";
-        }
-
-        @Override
-        public void close() throws IOException {
-            // no-op
-        }
-    }
-
     /**
      * Try to load all the plugin known rulesets.
      * 
@@ -66,10 +34,8 @@ public void testDefaulltRuleSets() {
         Assert.assertFalse("No Rulesets found", standardRuleSets.isEmpty());
     }
 
-    private void runPmd(String javaVersion) {
+    private void runPmd() {
         PMDConfiguration configuration = new PMDConfiguration();
-        configuration.setDefaultLanguageVersion(
-                LanguageRegistry.PMD.getLanguageById(JavaLanguageModule.TERSE_NAME).getVersion(javaVersion));
         configuration.setRuleSets(Arrays.asList("category/java/codestyle.xml/UnnecessaryReturn"));
         configuration.setIgnoreIncrementalAnalysis(true);
 
@@ -93,25 +59,7 @@ private void runPmd(String javaVersion) {
      * 
      */
     @Test
-    public void testRunPmdJdk13() {
-        runPmd("1.3");
-    }
-
-    /**
-     * Let see with Java 1.4.
-     * 
-     */
-    @Test
-    public void testRunPmdJdk14() {
-        runPmd("1.4");
-    }
-
-    /**
-     * Let see with Java 1.5.
-     * 
-     */
-    @Test
-    public void testRunPmdJdk15() {
-        runPmd("1.5");
+    public void testRunPmd() {
+        runPmd();
     }
 }

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/runtime/properties/ProjectPropertiesModelTest.java

@@ -39,6 +39,7 @@
 import org.junit.Test;
 
 import net.sourceforge.pmd.Rule;
+import net.sourceforge.pmd.RuleContext;
 import net.sourceforge.pmd.RuleSet;
 import net.sourceforge.pmd.RuleSetLoadException;
 import net.sourceforge.pmd.RuleSetLoader;
@@ -49,7 +50,8 @@
 import net.sourceforge.pmd.eclipse.runtime.preferences.IPreferencesManager;
 import net.sourceforge.pmd.eclipse.ui.actions.RuleSetUtil;
 import net.sourceforge.pmd.lang.LanguageRegistry;
-import net.sourceforge.pmd.lang.java.rule.AbstractJavaRule;
+import net.sourceforge.pmd.lang.ast.Node;
+import net.sourceforge.pmd.lang.rule.AbstractRule;
 
 /**
  * Test the project properties model.
@@ -270,7 +272,7 @@ public void testProjectRuleSet2() throws PropertiesException, RuleSetLoadExcepti
     }
 
     /**
-     * When rules are added to the plugin preferences, these rules should also be added to the project
+     * When rules are added to the plugin preferences, these rules should also be added to the project.
      */
     @Test
     public void testProjectRuleSet3() throws PropertiesException, RuleSetLoadException, CoreException {
@@ -284,11 +286,16 @@ public void testProjectRuleSet3() throws PropertiesException, RuleSetLoadExcepti
                 this.initialPluginRuleSet.getRules(), projectRuleSet.getRules());
 
         // 2. add a rule to the plugin rule set
-        final Rule myRule = new AbstractJavaRule() {
+        final Rule myRule = new AbstractRule() {
             @Override
             public String getName() {
                 return "MyRule";
             }
+
+            @Override
+            public void apply(Node target, RuleContext ctx) {
+                // do nothing
+            }
         };
         myRule.setLanguage(LanguageRegistry.PMD.getLanguageById("java"));
 

net.sourceforge.pmd.eclipse.plugin/META-INF/MANIFEST.MF

@@ -90,14 +90,14 @@ Bundle-ClassPath: .,
 Bundle-Localization: plugin
 Export-Package: ch.qos.logback.classic;x-friends:="net.sourceforge.pmd.eclipse.plugin.test",
  name.herlin.command,
- net.sourceforge.pmd;x-friends:="net.sourceforge.pmd.eclipse.plugin.test";
+ net.sourceforge.pmd;
   uses:="net.sourceforge.pmd.lang,
    net.sourceforge.pmd.util.datasource,
    net.sourceforge.pmd.renderers,
    net.sourceforge.pmd.lang.rule.properties,
    net.sourceforge.pmd.lang.dfa.report",
- net.sourceforge.pmd.cpd;x-friends:="net.sourceforge.pmd.eclipse.plugin.test",
- net.sourceforge.pmd.cpd.renderer;x-friends:="net.sourceforge.pmd.eclipse.plugin.test",
+ net.sourceforge.pmd.cpd,
+ net.sourceforge.pmd.cpd.renderer,
  net.sourceforge.pmd.eclipse.core;uses:="net.sourceforge.pmd",
  net.sourceforge.pmd.eclipse.core.impl,
  net.sourceforge.pmd.eclipse.plugin;
@@ -170,15 +170,15 @@ Export-Package: ch.qos.logback.classic;x-friends:="net.sourceforge.pmd.eclipse.p
    org.eclipse.jface.viewers,
    org.eclipse.swt.widgets",
  net.sourceforge.pmd.eclipse.util.internal;x-friends:="net.sourceforge.pmd.eclipse.plugin.test",
- net.sourceforge.pmd.lang;x-friends:="net.sourceforge.pmd.eclipse.plugin.test",
+ net.sourceforge.pmd.lang,
+ net.sourceforge.pmd.lang.ast,
  net.sourceforge.pmd.lang.document,
- net.sourceforge.pmd.lang.java;x-friends:="net.sourceforge.pmd.eclipse.plugin.test",
- net.sourceforge.pmd.lang.java.rule;x-friends:="net.sourceforge.pmd.eclipse.plugin.test",
- net.sourceforge.pmd.lang.rule;x-friends:="net.sourceforge.pmd.eclipse.plugin.test",
+ net.sourceforge.pmd.lang.metrics,
+ net.sourceforge.pmd.lang.rule,
  net.sourceforge.pmd.lang.rule.xpath,
  net.sourceforge.pmd.properties,
- net.sourceforge.pmd.properties.builders,
+ net.sourceforge.pmd.properties.constraints,
  net.sourceforge.pmd.renderers,
+ net.sourceforge.pmd.reporting,
  net.sourceforge.pmd.util;uses:="net.sourceforge.pmd.lang.java.ast",
- net.sourceforge.pmd.util.datasource,
  org.slf4j;x-friends:="net.sourceforge.pmd.eclipse.plugin.test"