rife2/bld-pmd
rife2/bld-pmd
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Minor clenaup

Browse source
This commit is contained in:
Erik C. Thauvin 2024-01-21 13:25:24 -08:00
parent 5968ca03ce
commit 758b992eaa
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -10,10 +10,10 @@
To install, please refer to the [extensions documentation](https://github.com/rife2/bld/wiki/Extensions). To install, please refer to the [extensions documentation](https://github.com/rife2/bld/wiki/Extensions).
To check all source code using the [java quickstart rule](https://pmd.github.io/pmd/pmd_rules_java.html), add the following to your build file To check all source code using the [Java Quickstart](https://pmd.github.io/pmd/pmd_rules_java.html) configuration, add the following to your build file:
```java ```java
@BuildCommand @BuildCommand(summary = "Checks source code with PMD")
public void pmd() throws Exception { public void pmd() throws Exception {
new PmdOperation() new PmdOperation()
.fromProject(this) .fromProject(this)
@ -21,14 +21,14 @@ public void pmd() throws Exception {
} }
``` ```
```text ```console
./bld pmd test ./bld pmd test
``` ```
To check the main source directory using a custom rule, [java error prone rule](https://pmd.github.io/pmd/pmd_rules_java.html) and failing on any violation. To check the main source directory using a custom ruleset, [Java Error Prone](https://pmd.github.io/pmd/pmd_rules_java.html#error-prone) configuration, and failing on any violation.
```java ```java
@BuildCommand @BuildCommand(value = "pmd-main", summary = "Checks main source code with PMD")
public void pmdMain() throws Exception { public void pmdMain() throws Exception {
new PmdOperation() new PmdOperation()
.fromProject(this) .fromProject(this)
@ -39,8 +39,8 @@ public void pmdMain() throws Exception {
} }
``` ```
```text ```console
./bld compile pmdMain ./bld compile pmd-main
``` ```
Please check the [PmdOperation documentation](https://rife2.github.io/bld-pmd/rife/bld/extension/PmdOperation.html#method-summary) for all available configuration options. Please check the [PmdOperation documentation](https://rife2.github.io/bld-pmd/rife/bld/extension/PmdOperation.html#method-summary) for all available configuration options.