apache / apache/maven-reporting-impl
[MSHARED-1364] AbstractMavenReportRenderer should not depend on Doxia impl classes
- Dominant language
- Java
- Stars
- 7
- Forks
- 12
- Avg merge
- 9m
- Merged PRs (30d)
- 2
Description
**[Konrad Windszus](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=kwin)** opened **[MSHARED-1364](https://issues.apache.org/jira/browse/MSHARED-1364?redirect=false)** and commented
The classes in package `o.a.m.doxia.sink.impl` should by definition not be considered stable API (and therefore only consumed from Doxia classes internally).
However `https://github.com/apache/maven-reporting-impl/blob/72181306bb0e12eed50c4ba4aec98dd76499df39/src/main/java/org/apache/maven/reporting/AbstractMavenReportRenderer.java#L47` depends on some internal constants.
This is dangerous, as those constants were removed in the context of DOXIA-685. Although constants are inlined during compile time, the evaluation of those constants vanished as well, so using them has no longer any effect. Reporting Impl should only rely on stable Doxia API to achieve a better decoupling.
---
**Affects:** maven-reporting-impl-4.0.0-M13
Contributor guide
No contributing guide indexed for this repository
Research direction
Inspect AbstractMavenReportRenderer.java around line 47 and review the Doxia implementation constants it currently uses. Read the stable Doxia API and the DOXIA-685 context first; done means Reporting Impl no longer depends on o.a.m.doxia.sink.impl classes and the project build passes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- build-system
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100