suggest: symToSuggest limit data per IdeCmd

[bung87]

Summary

suggest.symToSuggest now restrict data fetched based on the IdeCmd
given. Meaning some Suggest fields are only filled in/used given
specific IdeCmd(s), avoiding unnecessary processing.

Details

• Fill contextFits,globalUsages,localUsages fields when IdeCmd in
  {ideSug, ideCon}. they're used in cmpSuggestions -> produceOutput.
• Fill doc field when IdeCmd is not ideHighlight. ideHighlight
  results don't render the documentation comment, see $(Suggest)

[zerbina]

I think this change is okay, less processing is certainly nice, but I dislike that the data type (Suggest) doesn't reflect that not all fields are valid for each section value.

Eventually, Suggest should either be turned into a variant object or replaced with something completely different, but for now, could you document on the fields for which section the fields apply?

---

Regarding the PR message and title:

• please try to keep the PR titles short. They're used as the commit title, and should not be much longer than 50 characters
• the lines in the body must be no longer than 72 characters
• please document where you got the information of what the sets should be from. Skimming over the symToSuggest usage sites, ideChk seems to never be passed to it

[bung87]

updated.

[zerbina]

Thank you for updating the PR body with the context regarding the sets.

The set for the doc field including ideChk is still a bit confusing, given that symToSuggest is never invoked with ideChk. However, since the whole suggestion reporting is going to be reworked anyway, I think that's fine for now.

[bung87]

confirmed, ideChk doesn't goes to symToSuggest, structuredReportHook take the responsibility that accept Report, now leave it as is, as symToSuggest accept all commands and Suggest is not object variant, so take care all kinds of command is fine. I haven't trigger diagnostics so far, I'll revisit the code handle ideChk.

[zerbina]

Apart from the style change and the PR title, this PR is good to go.

[zerbina]

Sorry for not having noticed this earlier.

While rewording the PR message and looking for a more general reason for the doc field change, I noticed that the ideMod section is not included in the set, which is a breaking change (see the $ operator for Suggest).

I know that the custom protocol is going to be removed, but until it is, nimsuggest has to continue working.

[saem]

@zerbina FYI, I just reworded the PR message, nothing major but hopefully I didn't overwrite your changes. 🤞🏽

[zerbina]

/merge

I've updated the PR message according to the recent changes.

[github-actions]

Merge requested by: @zerbina

Contents after the first section break of the PR description has been removed and preserved below:

---

Notes for Reviewers

part of #879