Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: return lexer errors only if they affect the current cursor position #445

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions decoder/candidates.go
Original file line number Diff line number Diff line change
Expand Up @@ -201,8 +201,11 @@ func (d *PathDecoder) nameTokenRangeAtPos(filename string, pos hcl.Pos) (hcl.Ran
return rng, err
}
tokens, diags := hclsyntax.LexConfig(f.Bytes, filename, hcl.InitialPos)
if diags.HasErrors() {
return rng, diags

for _, diag := range diags {
if diag.Severity == hcl.DiagError && diag.Subject != nil && diag.Subject.ContainsPos(pos) {
return rng, diags
}
}

return nameTokenRangeAtPos(tokens, pos)
Expand Down
85 changes: 85 additions & 0 deletions decoder/candidates_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1719,6 +1719,91 @@ resource "any" "ref" {
}
}

func TestDecoder_CompletionAtPos_withLexerErrors(t *testing.T) {
ctx := context.Background()

bSchema := &schema.BlockSchema{
Body: &schema.BodySchema{
Blocks: map[string]*schema.BlockSchema{
"child": {
Body: &schema.BodySchema{
Attributes: map[string]*schema.AttributeSchema{
"src": {
IsRequired: true,
Constraint: schema.LiteralType{Type: cty.String},
},
},
Blocks: map[string]*schema.BlockSchema{
"repo": {
Body: &schema.BodySchema{
Attributes: map[string]*schema.AttributeSchema{
"name": {
IsRequired: true,
Constraint: schema.LiteralType{Type: cty.String},
},
},
},
},
},
},
},
},
},
}

bodySchema := &schema.BodySchema{
Blocks: map[string]*schema.BlockSchema{
"res": bSchema,
},
}

src := `res {
child {
s
repo {
name = "unclosed string
}
}
}`

f, _ := hclsyntax.ParseConfig([]byte(src), "test.tf", hcl.InitialPos)

d := testPathDecoder(t, &PathContext{
Schema: bodySchema,
Files: map[string]*hcl.File{
"test.tf": f,
},
})

pos := hcl.Pos{Line: 3, Column: 9, Byte: 27}
candidates, err := d.CompletionAtPos(ctx, "test.tf", pos)
if err != nil {
t.Fatal(err)
}

expectedCandidates := lang.CompleteCandidates([]lang.Candidate{
{
Label: "src",
Detail: "required, string",
Kind: lang.AttributeCandidateKind,
TextEdit: lang.TextEdit{
Range: hcl.Range{
Filename: "test.tf",
Start: hcl.Pos{Line: 3, Column: 9, Byte: 26},
End: hcl.Pos{Line: 3, Column: 10, Byte: 27},
},
NewText: "src",
Snippet: `src = "${1:value}"`,
},
},
})

diff := cmp.Diff(expectedCandidates, candidates, ctydebug.CmpOptions)
if diff != "" {
t.Fatalf("unexpected candidates: %s", diff)
}
}

var testConfig = []byte(`resource "azurerm_subnet" "example" {
count = 3
}
Expand Down