Exempt picocli.CommandLine.Option#names annotation attribute from reordering

[rickie]

As part of checkstyle/checkstyle#14137 I'm enabling the LexicographicalAnnotationAttributeListing check. I encountered a problem related to this: https://github.com/PicnicSupermarket/error-prone-support/blob/master/integration-tests/checkstyle-init.patch#L78.

Therefore I'm filing this PR.

[github-actions]

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

[Stephan202]

Tnx @rickie! I do seem to recall that this parameter cares about the order in which names are listed, but I forgot the details, and the documentation seems silent about this. What goes wrong without this change?

(Sorry for asking rather than checking myself; rather short on time atm 😬.)

[rickie]

As discussed offline; for some CLI's, like the one in Checkstyle, it's just that a specific order is required. The options are expected or sorted in a specific order and therefore we shouldn't want to change this.

[Stephan202]

More explicitly: the order in which flags are listed influences the order in which they are rendered in the generated help text. That is, there's a clear functional impact to the order.

[github-actions]

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[mohamedsamehsalah]

Clean 🥇

[rickie]

Suggested commit message:

Exempt `picocli.CommandLine.Option#names` annotation attribute from reordering (#1056)

[rickie]

@Stephan202 we could go for this as alternative:

Exempt `@picocli.CommandLine.Option#names` attribute from reordering (#1056)

As it will be under 80 chars, WDYT?

[Stephan202]

The @ may not be obvious. Perhaps just:

Exempt `picocli.CommandLine.Option#names` arguments from reordering (#1056)