Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dgroup/arch4u-pmd
Linting rules for Java frameworks like Spring, Quarkus, Jackson, SLF4J, etc., to avoid known problems in REST API, logging, observability, performance, and general best practices.
https://github.com/dgroup/arch4u-pmd
jackson-json java logging monitoring open-api pmd pmd-ruleset quark quarkus rest-api slf4j spring spring-boot
Last synced: 15 days ago
JSON representation
Linting rules for Java frameworks like Spring, Quarkus, Jackson, SLF4J, etc., to avoid known problems in REST API, logging, observability, performance, and general best practices.
- Host: GitHub
- URL: https://github.com/dgroup/arch4u-pmd
- Owner: dgroup
- License: mit
- Created: 2022-01-04T20:57:30.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-20T18:51:28.000Z (25 days ago)
- Last Synced: 2024-10-22T06:00:16.762Z (24 days ago)
- Topics: jackson-json, java, logging, monitoring, open-api, pmd, pmd-ruleset, quark, quarkus, rest-api, slf4j, spring, spring-boot
- Language: Java
- Homepage:
- Size: 335 KB
- Stars: 26
- Watchers: 2
- Forks: 3
- Open Issues: 34
-
Metadata Files:
- Readme: readme.md
- Changelog: history.md
- Contributing: .github/contributing.md
- License: license.txt
- Code of conduct: .github/code_of_conduct.md
Awesome Lists containing this project
README
[](https://mvnrepository.com/artifact/io.github.dgroup/arch4u-pmd)
[](http://www.javadoc.io/doc/io.github.dgroup/arch4u-pmd)
[](./license.txt)
[](https://github.com/dgroup/arch4u-pmd/graphs/commit-activity)
[](https://hitsofcode.com/view/github/dgroup/arch4u-pmd)
[](https://github.com/dgroup/arch4u-pmd/actions/workflows/build.yml)
[](https://app.snyk.io/org/dgroup/project/c8b51bb3-7683-41c8-9a4e-b32a6f9069b6)
[](http://www.qulice.com/)
[](https://sonarcloud.io/summary/new_code?id=dgroup_arch4u-pmd)
[](https://codebeat.co/projects/github-com-dgroup-arch4u-pmd-master)
[](https://www.codacy.com/gh/dgroup/arch4u-pmd/dashboard?utm_source=github.com&utm_medium=referral&utm_content=dgroup/arch4u-pmd&utm_campaign=Badge_Grade)
[](https://codecov.io/gh/dgroup/arch4u-pmd)
* [Overview](#overview)
* [How to use?](#how-to-use)
* [Maven (pom.xml)](#maven-pomxml)
* [Gradle (build.gradle)](#gradle-buildgradle)
* [Include arch4u-pmd rules into your existing custom ruleset](#include-arch4u-pmd-rules-into-your-existing-custom-ruleset)
* [Exclude particular rule](#exclude-particular-rule)
* [Reconfigure a rule](#reconfigure-a-rule)
* [Exclude particular folder from inspection](#exclude-particular-folder-from-inspection)
* [How to contribute?](#how-to-contribute)
* [Contributors](#contributors)
### Overview
**arch4u-pmd** is a library with pmd rules that bring new regulations related to known problems in
REST API, logging, monitoring, etc., including reconfigured default pmd
rules to decrease false-positive
violations during usage of well-known frameworks like Spring, Quarkus, etc.
In addition to our custom/reconfigured rules we are using the latest stable pmd-java version which is `6.55.0` with more than [320+ rules](https://pmd.github.io/pmd-6.55.0/pmd_rules_java.html) with default configuration.
Legend:
- ✅ included in `arch4u-ruleset.xml`
- ⌛ planned for review considering framework(s) architecture
- 🌵 temporary disabled or reconfigured in `arch4u-ruleset.xml`
- ❌ disabled/not planned in `arch4u-ruleset.xml`
| PMD rule | Provider | Status | Spring | Quarkus |
|:------------------------------------------------------------------------------------------------------------------------------------------|:------------------:|:------:|:------:|:-------:|
| [UseExistingMediaTypeConstant](https://github.com/dgroup/arch4u-pmd/discussions/43) | `arch4u-pmd:0.1.0` | ✅ | ✅ | ⌛ |
| [UseOpenApiInRestEndpoints](https://github.com/dgroup/arch4u-pmd/discussions/73) | `arch4u-pmd:0.1.0` | ✅ | ✅ | ⌛ |
| [RestEndpointsWithoutExposedMetrics](https://github.com/dgroup/arch4u-pmd/discussions/74) | `arch4u-pmd:0.1.0` | ✅ | ✅ | ⌛ |
| [UseConstantAsMetricName](https://github.com/dgroup/arch4u-pmd/discussions/75) | `arch4u-pmd:0.1.0` | ✅ | ✅ | ⌛ |
| [NoMandatoryConstructorInExceptionClass](https://github.com/dgroup/arch4u-pmd/discussions/31) | `arch4u-pmd:0.1.0` | ✅ | ✅ | ⌛ |
| [AvoidUsingObjectMapperAsALocalVariable](https://github.com/dgroup/arch4u-pmd/discussions/30) | `arch4u-pmd:0.1.0` | ✅ | ✅ | ⌛ |
| [AvoidMdcOutsideTryStatement](https://github.com/dgroup/arch4u-pmd/discussions/86) | `arch4u-pmd:0.1.0` | ✅ | ✅ | ⌛ |
| [PotentiallyThreadLocalPollutionByMdc](https://github.com/dgroup/arch4u-pmd/discussions/88) | `arch4u-pmd:0.1.0` | ✅ | ✅ | ⌛ |
| [GuardLogStatement](https://pmd.github.io/latest/pmd_rules_java_bestpractices.html#guardlogstatement) | `pmd-java:6.44.0` | ❌ | ❌ | ❌ |
| [JUnitAssertionsShouldIncludeMessage](https://pmd.github.io/latest/pmd_rules_java_bestpractices.html#junitassertionsshouldincludemessage) | `pmd-java:6.44.0` | 🌵 | ⌛ | ⌛ |
| [UnusedPrivateMethod](https://pmd.github.io/latest/pmd_rules_java_bestpractices.html#unusedprivatemethod) | `pmd-java:6.44.0` | 🌵 | ⌛ | ⌛ |
| [AtLeastOneConstructor](https://pmd.github.io/latest/pmd_rules_java_codestyle.html#atleastoneconstructor) | `pmd-java:6.44.0` | 🌵 | ✅ | ⌛ |
| [OnlyOneReturn](https://pmd.github.io/latest/pmd_rules_java_codestyle.html#onlyonereturn) | `pmd-java:6.44.0` | 🌵 | ⌛ | ⌛ |
| [CommentRequired](https://pmd.github.io/latest/pmd_rules_java_documentation.html#commentrequired) | `pmd-java:6.44.0` | 🌵 | ⌛ | ⌛ |
| [AvoidCatchingGenericException](https://pmd.github.io/latest/pmd_rules_java_design.html#avoidcatchinggenericexception) | `pmd-java:6.44.0` | ⌛ | ⌛ | ⌛ |
| [CouplingBetweenObjects](https://pmd.github.io/latest/pmd_rules_java_design.html#couplingbetweenobjects) | `pmd-java:6.44.0` | 🌵 | ⌛ | ⌛ |
| [LawOfDemeter](https://pmd.github.io/latest/pmd_rules_java_design.html#lawofdemeter) | `pmd-java:6.44.0` | ❌ | ❌ | ❌ |
| [LoosePackageCoupling](https://pmd.github.io/latest/pmd_rules_java_design.html#loosepackagecoupling) | `pmd-java:6.44.0` | ⌛ | ⌛ | ⌛ |
| [SignatureDeclareThrowsException](https://pmd.github.io/latest/pmd_rules_java_design.html#signaturedeclarethrowsexception) | `pmd-java:6.44.0` | ⌛ | ⌛ | ⌛ |
| [TooManyFields](https://pmd.github.io/latest/pmd_rules_java_design.html#toomanyfields) | `pmd-java:6.44.0` | 🌵 | ⌛ | ⌛ |
| [TooManyMethods](https://pmd.github.io/latest/pmd_rules_java_design.html#toomanymethods) | `pmd-java:6.44.0` | 🌵 | ⌛ | ⌛ |
| [UseObjectForClearerAPI](https://pmd.github.io/latest/pmd_rules_java_design.html#useobjectforclearerapi) | `pmd-java:6.44.0` | ❌ | ❌ | ❌ |
| [AtLeastOneConstructor](https://pmd.github.io/latest/pmd_rules_java_codestyle.html#atleastoneconstructor) | `pmd-java:6.44.0` | ❌ | ❌ | ❌ |
| [UseUtilityClass](https://pmd.github.io/latest/pmd_rules_java_design.html#useutilityclass) | `pmd-java:6.44.0` | 🌵 | ✅ | ⌛ |
| [ShortClassName](https://pmd.github.io/latest/pmd_rules_java_codestyle.html#shortclassname) | `pmd-java:6.44.0` | 🌵 | ✅ | ✅ |
| [ImmutableField](https://pmd.github.io/latest/pmd_rules_java_design.html#immutablefield) | `pmd-java:6.44.0` | 🌵 | ✅ | ✅ |
| [LongVariable](https://pmd.github.io/latest/pmd_rules_java_codestyle.html#longvariable) | `pmd-java:6.44.0` | 🌵 | ✅ | ✅ |
### How to use?
#### Maven (pom.xml)
```xml
...
...
org.apache.maven.plugins
maven-pmd-plugin
3.15.0
test
check
true
...
io/github/dgroup/arch4u/pmd/arch4u-ruleset.xml
...
target/generated-sources/
io.github.dgroup
arch4u-pmd
${version}
...
...
```
#### Gradle (build.gradle)
```groovy
apply plugin: 'pmd'
dependencies {
...
pmd "io.github.dgroup:arch4u-pmd:${version}" // use latest arch4u-pmd rules version
pmd "commons-io:commons-io:2.11.0" // required dependency by pmd engine
...
}
pmd {
consoleOutput = true
ruleSetFiles = files("io/github/dgroup/arch4u/pmd/arch4u-ruleset.xml")
ruleSets = [] // Keep it as is, workaround for pmd
}
```
#### Include arch4u-pmd rules into your existing custom ruleset
0. Don't forget to add rules to classpath in Maven/Gradle pmd plugin (see lines above)
1. Let's assume that you already have pmd rules defined in `your-pmd-ruleset.xml`
2. Add line `` to `your-pmd-ruleset.xml`
```xml
...
...
```
#### Exclude particular rule
```xml
...
...
```
#### Reconfigure a rule
```xml
...
3
...
```
#### Exclude particular folder from inspection
```xml
...
.*/target/generated-sources/.*
.*/build/generated-sources/.*
.*/src/test/java/org/tbd/tbd/tbd/.*
...
```
### How to contribute?
1. Pull requests are welcome! Don't forget to add your name to contribution section and run this,
beforehand:
```bash
mvn -Pqulice clean install
```
2. Everyone interacting in this project’s codebases, issue trackers, chat rooms is expected to
follow the [code of conduct](.github/code_of_conduct.md).
3. Latest maven coordinates [here](https://github.com/dgroup/arch4u-pmd/releases):
```xml
io.github.dgroup
arch4u-pmd
${version}
```
4. Download pmd rule designer
- https://pmd.github.io/latest/pmd_userdocs_extending_designer_reference.html
### Contributors
* [dgroup](https://github.com/dgroup) as Yurii Dubinka ()
* [dykov](https://github.com/dykov) as Oleksii Dykov ()
* [smithros](https://github.com/smithros) as Rostyslav Koval ()