Document Highlight spec unclear and possibly wrong

[smarr]

As discussed and noted in issue #18, there might be something wrong with the document highlight spec (see #18 (comment) and below).

Furthermore, the wording of the spec does not tell me what this feature is for (apparently something like 'mark occurrences'), so, it's unclear to me at the moment.

The distinction between read/write/text is unclear to me, too. What is it useful for exactly? (Would be good to know so that I know how to map it to my language.)

And, the vscode apparently also expects a collection of elements as return value, as noted by @cdietrich:

export interface DocumentHighlightProvider {
  provideDocumentHighlights(model: editor.IReadOnlyModel, position: Position, token: CancellationToken): DocumentHighlight[] | Thenable<DocumentHighlight[]>;
}

[dbaeumer]

@smarr to which code base are you referring to with

export interface DocumentHighlightProvider {
  provideDocumentHighlights(model: editor.IReadOnlyModel, position: Position, token: CancellationToken): DocumentHighlight[] | Thenable<DocumentHighlight[]>;
}

Is this from the Monaco editor?

[cdietrich]

no it is from vscode
https://github.com/Microsoft/vscode/blob/5b9ec15ce526decc5dd0488339e798f6bcb4ec46/extensions/typescript/src/features/documentHighlightProvider.ts

[cdietrich]

if i try to implement the document highlight in the node example it wants me to do something like+

connection.onDocumentHighlight((p : TextDocumentPositionParams): DocumentHighlight[] => {
    console.log("highlihht");
    return[
        {
            kind: 1,
            range: {
                start : {
                    line : 1, character : 1
                },
                end : {
                    line : 1, character : 3
                }
            } 
        },
        {
            kind: 1,
            range: {
                start : {
                    line : 1, character : 4
                },
                end : {
                    line : 1, character : 7
                }
            } 
        }
    ]
});

[cdietrich]

and it is in monaco.d.ts as well

[cdietrich]

https://github.com/Microsoft/vscode-languageserver-node/blob/a9f36d43a789e6fd9c16e5e50fc818eb35d097db/client/src/protocol.ts#L670

[cdietrich]

any news on this?

[egamma]

@cdietrich sorry vacation time here, delays are to be expected...

[cdietrich]

@dbaeumer @egamma let me know if you need additional info

[dbaeumer]

I updated the protocol definition like this:

[cdietrich]

@dbaeumer at other places you use Type[] as list notation

[dbaeumer]

Good catch. Fixed it.