#2192-support-for-auto-completion-synonyms

[samuelkos17]

This PR fixes #2192

Implemented changes:

• Changed the class AutoCompletionRegistry:
  • Changed internal storage from List<String> to List<CompletionEntry> so candidates can be grouped with their synonyms.
  • The add methods now create CompletionEntry-Objects and add them to the entries list
  • The complete() method now delegates to each CompletionEntry.complete(), passing the alreadyProvided set for synonym filtering.
• Created the class CompletionEntry:
  • Groups a primary candidate with one or more synonyms.
  • complete() skips the entire entry if the candidate or any of its synonyms has already been typed on the command line; otherwise performs normal prefix matching on both the candidate and its synonyms.
• Changed the interface CompletionCandidateCollector:
  • Added setAlreadyProvided(Set) and getAlreadyProvided() to propagate arguments already typed during the
    current completion cycle.
• Changed the class CompletionCandidateCollectorDefault:
  • Added an alreadyProvided field with getter/setter to store and retrieve the already-provided set.
• Changed the class CompletionCandidateCollectorAdapter:
  • Implemented the new setAlreadyProvided/getAlreadyProvided methods, delegating to the wrapped collector.
• Changed the class AbstractIdeContext:
  • completeCommandlet() now scans all CLI arguments (excluding the completion token) into an alreadyProvided set and
    sets it on the collector before matching properties.
• Changed the class ToolCommandlet:
  • completeToolArguments() now passes collector.getAlreadyProvided() to the registry's complete() call.
• Changed the class CompleteTest:
  • Added testSynonymFilteringWithProvidedCanonicalCandidate() and testSynonymFilteringWithProvidedSynonym() to verify that --batch is not suggested when -b has already been provided and vice verca.

---

Testing instructions

1. Pull the feature branch to your local workspace.
2. Follow the instructions in run-ideasy-locally.adoc and run with the following cli-arguments:
   1. complete -b "" -- the output should neither contain -b nor --batch
   2. complete --batch "" -- the output should neither contain -b nor --batch
   3. complete "" -- the output should contain both -b and --batch
3. Run mvn clean test and make sure that all tests pass.

---

Checklist for this PR

Make sure everything is checked before merging this PR. For further info please also see
our DoD.

• When running mvn clean test locally all tests pass and build is successful
• PR title is of the form #«issue-id»: «brief summary» (e.g. #921: fixed setup.bat). If no issue ID exists, title only.
• PR top-level comment summarizes what has been done and contains link to addressed issue(s)
• PR and issue(s) have suitable labels
• Issue is set to In Progress and assigned to you or there is no issue (might happen for very small PRs)
• You followed all coding conventions
• You have added the issue implemented by your PR in CHANGELOG.adoc unless issue is labeled
  with internal
• You have formulated clear instructions on how to test your contribution under "Testing instructions"

[coveralls]

Coverage Report for CI Build 30532321896

Coverage decreased (-0.001%) to 72.592%

Details

• Coverage decreased (-0.001%) from the base build.
• Patch coverage: No coverable lines changed in this PR.
• 150 coverage regressions across 8 files.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

150 previously-covered lines in 8 files lost coverage.

File	Lines Losing Coverage	Coverage
com/devonfw/tools/ide/context/AbstractIdeContext.java	103	70.6%
com/devonfw/tools/ide/tool/ToolCommandlet.java	27	74.08%
com/devonfw/tools/ide/commandlet/CompleteCommandlet.java	9	26.09%
com/devonfw/tools/ide/completion/CompletionCandidateCollectorAdapter.java	6	0.0%
com/devonfw/tools/ide/completion/CompletionCandidateCollectorDefault.java	2	89.66%
com/devonfw/tools/ide/completion/IdeCompleter.java	1	87.88%
com/devonfw/tools/ide/tool/ide/IdeToolCommandlet.java	1	78.33%
com/devonfw/tools/ide/version/VersionSegment.java	1	90.03%

---

Coverage Stats

Relevant Lines:	17025
Covered Lines:	12888
Line Coverage:	75.7%
Relevant Branches:	7617
Covered Branches:	5000
Branch Coverage:	65.64%
Branches in Coverage %:	Yes
Coverage Strength:	3.21 hits per line

---

💛 - Coveralls

[Caylipp]

Good job!

mvn clean test runs successfully for the cli.

I also verified the behavior manually using the local dev build:

• ide complete "" still suggests both -b and --batch
• ide complete -b "" suggests neither -b nor --batch
• ide complete --batch "" suggests neither -b nor --batch

The implementation also follows the design proposed in the issue. The code looks good to me.

[hohwille]

@samuelkos17 thanks for your PR and solving this auto-completion feature. Great job 👍

I left some comments for improvement. Please have a look.
When addressed, we can merge this.

[samuelkos17]

@samuelkos17 thanks for your PR and solving this auto-completion feature. Great job 👍

I left some comments for improvement. Please have a look. When addressed, we can merge this.

I totally agree that's a much more elegant implementation so I've implemented it.

[hohwille]

@samuelkos17 thanks for your rework. 👍
In the DoD the CHANGELOG is not checked since it is still missing. Can you add this?
BTW: Instead of changing all JUnits it is better to add a convenience method/constructor avoiding all such changes (e.g. adding the new HashSet<>() everywhere). Please bear in mind that changes like this can also easily cause merge conflicts for you or others when you change such "API". If you keep a convenience method/constructor this can be avoided and the number of files that need to be touched get reduced.
See https://github.com/devonfw/IDEasy/blob/main/documentation/contributing/coding-conventions.adoc#refactorings

[samuelkos17]

@hohwille I've updated the CHANGELOG.adoc. Thanks for the hint on updating the JUnit-tests, I will make sure to change them that way the next time. Do you want me to change them for this PR?