[
https://issues.apache.org/jira/browse/MNG-7902?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17847151#comment-17847151
]
ASF GitHub Bot commented on MNG-7902:
-------------------------------------
yuehcw opened a new pull request, #1510:
URL: https://github.com/apache/maven/pull/1510
**Summary**
This pull request addresses the JIRA issue
[MNG-7902](https://issues.apache.org/jira/browse/MNG-7902). The goal of this
change is to enhance the readability and usability of the validation report by
sorting the plugins in a case-insensitive manner. Currently, the report outputs
the content of a set of plugins without sorting them, which can result in a
random order, making it difficult for users to locate specific entries or
identify patterns.
**Changes Made**
Added sorting logic: Implemented a sorting mechanism to order plugins
case-insensitively in the validation report.
Updated `reportSessionCollectedValidationIssues` function: Modified this
function to include the sorting logic for plugins before they are logged.
**Why This Change Is Necessary**
By sorting the plugins in the validation report, developers can easily scan
through the list to find specific entries or identify changes. This enhancement
improves the readability and usability of the report, especially in scenarios
where users need to review or troubleshoot plugin configurations.
**How the Change Was Implemented**
The sorting logic was added to the `reportSessionCollectedValidationIssues`
function in the `DefaultPluginValidationManager` class. The plugins are sorted
using `Map.Entry.comparingByKey(String.CASE_INSENSITIVE_ORDER)` before they are
logged.
Following this checklist to help us incorporate your
contribution quickly and easily:
- [x] Make sure there is a [JIRA
issue](https://issues.apache.org/jira/browse/MNG) filed
for the change (usually before you start working on it). Trivial
changes like typos do not
require a JIRA issue. Your pull request should address just this
issue, without
pulling in other changes.
- [x] Each commit in the pull request should have a meaningful subject line
and body.
- [x] Format the pull request title like `[MNG-XXX] SUMMARY`,
where you replace `MNG-XXX` and `SUMMARY` with the appropriate JIRA
issue.
- [x] Also format the first line of the commit message like `[MNG-XXX]
SUMMARY`.
Best practice is to use the JIRA issue title in both the pull request
title and in the first line of the commit message.
- [x] Write a pull request description that is detailed enough to
understand what the pull request does, how, and why.
- [x] Run `mvn clean verify` to make sure basic checks pass. A more
thorough check will
be performed on your pull request automatically.
- [x] You have run the [Core IT][core-its] successfully.
If your pull request is about ~20 lines of code you don't need to sign an
[Individual Contributor License
Agreement](https://www.apache.org/licenses/icla.pdf) if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the [Apache License Version 2.0, January
2004](http://www.apache.org/licenses/LICENSE-2.0)
you have to acknowledge this by using the following check-box.
- [x] I hereby declare this contribution to be licenced under the [Apache
License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
- [x] In any other case, please file an [Apache Individual Contributor
License Agreement](https://www.apache.org/licenses/icla.pdf).
[core-its]: https://maven.apache.org/core-its/core-it-suite/
> sort plugins in validation report
> ---------------------------------
>
> Key: MNG-7902
> URL: https://issues.apache.org/jira/browse/MNG-7902
> Project: Maven
> Issue Type: Improvement
> Components: Core
> Reporter: Michael Keppler
> Priority: Minor
> Attachments: image-2023-10-07-13-33-27-762.png
>
>
> Please don't ever output the content of a Set for consumption by humans
> without sorting it first. The order is otherwise "random". Sorting (case
> insensitive) makes the same output easier to read, especially when trying to
> find one specific entry (e.g. "Did we fix plugin foo already?")
> !image-2023-10-07-13-33-27-762.png!
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
