https://github.com/pmd/pmd-bluej
https://github.com/pmd/pmd-bluej
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pmd/pmd-bluej
- Owner: pmd
- License: other
- Created: 2015-06-01T20:22:20.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-09-19T09:34:27.000Z (over 1 year ago)
- Last Synced: 2025-06-06T12:48:59.851Z (7 months ago)
- Language: Java
- Size: 328 KB
- Stars: 6
- Watchers: 11
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pmd-bluej
[](https://github.com/pmd/pmd-bluej/actions)
This BlueJ extension was developed under Linux for both BlueJ for Linux and
BlueJ for Windows use.
You can get BlueJ from .
## Download
* PMD can be downloaded here:
* The PMD Extension for BlueJ is here:
## Use:
In BlueJ, open to the main class window that displays your classes, right-click
on a class object, when the menu comes up, at the bottom of it you will see
PMD as an option, select that and click "check code". A popup will then run
PMD against your class source file and then display a popup listing all of
the things PMD does not like about your code.
## Installation:
The prior version of this extension from 2001 included PMD, so to use it PMD
did not have to be installed. This version of this extension does not include PMD
so you must install PMD under your operating system of choice.
First step is to install PMD.
You can install PMD from a prebuilt file or download it and build it yourself.
Remember the path under where you have extracted
the zip file, e.g. under Linux you could install it under `~/pmd-bin-6.31.0/`.
Under Windows it is usually most convenient to install PMD in the root so as to
avoid spaces in directory names, (ie: Program Files) or PMD might not execute
properly; the installation path could be `c:\pmd-bin-6.31.0\`.
Second step is to install the PMD Extension for BlueJ.
This extension works both under Linux and Windows and there is only one jar file (since version 2.1).
To install under Linux, assuming you have installed BlueJ in your home directory
(the standard location for version 5.0.0 of BlueJ for Linux) copy the
`PMDExecExt.jar` file to `~/bluej/lib/extensions2` directory, then close and open
BlueJ.
To install under Windows, assuming you have installed BlueJ into the normal location,
copy the `PMDExecExt.jar` file to C:\Program Files\BlueJ\lib\extensions2.
The third and last step is, to configure the BlueJ extension. In BlueJ, go to
"Tools / Preferences / Extensions". Select or enter the "Path to PMD installation"
that you have remembered from step one above. You can also fine-tune the
"PMD Options"; by default, the rulesets "java-basic" and "java-design" are
executed.
Please see the PMD documentation for the rulesets available.
## Contributing
### Pull requests
Easiest way to contribute is via pull requests on . Pull Requests are always
welcome.
### Building
You need to have maven installed.
./mvnw clean verify
Take the generated jar file `target/PMDExecExt.jar` and copy it into
BlueJ's extension2 directory.
### Releasing a new version
* Update [ReleaseNotes.md](https://github.com/pmd/pmd-bluej/blob/main/ReleaseNotes.md)
with new version a release date
* Update the version: `./mvnw versions:set -DnewVersion=2.2.0`
* Commit: `git commit -a -m "Prepare new version 2.2.0"`
* Tag: `git tag 2.2.0`
* Push: `git push origin main; git push origin tag 2.2.0`
* The tag will be built by [Github Actions](https://github.com/pmd/pmd-bluej/actions?query=workflow%3Abuild).
* After it is done, a new release including the jar file should be available here:
*
*
* Update the version: `./mvnw versions:set -DnewVersion=2.3.0-SNAPSHOT`
* Update [ReleaseNotes.md](https://github.com/pmd/pmd-bluej/blob/main/ReleaseNotes.md)
and add a placeholder for the next version
* Commit: `git commit -a -m "Prepare next development version 2.3.0-SNAPSHOT"`
* Push: `git push origin main`
* Post a news on .