-
Notifications
You must be signed in to change notification settings - Fork 131
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement textDocument/semanticTokens (semantic highlighting)
- Loading branch information
1 parent
bb6ed57
commit 5db7291
Showing
11 changed files
with
824 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| package handlers | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/creachadair/jrpc2/code" | ||
| lsctx "github.com/hashicorp/terraform-ls/internal/context" | ||
| ilsp "github.com/hashicorp/terraform-ls/internal/lsp" | ||
| lsp "github.com/hashicorp/terraform-ls/internal/protocol" | ||
| ) | ||
|
|
||
| func (lh *logHandler) TextDocumentSemanticTokensFull(ctx context.Context, params lsp.SemanticTokensParams) (lsp.SemanticTokens, error) { | ||
| tks := lsp.SemanticTokens{} | ||
|
|
||
| cc, err := lsctx.ClientCapabilities(ctx) | ||
| if err != nil { | ||
| return tks, err | ||
| } | ||
|
|
||
| caps := ilsp.SemanticTokensClientCapabilities{ | ||
| SemanticTokensClientCapabilities: cc.TextDocument.SemanticTokens, | ||
| } | ||
| if !caps.FullRequest() { | ||
| // This would indicate a buggy client which sent a request | ||
| // it didn't claim to support, so we just strictly follow | ||
| // the protocol here and avoid serving buggy clients. | ||
| return tks, code.MethodNotFound.Err() | ||
| } | ||
|
|
||
| ds, err := lsctx.DocumentStorage(ctx) | ||
| if err != nil { | ||
| return tks, err | ||
| } | ||
|
|
||
| rmf, err := lsctx.RootModuleFinder(ctx) | ||
| if err != nil { | ||
| return tks, err | ||
| } | ||
|
|
||
| fh := ilsp.FileHandlerFromDocumentURI(params.TextDocument.URI) | ||
| doc, err := ds.GetDocument(fh) | ||
| if err != nil { | ||
| return tks, err | ||
| } | ||
|
|
||
| rm, err := rmf.RootModuleByPath(doc.Dir()) | ||
| if err != nil { | ||
| return tks, fmt.Errorf("finding compatible decoder failed: %w", err) | ||
| } | ||
|
|
||
| schema, err := rmf.SchemaForPath(doc.Dir()) | ||
| if err != nil { | ||
| return tks, err | ||
| } | ||
|
|
||
| d, err := rm.DecoderWithSchema(schema) | ||
| if err != nil { | ||
| return tks, err | ||
| } | ||
|
|
||
| tokens, err := d.SemanticTokensInFile(doc.Filename()) | ||
| if err != nil { | ||
| return tks, err | ||
| } | ||
|
|
||
| te := &ilsp.TokenEncoder{ | ||
| Lines: doc.Lines(), | ||
| Tokens: tokens, | ||
| ClientCaps: cc.TextDocument.SemanticTokens, | ||
| } | ||
| tks.Data = te.Encode() | ||
|
|
||
| return tks, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| package handlers | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "testing" | ||
|
|
||
| "github.com/hashicorp/go-version" | ||
| tfjson "github.com/hashicorp/terraform-json" | ||
| "github.com/hashicorp/terraform-ls/internal/langserver" | ||
| "github.com/hashicorp/terraform-ls/internal/terraform/exec" | ||
| "github.com/hashicorp/terraform-ls/internal/terraform/rootmodule" | ||
| "github.com/stretchr/testify/mock" | ||
| ) | ||
|
|
||
| func TestSemanticTokensFull(t *testing.T) { | ||
| tmpDir := TempDir(t) | ||
| InitPluginCache(t, tmpDir.Dir()) | ||
|
|
||
| var testSchema tfjson.ProviderSchemas | ||
| err := json.Unmarshal([]byte(testSchemaOutput), &testSchema) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| ls := langserver.NewLangServerMock(t, NewMockSession(&MockSessionInput{ | ||
| RootModules: map[string]*rootmodule.RootModuleMock{ | ||
| tmpDir.Dir(): { | ||
| TfExecFactory: exec.NewMockExecutor([]*mock.Call{ | ||
| { | ||
| Method: "Version", | ||
| Repeatability: 1, | ||
| Arguments: []interface{}{ | ||
| mock.AnythingOfType(""), | ||
| }, | ||
| ReturnArguments: []interface{}{ | ||
| version.Must(version.NewVersion("0.12.0")), | ||
| nil, | ||
| nil, | ||
| }, | ||
| }, | ||
| { | ||
| Method: "GetExecPath", | ||
| Repeatability: 1, | ||
| ReturnArguments: []interface{}{ | ||
| "", | ||
| }, | ||
| }, | ||
| { | ||
| Method: "ProviderSchemas", | ||
| Repeatability: 1, | ||
| Arguments: []interface{}{ | ||
| mock.AnythingOfType(""), | ||
| }, | ||
| ReturnArguments: []interface{}{ | ||
| &testSchema, | ||
| nil, | ||
| }, | ||
| }, | ||
| }), | ||
| }, | ||
| }})) | ||
| stop := ls.Start(t) | ||
| defer stop() | ||
|
|
||
| ls.Call(t, &langserver.CallRequest{ | ||
| Method: "initialize", | ||
| ReqParams: fmt.Sprintf(`{ | ||
| "capabilities": { | ||
| "textDocument": { | ||
| "semanticTokens": { | ||
| "tokenTypes": [ | ||
| "type", | ||
| "property", | ||
| "string" | ||
| ], | ||
| "tokenModifiers": [ | ||
| "deprecated", | ||
| "modification" | ||
| ], | ||
| "requests": { | ||
| "full": true | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "rootUri": %q, | ||
| "processId": 12345 | ||
| }`, TempDir(t).URI())}) | ||
| ls.Notify(t, &langserver.CallRequest{ | ||
| Method: "initialized", | ||
| ReqParams: "{}", | ||
| }) | ||
| ls.Call(t, &langserver.CallRequest{ | ||
| Method: "textDocument/didOpen", | ||
| ReqParams: fmt.Sprintf(`{ | ||
| "textDocument": { | ||
| "version": 0, | ||
| "languageId": "terraform", | ||
| "text": "provider \"test\" {\n\n}\n", | ||
| "uri": "%s/main.tf" | ||
| } | ||
| }`, TempDir(t).URI())}) | ||
|
|
||
| ls.CallAndExpectResponse(t, &langserver.CallRequest{ | ||
| Method: "textDocument/semanticTokens/full", | ||
| ReqParams: fmt.Sprintf(`{ | ||
| "textDocument": { | ||
| "uri": "%s/main.tf" | ||
| } | ||
| }`, TempDir(t).URI())}, `{ | ||
| "jsonrpc": "2.0", | ||
| "id": 3, | ||
| "result": { | ||
| "data": [ | ||
| 0,0,8,0,0, | ||
| 0,9,6,1,2 | ||
| ] | ||
| } | ||
| }`) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| package lsp | ||
|
|
||
| import ( | ||
| lsp "github.com/hashicorp/terraform-ls/internal/protocol" | ||
| ) | ||
|
|
||
| type semanticTokensFull struct { | ||
| Delta bool `json:"delta,omitempty"` | ||
| } | ||
|
|
||
| type SemanticTokensClientCapabilities struct { | ||
| lsp.SemanticTokensClientCapabilities | ||
| } | ||
|
|
||
| func (c SemanticTokensClientCapabilities) FullRequest() bool { | ||
| switch full := c.Requests.Full.(type) { | ||
| case bool: | ||
| return full | ||
| case semanticTokensFull: | ||
| return true | ||
| } | ||
| return false | ||
| } |
Oops, something went wrong.