Merge pull request #80 from adangel:issue-65-pmd-designer

Rename pmd-ui to pmd-designer #80

.ci/build.sh

@@ -47,7 +47,8 @@ function build() {
             GH_RELEASE="$RESULT"
 
             # Deploy to github releases
-            pmd_ci_gh_releases_uploadAsset "$GH_RELEASE" "target/pmd-ui-${PMD_CI_MAVEN_PROJECT_VERSION}.jar"
+            # Note: This is the shaded jar
+            pmd_ci_gh_releases_uploadAsset "$GH_RELEASE" "target/pmd-designer-${PMD_CI_MAVEN_PROJECT_VERSION}.jar"
 
             # extract the release notes
             RELEASE_NAME="${PMD_CI_MAVEN_PROJECT_VERSION}"

.gitignore

@@ -118,4 +118,4 @@ buildNumber.properties
 
 # CSS files generated by IDE
 src/main/resources/net/sourceforge/pmd/util/fxdesigner/css
-pmd-ui.iml
+pmd-designer.iml

CHANGELOG.md

@@ -4,6 +4,23 @@
 
 * **Bump required pmd-core version to 7.0.0-SNAPSHOT.**
 
+**Changed maven GAV**
+The maven coordinates (GAV) have been changed. The artifactId has been renamed to pmd-designer.
+
+```xml
+<dependency>
+  <groupId>net.sourceforge.pmd</groupId>
+  <artifactId>pmd-designer</artifactId>
+  <version>7.0.0</version>
+</dependency>
+```
+
+At the same time, the release artefact name changed to **pmd-designer-7.0.0.jar**.
+
+**Fixed issues:**
+
+* [#65](https://github.com/pmd/pmd-designer/issues/65) Rename artifactId to pmd-designer
+
 **Merged pull requests:**
 
 * [#77](https://github.com/pmd/pmd-designer/pull/77) Enable PMD checks with PMD 7 by [@adangel](https://github.com/adangel)

CONTRIBUTING.md

@@ -24,8 +24,8 @@
 1. [Open IntelliJ's terminal](https://stackoverflow.com/a/28044371/6245827) and
 paste the following:
 ```shell
-git update-index --skip-worktree -- .idea/misc.xml pmd-ui.iml # Ignore some config files
-mvn process-resources # Generate CSS resources
+git update-index --skip-worktree -- .idea/misc.xml pmd-designer.iml # Ignore some config files
+./mvnw process-resources # Generate CSS resources
 ```
 
 4. [Synchronize the directory contents](https://stackoverflow.com/a/4599243/6245827) to pick-up on the new CSS files

README.md

@@ -1,7 +1,7 @@
 # PMD Rule Designer
 
 [![Build Status](https://github.com/pmd/pmd-designer/workflows/build/badge.svg?branch=master)](https://github.com/pmd/pmd-designer/actions?query=workflow%3Abuild)
-[![Maven Central](https://img.shields.io/maven-central/v/net.sourceforge.pmd/pmd-ui.svg)](https://maven-badges.herokuapp.com/maven-central/net.sourceforge.pmd/pmd-ui)
+[![Maven Central](https://img.shields.io/maven-central/v/net.sourceforge.pmd/pmd-designer.svg)](https://maven-badges.herokuapp.com/maven-central/net.sourceforge.pmd/pmd-designer)
 [![Join the chat](https://img.shields.io/gitter/room/pmd/pmd-designer)](https://app.gitter.im/#/room/#pmd_pmd-designer:gitter.im?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 
@@ -37,8 +37,8 @@ See the list of available versions [here](https://search.maven.org/artifact/org.
 
 ### Updating
 
-The latest version of the designer currently **works with PMD 7.0.0-rc1 and above**.
-You can simply replace `pmd-ui-7.X.Y.jar` with the [latest build](https://github.com/pmd/pmd-designer/releases/latest)
+The latest version of the designer currently **works with PMD 7.0.0 and above**.
+You can simply replace `pmd-designer-7.X.Y.jar` with the [latest build](https://github.com/pmd/pmd-designer/releases/latest)
 in the installation folder of your PMD distribution.
 
 ## Usage

config/pmd-check.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<ruleset name="pmd-ui-dogfood"
+<ruleset name="pmd-designer-dogfood"
          xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">

pom.xml

@@ -2,7 +2,7 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <groupId>net.sourceforge.pmd</groupId>
-    <artifactId>pmd-ui</artifactId>
+    <artifactId>pmd-designer</artifactId>
     <name>PMD Designer</name>
     <version>7.0.0-SNAPSHOT</version>
 
@@ -54,7 +54,9 @@
     </developers>
 
     <properties>
+        <pmd.designer.version>${project.version}</pmd.designer.version> <!-- see DesignerVersion -->
         <pmd.core.version>7.0.0-SNAPSHOT</pmd.core.version>
+
         <openjfx.version>11.0.2</openjfx.version>
         <java.version>8</java.version>
         <kotlin.version>1.7.20</kotlin.version>
@@ -892,7 +894,7 @@
                                     <Main-Class>net.sourceforge.pmd.util.fxdesigner.DesignerStarter</Main-Class>
                                 </manifestEntries>
                             </archive>
-                            <finalName>pmd-ui-fat-${pmd.core.version}</finalName>
+                            <finalName>pmd-designer-fat-${pmd.core.version}</finalName>
                         </configuration>
                     </plugin>
 

releasing.md

@@ -26,11 +26,11 @@
 
 4.  Wait, until release is ready. The maven plugin will directly push the tag. The tag will be
     built by [github actions](https://github.com/pmd/pmd-designer/actions).
-    After it is done, the new release should be available under <https://repo.maven.apache.org/maven2/net/sourceforge/pmd/pmd-ui/>.
+    After it is done, the new release should be available under <https://repo.maven.apache.org/maven2/net/sourceforge/pmd/pmd-designer/>.
 
 5.  Verify the release on Github Releases: <https://github.com/pmd/pmd-designer/releases>
 
-    The release notes from `/CHANGELOG.md` should be there. Also, the shaded pmd-ui-*.jar should
+    The release notes from `/CHANGELOG.md` should be there. Also, the shaded pmd-designer-*.jar should
     have been uploaded.
 
 6.  Add a new section at the top in `/CHANGELOG.md` to prepare for the next version.

src/main/java/net/sourceforge/pmd/util/fxdesigner/Designer.java

@@ -10,6 +10,7 @@
 import java.util.Objects;
 import java.util.stream.Collectors;
 
+import net.sourceforge.pmd.PMDVersion;
 import net.sourceforge.pmd.util.fxdesigner.app.DesignerParams;
 import net.sourceforge.pmd.util.fxdesigner.app.DesignerRoot;
 import net.sourceforge.pmd.util.fxdesigner.app.DesignerRootImpl;
@@ -72,7 +73,7 @@ public void stop() {
     public void start(Stage stage, DesignerRoot owner) throws IOException {
         this.designerRoot = owner;
 
-        stage.setTitle("PMD Rule Designer (v " + DesignerVersion.getCurrentVersion() + ')');
+        stage.setTitle("PMD Rule Designer " + DesignerVersion.getCurrentVersion() + " (with PMD " + PMDVersion.VERSION + ")");
         setIcons(stage);
 
         System.out.println(stage.getTitle() + " initializing... ");

src/main/java/net/sourceforge/pmd/util/fxdesigner/DesignerVersion.java

@@ -25,10 +25,10 @@ public final class DesignerVersion {
     private static final String UNKNOWN_VERSION = "unknown";
 
     /**
-     * Determines the version from maven's generated pom.properties file.
+     * Determines the version from maven's generated designer.properties file.
      */
     static {
-        VERSION = readProperty("/META-INF/maven/net.sourceforge.pmd/pmd-ui/pom.properties", "version").orElse(UNKNOWN_VERSION);
+        VERSION = readProperty(ResourceUtil.resolveResource("designer.properties"), "pmd.designer.version").orElse(UNKNOWN_VERSION);
         PMD_CORE_MIN_VERSION = readProperty(ResourceUtil.resolveResource("designer.properties"), "pmd.core.version").orElse(UNKNOWN_VERSION);
     }
 

src/main/java/net/sourceforge/pmd/util/fxdesigner/popups/SimplePopups.java

@@ -210,7 +210,7 @@ public static void showAboutPopup(DesignerRoot root) {
         String sb =
             "PMD core version:\t\t" + PMDVersion.VERSION + "\n"
                 + "Designer version:\t\t\t" + DesignerVersion.getCurrentVersion()
-                + " (supports PMD core " + DesignerVersion.getPmdCoreMinVersion() + ")\n"
+                + " (min. supported PMD core " + DesignerVersion.getPmdCoreMinVersion() + ")\n"
                 + "Designer settings dir:\t\t"
                 + root.getService(DesignerRoot.DISK_MANAGER).getSettingsDirectory() + "\n"
                 + "Available languages:\t\t"

src/test/java/net/sourceforge/pmd/util/fxdesigner/util/beans/PersistenceIntegrationTest.java

@@ -29,7 +29,7 @@ public void testBeanRoundTrip() throws IOException {
         bean.setK(IOException.class);
         bean.setStr("hahahaha");
 
-        File tmp = Files.createTempFile("pmd-ui-test", "").toFile();
+        File tmp = Files.createTempFile("pmd-designer-test", "").toFile();
 
         SettingsPersistenceUtil.persistProperties(bean, tmp);