Allow extensions to set colours in completion items outside of label/description

[DanTup]

There's a CompletionItemKind.Color but as far as I can tell from the source, it'll only work if the label or documentation matches a specific regex that's hard-coded:

vscode/src/vs/editor/contrib/suggest/suggestWidget.ts

Line 148 in 8a79656

let color = matchesColor(suggestion.label) || typeof suggestion.documentation === 'string' && matchesColor(suggestion.documentation);

It would be much better if an extension can supply this value in another field that doesn't require that it replaces the entire label or description with just the hex value.

[jrieken]

It would be much better if an extension can supply this value in another field that doesn't require that it replaces

Why? Do you have a sample? I aren't very keen on adding an API just for that but we wanna be pragmatic here.

[DanTup]

Well normally you can provide a description in code completion like this:

It seems weird to say that if you want to preview the colour in completion we have to stop showing the textual description.

[jrieken]

/cc @aeschli for input and as the original implementation.

Still in favour of something pragmatic, e.g find the color-string as substring

[vscodebot]

This issue is being closed to keep the number of issues in our inbox on a manageable level, we are closing issues that are not going to be addressed in the foreseeable future: We look at the number of votes the issue has received and the number of duplicate issues filed. More details here. If you disagree and feel that this issue is crucial: We are happy to listen and to reconsider.

If you wonder what we are up to, please see our roadmap and issue reporting guidelines.

Thanks for your understanding and happy coding!

[DanTup]

@jrieken if a new field won't be added, could this at least be a sub-string, so we could tag (#ff0000) or \n#ff000 on to the end? It'd a shame to have to remove the descriptions just to get colour previews.

[DanTup]

@jrieken @aeschli would you accept a PR for something here? I'd really like to include colors in my completion, but losing the ability to have any other documentation isn't a great trade-off. A substring would be fine for me.. it looks like the current code might support the value being right at the end, however I think it only works for raw strings and not any sort of markdown?

vscode/src/vs/editor/contrib/suggest/browser/suggestWidgetRenderer.ts

Line 49 in 391acf8

if (match && (match.index === 0 || match.index + match[0].length === item.completion.documentation.length)) {

[DanTup]

@jrieken @aeschli would you accept a PR for something here? It seems unfortunate to have this support, but not allow it to be used when there is documentation to show.