You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://gitter.im/pmd/pmd-designer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
5
+
[](https://app.gitter.im/#/room/#pmd_pmd-designer:gitter.im?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
6
6
7
7
8
8
9
9
The Rule Designer is a graphical tool that helps PMD users develop their custom
10
10
rules. Main features:
11
-
*[AST inspection](https://pmd.github.io/latest/pmd_userdocs_extending_designer_reference.html#ast-inspection): inspect AST structure for any language, including XPath attributes
12
-
*[XPath rule design](https://pmd.github.io/latest/pmd_userdocs_extending_designer_reference.html#xpath-rule-design): integrated XPath editor, and rule metadata editor
13
-
*[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)
11
+
*[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
12
+
*[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
13
+
*[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)
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.
21
+
The designer is part of PMD's binary distributions. To install a distribution, see the
22
+
[documentation page](https://docs.pmd-code.org/latest/pmd_userdocs_installation.html) about installing PMD.
22
23
23
-
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.
24
+
The app needs JRE 1.8 or above to run. Be aware that on JRE 11+, the JavaFX distribution should be installed
25
+
separately. Visit [the download page](https://gluonhq.com/products/javafx/) to download a distribution,
26
+
extract it, and set the `JAVAFX_HOME` environment variable.
24
27
25
28
If the `bin` directory of your PMD distribution is on your shell's path, then you can **launch the app** with
26
-
*`run.sh designer` on Linux/ OSX
27
-
*`designer.bat` on Windows
29
+
*`pmd designer` on Linux/ OSX
30
+
*`pmd.bat designer` on Windows
28
31
29
32
Alternatively, you can launch the program "from source" with Maven.
30
33
*`$ ./mvnw -Prunning exec:java` will launch the program after compiling it, using the JavaFX distribution of your system
@@ -34,13 +37,13 @@ See the list of available versions [here](https://search.maven.org/artifact/org.
34
37
35
38
### Updating
36
39
37
-
The latest version of the designer currently **works with PMD 6.27.0 and above**.
38
-
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
39
-
PMD distribution.
40
+
The latest version of the designer currently **works with PMD 7.0.0-rc1 and above**.
41
+
You can simply replace `pmd-ui-7.X.Y.jar` with the [latest build](https://github.com/pmd/pmd-designer/releases/latest)
42
+
in the installation folder of your PMD distribution.
40
43
41
44
## Usage
42
45
43
-
### [Usage documentation is on the website](https://pmd.github.io/latest/pmd_userdocs_extending_designer_reference.html)
46
+
### [Usage documentation is on the website](https://docs.pmd-code.org/latest/pmd_userdocs_extending_designer_reference.html)
0 commit comments