notebook cell doesn't get document highlight request

[heejaechang]

repro steps

1. install latest python extension
2. create notebook
3. put this python code in the python cell

a = 1
print(a)

4. place cursor at a

see whether onDocumentHighlight is called.

Expected: it gets called like other APIs such as onHover
Actual: it never gets called.

if I do same for regular python file such as test.py with the same content, the API gets called as expected.

[heejaechang]

this might be a bug in vscode - microsoft/vscode#202293

[heejaechang]

another issue found was in Server Capability that is returned from initialize,

it has documentHighlightProvider?: boolean | DocumentHighlightOptions; instead of documentHighlightProvider?: boolean | DocumentHighlightOptions | **DocumentHighlightRegistrationOptions**; unlike typeHierarchyProvider?: boolean | TypeHierarchyOptions | TypeHierarchyRegistrationOptions

also, I am not sure why
documentFormattingProvider has this signature export class DocumentFormattingFeature extends TextDocumentLanguageFeature<boolean | DocumentFormattingOptions, **DocumentHighlightRegistrationOptions** instead of DocumentFormattingRegistrationOptions

[dbaeumer]

it has documentHighlightProvider?: boolean | DocumentHighlightOptions; instead of documentHighlightProvider?: boolean | DocumentHighlightOptions | DocumentHighlightRegistrationOptions; unlike typeHierarchyProvider?: boolean | TypeHierarchyOptions | TypeHierarchyRegistrationOptions

Reason is Backwards compatibility. We had document highlight before a server could provide a selector on initialize. If we want to support this we need to make this a client capability since forcing clients to support this would be a breaking chance.

also, I am not sure why
documentFormattingProvider has this signature export class DocumentFormattingFeature extends TextDocumentLanguageFeature<boolean | DocumentFormattingOptions, DocumentHighlightRegistrationOptions instead of DocumentFormattingRegistrationOptions

Very likely a copy / paste mistake. Fixed it.

[dbaeumer]

Closing the issue since the problem mentioned in the description is tracked in microsoft/vscode#202293