Migrate reporter to new plugin API #9182
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Make the `defaultValue` property of the `OrtPluginOption` annotation optional. As annotation properties cannot be nullable, define a constant to mark if the default value should be ignored. This is a preparation for adding more properties to the annotation. Signed-off-by: Martin Nonnenmacher <[email protected]>
Add the property `OrtPluginOption.aliases` to define optional aliases for configuration options. This can be used to rename options in a backward-compatible way. Signed-off-by: Martin Nonnenmacher <[email protected]>
Signed-off-by: Martin Nonnenmacher <[email protected]>
Convert `AsciiDocTemplateReporter` to an abstract class. This allows to simplify the constructor by making `backend` an abstract property. Signed-off-by: Martin Nonnenmacher <[email protected]>
mnonnenmacher
force-pushed
the
reporter-refactorings
branch
from
e3f5443
to
c658c37
Compare
Migrate the reporters to the new plugin API. With the reporter API reporter implementations get their configuration options via the `generateReport` function. With the new plugin API the configuration options are provided as a constructor parameter. With this change both ways are supported to allow for a step-by-step migration in the following commits. Signed-off-by: Martin Nonnenmacher <[email protected]>
Add a config class for the reporter and use it instead of the options passed to the `generateReport` function. Signed-off-by: Martin Nonnenmacher <[email protected]>
Add a config class for the reporter and use it instead of the options passed to the `generateReport` function. Signed-off-by: Martin Nonnenmacher <[email protected]>
mnonnenmacher
force-pushed
the
reporter-refactorings
branch
from
c658c37
to
aa85547
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9182 +/- ##
=========================================
Coverage 67.10% 67.10%
Complexity 1187 1187
=========================================
Files 240 240
Lines 7908 7908
Branches 914 914
=========================================
Hits 5307 5307
Misses 2233 2233
Partials 368 368
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is still work in progress, created the PR to check for unexpected test failures.