Skip to content

Commit

Permalink
Update to use renamed pmd-designer
Browse files Browse the repository at this point in the history
  • Loading branch information
adangel committed Feb 22, 2024
1 parent f9d9ac6 commit 621cd0e
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 7 deletions.
2 changes: 1 addition & 1 deletion do-release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ echo "Then proceed with releasing pmd-designer..."
echo "<https://github.com/pmd/pmd-designer/blob/master/releasing.md>"
echo
echo "Press enter to continue when pmd-designer is available in maven-central..."
echo "<https://repo.maven.apache.org/maven2/net/sourceforge/pmd/pmd-ui/maven-metadata.xml>."
echo "<https://repo.maven.apache.org/maven2/net/sourceforge/pmd/pmd-designer/maven-metadata.xml>."
echo
echo "Note: If there is no new pmd-designer release needed, you can directly proceed."
read -r
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ This can be achieved with Rule Designer:
* Fork and clone the [pmd/pmd-designer](https://github.com/pmd/pmd-designer) repository.
* Add a syntax highlighter implementation to `net.sourceforge.pmd.util.fxdesigner.util.codearea.syntaxhighlighting` (you could use Java as an example).
* Register it in the `AvailableSyntaxHighlighters` enumeration.
* Now build your implementation and place the `target/pmd-ui-<version>-SNAPSHOT.jar` to the `lib` directory inside your `pmd-bin-...` distribution (you have to delete old `pmd-ui-*.jar` from there).
* Now build your implementation and place the `target/pmd-designer-<version>-SNAPSHOT.jar` to the `lib` directory inside your `pmd-bin-...` distribution (you have to delete old `pmd-designer-*.jar` from there).

## Optional features

Expand Down
6 changes: 3 additions & 3 deletions docs/pages/pmd/userdocs/extending/designer_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: The rule designer
short_title: Rule designer
tags: [extending, userdocs]
summary: "Learn about the usage and features of the rule designer."
last_updated: December 2023 (7.0.0)
last_updated: February 2024 (7.0.0)
permalink: pmd_userdocs_extending_designer_reference.html
author: Clément Fournier <clement.fournier76@gmail.com>
---
Expand All @@ -25,7 +25,7 @@ If the bin directory of your PMD distribution is on your shell's path, then you
windows="pmd.bat designer" %}


{% include note.html content="pmd-ui.jar is not a runnable jar, because it doesn't include any PMD language module, or PMD Core. " %}
{% include note.html content="pmd-designer.jar is not a runnable jar, because it doesn't include any PMD language module, or PMD Core. " %}


This is to allow easy updating, and let you choose the dependencies you're interested in.
Expand All @@ -36,7 +36,7 @@ standard PMD startup scripts, which setups the classpath with the available PMD
### Updating

The latest version of the designer currently **works with PMD 7.0.0 and above**. You can simply replace
pmd-ui-7.X.Y.jar with the [latest build](https://github.com/pmd/pmd-designer/releases) in the installation
pmd-designer-7.X.Y.jar with the [latest build](https://github.com/pmd/pmd-designer/releases) in the installation
folder of your PMD distribution, and run it normally. Note that updating may cause some persisted state
to get lost, for example the code snippet.

Expand Down
2 changes: 2 additions & 0 deletions docs/pages/release_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,7 @@ The rules have been moved into categories with PMD 6.
* [#4749](https://github.com/pmd/pmd/pull/4749): Fixes NoSuchMethodError on processing errors in pmd-compat6
* [#4776](https://github.com/pmd/pmd/issues/4776): \[ci] Upgrade to ruby 3
* [#4796](https://github.com/pmd/pmd/pull/4796): Remove deprecated and release rulesets
* [#4823](https://github.com/pmd/pmd/pull/4823): Update to use renamed pmd-designer
* apex
* [#3766](https://github.com/pmd/pmd/issues/3766): \[apex] Replace Jorje with fully open source front-end
* apex-performance
Expand Down Expand Up @@ -1220,6 +1221,7 @@ See also [Detailed Release Notes for PMD 7]({{ baseurl }}pmd_release_notes_pmd7.
* [#4749](https://github.com/pmd/pmd/pull/4749): Fixes NoSuchMethodError on processing errors in pmd-compat6
* [#4776](https://github.com/pmd/pmd/issues/4776): \[ci] Upgrade to ruby 3
* [#4796](https://github.com/pmd/pmd/pull/4796): Remove deprecated and release rulesets
* [#4823](https://github.com/pmd/pmd/pull/4823): Update to use renamed pmd-designer
* ant
* [#4080](https://github.com/pmd/pmd/issues/4080): \[ant] Split off Ant integration into a new submodule
* core
Expand Down
2 changes: 1 addition & 1 deletion pmd-cli/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<!-- Needed for Designer command -->
<dependency>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd-ui</artifactId>
<artifactId>pmd-designer</artifactId>
<version>${pmd-designer.version}</version>
</dependency>

Expand Down
2 changes: 1 addition & 1 deletion pmd-dist/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@
</dependency>
<dependency>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd-ui</artifactId>
<artifactId>pmd-designer</artifactId>
<version>${pmd-designer.version}</version>
</dependency>
<dependency>
Expand Down

0 comments on commit 621cd0e

Please sign in to comment.