Skip to content

Commit

Permalink
Merge pull request #59 from adangel:upgrade-to-pmd7-rc1
Browse files Browse the repository at this point in the history
Upgrade to use PMD 7.0.0-rc1 #59
  • Loading branch information
adangel committed Apr 14, 2023
2 parents 8c69c29 + 861ac71 commit 75ab09c
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 13 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## 7.0.0-rc1

* **Bump required pmd-core version to 7.0.0-rc1.**

**Fixed issues:**

* [#43](https://github.com/pmd/pmd-designer/issues/43) Update PMD 7 Logo in the Designer
Expand Down
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,32 @@

[![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)
[![Join the chat at https://gitter.im/pmd/pmd-designer](https://badges.gitter.im/pmd/pmd-designer.svg)](https://gitter.im/pmd/pmd-designer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![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)



The Rule Designer is a graphical tool that helps PMD users develop their custom
rules. Main features:
* [AST inspection](https://pmd.github.io/latest/pmd_userdocs_extending_designer_reference.html#ast-inspection): inspect AST structure for any language, including XPath attributes
* [XPath rule design](https://pmd.github.io/latest/pmd_userdocs_extending_designer_reference.html#xpath-rule-design): integrated XPath editor, and rule metadata editor
* [Rule test edition](https://pmd.github.io/latest/pmd_userdocs_extending_designer_reference.html#testing-a-rule): create or edit rule test files for the [PMD testing framework](https://pmd.github.io/latest/pmd_userdocs_extending_testing.html)
* [AST inspection](https://docs.pmd-code.org/latest/pmd_userdocs_extending_designer_reference.html#ast-inspection): inspect AST structure for any language, including XPath attributes
* [XPath rule design](https://docs.pmd-code.org/latest/pmd_userdocs_extending_designer_reference.html#xpath-rule-design): integrated XPath editor, and rule metadata editor
* [Rule test edition](https://docs.pmd-code.org/latest/pmd_userdocs_extending_designer_reference.html#testing-a-rule): create or edit rule test files for the [PMD testing framework](https://docs.pmd-code.org/latest/pmd_userdocs_extending_testing.html)


![testing-designer](https://user-images.githubusercontent.com/24524930/61461094-504a7900-a970-11e9-822e-30cc121b568c.gif)


## Installation

The designer is part of PMD's binary distributions. To install a distribution, see the [documentation page](https://pmd.github.io/latest/pmd_userdocs_installation.html) about installing PMD.
The designer is part of PMD's binary distributions. To install a distribution, see the
[documentation page](https://docs.pmd-code.org/latest/pmd_userdocs_installation.html) about installing PMD.

The app needs JRE 1.8 or above to run. Be aware that on JRE 11+, the JavaFX distribution should be installed separately. Visit [the download page](https://gluonhq.com/products/javafx/) to download a distribution, extract it, and set the `JAVAFX_HOME` environment variable.
The app needs JRE 1.8 or above to run. Be aware that on JRE 11+, the JavaFX distribution should be installed
separately. Visit [the download page](https://gluonhq.com/products/javafx/) to download a distribution,
extract it, and set the `JAVAFX_HOME` environment variable.

If the `bin` directory of your PMD distribution is on your shell's path, then you can **launch the app** with
* `run.sh designer` on Linux/ OSX
* `designer.bat` on Windows
* `pmd designer` on Linux/ OSX
* `pmd.bat designer` on Windows

Alternatively, you can launch the program "from source" with Maven.
* `$ ./mvnw -Prunning exec:java` will launch the program after compiling it, using the JavaFX distribution of your system
Expand All @@ -34,13 +37,13 @@ See the list of available versions [here](https://search.maven.org/artifact/org.

### Updating

The latest version of the designer currently **works with PMD 6.27.0 and above**.
You can simply replace `pmd-ui-6.X.Y.jar` with the [latest build](https://github.com/pmd/pmd-designer/releases/latest) in the installation folder of your
PMD distribution.
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)
in the installation folder of your PMD distribution.

## Usage

### [Usage documentation is on the website](https://pmd.github.io/latest/pmd_userdocs_extending_designer_reference.html)
### [Usage documentation is on the website](https://docs.pmd-code.org/latest/pmd_userdocs_extending_designer_reference.html)

## Building from source/ contributing

Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
</developers>

<properties>
<pmd.core.version>7.0.0-SNAPSHOT</pmd.core.version>
<pmd.core.version>7.0.0-rc1</pmd.core.version>
<openjfx.version>11.0.2</openjfx.version>
<java.version>8</java.version>
<kotlin.version>1.7.20</kotlin.version>
Expand Down

0 comments on commit 75ab09c

Please sign in to comment.